createGasRequest
createGasRequest
post
createGasRequest
Initiates a service request for a GAS service based on factors such as destination address, service type, vehicle, etc., which will be created from the input collected.
Resource URL
https://api-sandbox.arity.com/services/roadside/v1/rescue/gas
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Bearer Token generated from OAuth API (client_credentials grant) |
Request Body
{1
{2
"sessionId": "",
3
"serviceRequest": {4
"appId": "",
5
"routeCSR": "",
6
"ppuFlag": "",
7
"CCardBundle": "",
8
"partnerTransactionId": "",
9
"firstName": "",
10
"lastName": "",
11
"email": "",
12
"contactNumber": "",
13
"consumerId": "",
14
"deviceTimeZone": "",
15
"additionalComments": "",
16
"serviceTypeOptions": {17
"gas": ""
18
},
19
"disablementAddress": {20
"addressLine1": "",
21
"addressLine2": "",
22
"city": "",
23
"zipCode": "",
24
"country": "",
25
"state": "",
26
"latitude": 0,
27
"longitude": 0
28
},
29
"vehicle": {30
"year": "",
31
"model": "",
32
"make": "",
33
"color": "",
34
"vin": "",
35
"equipmentClass": ""
36
}
37
}
38
}
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 |
Determine Service |
| Name | Type | Description |
|---|---|---|
| sessionId | string | (Required) The session ID for the rescue |
| serviceRequest .appId | string | (Required) The unique application ID |
| serviceRequest .routeCSR | string | (Optional) Flag used for Whitelable apps, to directly transfer the dispatch to the CSR instead of routing it to a Provider |
| serviceRequest .ppuFlag | string | (Optional) Flag to indicate if this is a Pay Per Use rescue |
| serviceRequest .CCardBundle | string | (Optional) The credit card bundle to be sent for the PPU use case |
| serviceRequest .partnerTransactionId | string | (Optional) Unique reference number from partner system to post to ARS database so that it can be tied to ARS id for that dispatch |
| serviceRequest .firstName | string | (Required) First Name |
| serviceRequest .lastName | string | (Required) Last Name |
| serviceRequest | string | (Required) email address |
| serviceRequest .contactNumber | string | (Required) Phone number |
| serviceRequest .consumerId | string | (Required) The ID associated with the individual making the request. Usually the email address eg. appconsumer@emaiaddress.com |
| serviceRequest .deviceTimeZone | string | (Optional)The time zone where the consume is located |
| serviceRequest .additionalComments | string | (Optional) Contains additional comments collected from the consumer |
| serviceRequest .serviceTypeOptions .gas | string | (Required) The type of gas needed |
| serviceRequest .disablementAddress .addressLine1 | string | (Optional) Disablement address |
| serviceRequest .disablementAddress .addressLine2 | string | (Optional) Disablement address continued |
| serviceRequest .disablementAddress .city | string | (Optional) City |
| serviceRequest .disablementAddress .zipCode | string | (Optional)Zipcode |
| serviceRequest .disablementAddress .country | string | (Optional) USA |
| serviceRequest .disablementAddress .state | string | (Optional) State |
| serviceRequest .disablementAddress .latitude | number | (Required) Coordinate for latitude |
| serviceRequest .disablementAddress .longitude | number | (Required) Coordinate for longitude |
| serviceRequest .vehicle .year | string | (Required) Year of Vehicle |
| serviceRequest .vehicle .model | string | (Required) Model of Vehicle |
| serviceRequest .vehicle .make | string | (Required) Make of Vehicle |
| serviceRequest .vehicle .color | string | (Required) Color of Vehicle |
| serviceRequest .vehicle .vin | string | (Optional) Vehicle Identification Number |
| serviceRequest .vehicle .equipmentClass | string | (Required) The classifcation of the vehicle. Light (1) <10,000 lbs. Medium (2) 10,001 - 26,000 lbs. Heavy (3) >26,001 lbs. |
| Name | Type | Description |
|---|---|---|
| requestId | string | The request ID for the rescue |
| sessionId | string | The Session ID for the rescue |
| callId | string | A unique reference numbe for the dispatch if user were to call assistance |
| message | string | Message indicating what happened: ServiceRequest created successfully |
Working...