2.2. Renew an existing Session Token.
GET RenewSessionToken
Description: Renews an existing session token to full life (defined when the token was created). A session token has a default life of 30 minutes.
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]/RenewSessionToken?SessionToken=YOUR_SESSION_TOKEN
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| 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 date and 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 excluding 'QuerySessionToken'.
- Check the remaining life for a session token with the QuerySessionTokenendpoint.
Result Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | LastActive | String | The date and time the API key was last used
as an ISO 8601 string. E.g. 2017-10-17T15:44:50Z. |
| 1 | SessionToken | String | A valid session token returned from the GetSessionToken endpoint. |
| 3 | Remaining | Long | The remaining token life in milliseconds. |
Errors Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. |
| 2 | Detail | String | Description of the status code. |
Possible Status codes in the 'Errors 'object
| Code | Description |
|---|---|
| 400 | Missing Session Token parameter. |
| 401 | Invalid or unknown session token. |
| 405 | Method [request] not allowed. |
| 410 | Session Token has expired. |
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes may be returned. The Errors 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,
Success and fail examples
The sample renews a session token using the session token string as a parameter.
Sample Request:
GET https://[server]/RenewSessionToken?SessionToken=YOUR_SESSION_TOKEN