GET {clientId}/status/Token/{accessToken}
Returns the status of your request. If a callback URL is provided with your request, MyPreferences will POST the status to the callback URL.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
PossibleNow ClientId |
string |
Required |
| accessToken |
AccessToken to check the status of |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
AsyncTokenStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| AccessToken |
AccessToken status is returned for |
integer |
None. |
| Expires |
Date/Time the token expires or empty string if job is still processing |
string |
None. |
| Status |
Status of the job. e.g. Complete, Processing, Error |
string |
None. |
| RowCount |
Record count if job completed successfully otherwise 0 |
integer |
None. |
| ByteCount |
Total byte count if job completed successfully otherwise 0 |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"AccessToken": 1,
"Expires": "sample string 2",
"Status": "sample string 3",
"RowCount": 1,
"ByteCount": 1
}
application/xml, text/xml
Sample:
<AsyncTokenStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.Async.Models"> <AccessToken>1</AccessToken> <ByteCount>1</ByteCount> <Expires>sample string 2</Expires> <RowCount>1</RowCount> <Status>sample string 3</Status> </AsyncTokenStatus>