FxHubPartnersApi

<back to all web services

GetUserInfo

Requires Authentication
The following routes are available for this service:
All Verbs/userinfo
GetUserInfo Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringNo
SecretIdquerystringNo
GetUserInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
CreatedformDateTimeNo
SignatureformstringNo
AvatarUrlformstringNo
PartnerIdformintNo
PartnerNameformstringNo
PartnerIdsformList<int>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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.fxlink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userName":"String","secretId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":0,"userName":"String","created":"0001-01-01","signature":"String","avatarUrl":"String","partnerId":0,"partnerName":"String","partnerIds":[0],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}