2.3. Revoke a Session Token to make it invalid.
GET RevokeSessionToken
Description: Revoke (delete) an existing session token. Normally usesd at the end of an API session.
API Usage: This endpoint uses zero API calls. Please refer to section 8.2 for more details on API rate limits.
GET Sample Request:
GET https://[server]/RevokeSessionToken?SessionToken=YOUR_SESSION_TOKEN
Request Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | SessionToken | String | A session token returned from the GetSessionToken endpoint. |
Response Parameters
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | ServerDateTime | String | Yes | The server UTC date and time as an ISO 8601 string. |
| 2 | TimeStamp | Float | Yes | The server and date/time as a Julian date. |
| 3 | ExecutionTime | Float | Yes | The number of milliseconds to process the request. |
| 4 | Result | [Object] | No* | If
the request is a
success,
a Result
object is returned. See the ‘Result Object‘ table below for details. |
| 5 | Errors | [Object] | No* | If
the request fails, an
'Errors' object is
returned. See the ‘Errors Object‘ table below for details. |
A successful API response will return a 'Result' object with the requested payload or an 'Errors' object detailing the issue that caused the error.
Tips:
- A session token will also automatically renew to full life when used successfully in any API endpoint.
- Check the remaining life in a session token with the QuerySessionToken endpoint.
Result Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | A HTTP status code (200 for success). |
| 2 | Detail | String | A description of the status code. |
Errors Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. |
| 2 | Detail | String | Description of the status code error. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 400 | Missing Session Token parameter. |
| 401 | Invalid/Unknown session token. |
| 405 | Method [request] not allowed. |
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes and descriptions may be returned. The Errors object Detail field will return request specific error information.
Possible HTTP response codes
This endpoint returns 200 for
success.
You can get HTTP client network errors or server
errors from any API request. You should
check with your network or IT colleagues in case the
issue is a local one.
All server generated errors will return an
'Errors' object that will give specific
details about the error.
A full list of HTTP codes and their meanings is
available here,
Samples: Success and fail
The sample revokes a session token using the session token string as a parameter.
Sample Request:
GET https://[server]/RevokeSessionToken?SessionToken=YOUR_SESSION_TOKEN
Response body on success: