| All Verbs | /my-session |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Meta | form | Dictionary<string, string> | No | |
| Created | form | DateTime | No | |
| PartnerId | form | int | No | |
| Id | form | string | No | |
| ReferrerUrl | form | string | No | |
| UserAuthId | form | string | No | |
| UserAuthName | form | string | No | |
| UserName | form | string | No | |
| DisplayName | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| CreatedAt | form | DateTime | No | |
| LastModified | form | DateTime | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| UserPartners | form | List<UserPartners> | No | |
| IsAuthenticated | form | bool | No | |
| AuthProvider | form | string | No | |
| ProfileUrl | form | string | No | |
| GithubProfileUrl | form | string | No | |
| TwitterProfileUrl | form | string | No | |
| AccessToken | form | string | No | |
| AvatarUrl | form | string | No | |
| Signature | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserId | form | int | No | |
| form | string | No | ||
| PartnerId | form | int | No | |
| IsSelected | form | bool | No | |
| PartnerName | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /my-session HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
meta:
{
String: String
},
created: 0001-01-01,
partnerId: 0,
id: String,
referrerUrl: String,
userAuthId: String,
userAuthName: String,
userName: String,
displayName: String,
firstName: String,
lastName: String,
email: String,
createdAt: 0001-01-01,
lastModified: 0001-01-01,
roles:
[
String
],
permissions:
[
String
],
userPartners:
[
{
id: 0,
userId: 0,
email: String,
partnerId: 0,
isSelected: False,
partnerName: String
}
],
isAuthenticated: False,
authProvider: String,
profileUrl: String,
githubProfileUrl: String,
twitterProfileUrl: String,
accessToken: String,
avatarUrl: String,
signature: String,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}