FxHubPartnersApi

<back to all web services

SessionInfo

Requires Authentication
The following routes are available for this service:
All Verbs/my-session
SessionInfoResponse Parameters:
NameParameterData TypeRequiredDescription
MetaformDictionary<string, string>No
CreatedformDateTimeNo
PartnerIdformintNo
PartnerIdsformList<int>No
PartnerNameformstringNo
IdformstringNo
ReferrerUrlformstringNo
UserAuthIdformstringNo
UserAuthNameformstringNo
UserNameformstringNo
DisplayNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
PhoneNumberformstringNo
CreatedAtformDateTimeNo
LastModifiedformDateTimeNo
RolesformList<string>No
PermissionsformList<string>No
IsAuthenticatedformboolNo
AuthProviderformstringNo
ProfileUrlformstringNo
GithubProfileUrlformstringNo
TwitterProfileUrlformstringNo
AccessTokenformstringNo
AvatarUrlformstringNo
SignatureformstringNo
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.fxhub.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"meta":{"String":"String"},"created":"0001-01-01","partnerId":0,"partnerIds":[0],"partnerName":"String","id":"String","referrerUrl":"String","userAuthId":"String","userAuthName":"String","userName":"String","displayName":"String","firstName":"String","lastName":"String","email":"String","phoneNumber":"String","createdAt":"0001-01-01","lastModified":"0001-01-01","roles":["String"],"permissions":["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"}}}