CloseDedicatedSession (Application-Level)
This method is used for closing previously opened dedicated session once the API calls are done.
Authentication
This method requires an authentication token regardless of the access level of the application.
Request
Target Endpoint
POST /Api/Applications/CloseDedicatedSession
Parameters
|
Property Name |
Type |
Is Required? |
Description |
|---|---|---|---|
| ApplicationKey | String | Required | The application key, corresponding to your specific web service application. This constitutes the identifier for the requested resource. |
| SessionId | String | Required | The string associated with the dedicated session returned by OpenDedicatedSession method call. |
Request Sample
Headers
POST /Api/Applications/CloseDedicatedSession HTTP/1.1 Authorization: Bearer Do3l_2l3uLdmYX76u-BufLzuuhFPOE-nRZDyU0adiFk1 Content-Type: application/json Host: dev7.pagos.com
Body (formatted)
{
"SessionId": "25eae3ae-755e-4b3c-aa48-d7f096f6a2a7",
"ApplicationKey": "a4dcfb4f0464453b928ce1d6bcfb6aa3"
}
Response
|
Property Name |
Type |
Description |
|---|---|---|
| Success | Boolean | Indicated whether or not the request was successful |
| InvalidToken | Boolean | If the request is unsuccessful, indicates whether or not the failure was due to token. |
| Messages | Array of String | A list of messages, which can be used or captured for diagnostics. When requests are unsuccessful, the reason for the failure will be documented in the Messages list. |
Response Sample (Success)
Headers
HTTP/1.1 200 OK Cache-Control: no-cache, no-store Content-Type: application/json; charset=utf-8
Body (formatted)
{
"Success": true,
"InvalidToken": false,
"Messages": []
}
Response Sample (Failure)
Headers
HTTP/1.1 200 OK Cache-Control: no-cache, no-store Content-Type: application/json; charset=utf-8
Body (formatted)
Example 1:
{
"Success": false,
"InvalidToken": true,
"Messages": [
"The requested resource is restricted and your request did not provide a valid token."
]
}
Example 2:
{
"Success": false,
"InvalidToken": false,
"Messages": [
"The requested application is invalid."
]
}