| All Verbs | /userinfo |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | query | string | No | |
| SecretId | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserName | form | string | No | |
| form | string | No | ||
| Created | form | DateTime | No | |
| Signature | form | string | No | |
| AvatarUrl | form | string | No | |
| UserActivity | form | UserActivity | No | |
| UserPartners | form | List<UserPartners> | No | |
| PartnerId | form | int | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| UserName | form | string | No | |
| Created | form | DateTime | No | |
| Modified | form | DateTime | 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 /userinfo HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
userName: String,
secretId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: 0,
userName: String,
email: String,
created: 0001-01-01,
signature: String,
avatarUrl: String,
userActivity:
{
id: 0,
userName: String,
created: 0001-01-01,
modified: 0001-01-01
},
userPartners:
[
{
id: 0,
userId: 0,
email: String,
partnerId: 0,
isSelected: False,
partnerName: String
}
],
partnerId: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}