createSession
createSession
post
createSession
Used to initiate a rescue session when consumer provides a required valid input credentials.
Resource URL
https://api-sandbox.arity.com/services/roadside/v1/rescue/session
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Bearer Token generated from OAuth API (client_credentials grant) |
Request Body
{1
{2
"appId": "",
3
"benefits": [4
{5
"key": "",
6
"value": ""
7
}
8
],
9
"otherInfo": [10
{11
"key": "",
12
"value": ""
13
}
14
]
15
}
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400400
Bad Request response
-
401401
Unauthorized response
-
500500
Service Error response
Resource Summary |
|
|
Security |
None |
|
Category |
Get Started |
| Name | Type | Description |
|---|---|---|
| appId | string | (Required) The unique application ID |
| benefits | array | The keys for accessing benefits |
| benefits[] .key | string | The key used to identify the benefit such as vin, policy etc |
| benefits[] .value | string | The actual key value for the benefit identifier |
| otherInfo | array | |
| otherInfo[] .key | string | Other types such as ppuflag used in the Pay Per Use scenario |
| otherInfo[] .value | string | Other types such as Y to indicate if Pay Per Use is being used |
| Name | Type | Description |
|---|---|---|
| sessionId | string | The main sesssion id to begin the rescue eg 3ec6ac0-65e5-4db1-abf2-133bd30edede |
Working...