GET v1/authtoken/about
Returns details of the currently authenticated credentials. This can be used to verify that the correct credentials are being used
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
PBPRReturnOfAboutMeName | Description | Type | Additional information |
---|---|---|---|
Data | AboutMe |
None. |
|
Success |
Gets the success status of the API call |
boolean |
None. |
Meta |
Gets the optional meta-data |
Dictionary of string [key] and string [value] |
None. |
Code |
Get the http code of the API call e.g. 200, 202, 409 |
integer |
None. |
ErrorCode |
Get the failure error code of the API call. This is available if Success is false |
integer |
None. |
ErrorSubCode |
Gets the error sub code if available |
integer |
None. |
ErrorDescription |
Gets a textual description of the error |
string |
None. |
StatusUrl |
Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided |
string |
None. |
ContinuationToken |
Gets the token to be used for paged queries |
string |
None. |
Response Formats
application/json, text/json
{ "Success": true, "Meta": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Code": 2, "ErrorCode": 3, "Data": { "IntegrationName": "sample string 1", "IntegrationDescription": "sample string 2", "IntegrationFriendlyName": "sample string 3", "IntegrationStream": "sample string 4", "IntegrationStreamDescription": "sample string 5", "Platform": "sample string 6", "Permissions": [ 1, 2 ], "ForeignAccountKey": "sample string 7" }, "ErrorSubCode": 4, "ErrorDescription": "sample string 5", "StatusUrl": "sample string 6", "ContinuationToken": "sample string 7" }
application/xml, text/xml
<PBPRReturnOfAboutMe4wDnBXam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API"> <Code>2</Code> <ContinuationToken>sample string 7</ContinuationToken> <ErrorCode>3</ErrorCode> <ErrorDescription>sample string 5</ErrorDescription> <ErrorSubCode>4</ErrorSubCode> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <StatusUrl>sample string 6</StatusUrl> <Success>true</Success> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ASApi.Controllers.v1"> <d2p1:ForeignAccountKey>sample string 7</d2p1:ForeignAccountKey> <d2p1:IntegrationDescription>sample string 2</d2p1:IntegrationDescription> <d2p1:IntegrationFriendlyName>sample string 3</d2p1:IntegrationFriendlyName> <d2p1:IntegrationName>sample string 1</d2p1:IntegrationName> <d2p1:IntegrationStream>sample string 4</d2p1:IntegrationStream> <d2p1:IntegrationStreamDescription>sample string 5</d2p1:IntegrationStreamDescription> <d2p1:Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:Permissions> <d2p1:Platform>sample string 6</d2p1:Platform> </Data> </PBPRReturnOfAboutMe4wDnBXam>