getServiceRequestInfo
getServiceRequestInfo
get
getServiceRequestInfo
The application will poll on this API method after the rescue request has been BOOKED.This method returns all rescue service details including service status, predective/updated ETA, disablement & destination addresses, providers & driver info etc.
Resource URL
https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}
Query Parameters
| Name | Values | Description |
|---|---|---|
|
sessionId
(required) |
Session ID created via the createSession Method eg. 3ec6ac0-65e5-4db1-abf2-133bd30edede |
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Bearer Token generated from OAuth API (client_credentials grant) |
reqId Request id produced from a successful response of the create service API. true
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 |
Dispatch & Track Rescue |
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| serviceRequest .requestId | string | The requestId created for the rescue |
| serviceRequest .callId | string | A unique reference numbe for the dispatch if user were to call assistance |
| serviceRequest .consumerFirstName | string | First name of consumer |
| serviceRequest .consumerLastName | string | Last name of consumer |
| serviceRequest .consumerVehicleMake | string | Make of Vehicle |
| serviceRequest .consumerVehicleModel | string | Model of Vehicle |
| serviceRequest .consumerVehicleYear | string | Year of Vehicle |
| serviceRequest .consumerVehicleColor | string | Color of Vehicle |
| serviceRequest .serviceType | string | Type of rescue requested (Gas, Tow, Changetire, Battery, Lockout) |
| serviceRequest .cost | string | The cost of the service |
| serviceRequest .status | string | The current status of the job (BOOKED, EN-ROUTE, APPROACHING, ARRIVED_ONSITE, COMPLETED) |
| serviceRequest .requestCreationTime | string | The date and time the rescue was requested (2017-02-01T21:03:01.958Z) |
| serviceRequest .purchaseOrderNumber | string | The purchase order for the rescue |
| serviceRequest .eta | string | The estimated time of arrival in minutes (40) |
| serviceRequest .etaTime | string | The eta time in GMC: 2017-02-01T21:43:01.958Z |
| serviceRequest .updatedEta | string | Update eta is provided when the rescuer or the customer service rep provides it |
| serviceRequest .updatedEtaTime | string | The update eta time in GMC: 2017-02-01T21:43:01.958Z |
| serviceRequest .predictedEta | string | Predictive eta is provided when the rescuer is fully digital and provide their GPS coordinates |
| serviceRequest .predictedEtaTime | string | The predictive eta time in GMC: 2017-02-01T21:43:01.958Z |
| serviceRequest .consumerTimezone | string | The time zone where the consumer is located |
| serviceRequest .overCostAmount | number | The amount of the rescue that is over the established cost |
| serviceRequest .coverageAmount | number | The ammount of the rescue is covered |
| serviceRequest .incidentAddress .addressLine1 | string | (Optional) Disablement address |
| serviceRequest .incidentAddress .addressLine2 | string | (Optional) Disablement address continued |
| serviceRequest .incidentAddress .city | string | (Optional) City |
| serviceRequest .incidentAddress .zipCode | string | (Optional)Zipcode |
| serviceRequest .incidentAddress .country | string | (Optional) USA |
| serviceRequest .incidentAddress .state | string | (Optional) State |
| serviceRequest .incidentAddress .latitude | number | (Required) Coordinate for latitude |
| serviceRequest .incidentAddress .longitude | number | (Required) Coordinate for longitude |
| serviceRequest .destinationAddress .addressLine1 | string | (Optional) Disablement address |
| serviceRequest .destinationAddress .addressLine2 | string | (Optional) Disablement address continued |
| serviceRequest .destinationAddress .city | string | (Optional) City |
| serviceRequest .destinationAddress .zipCode | string | (Optional)Zipcode |
| serviceRequest .destinationAddress .country | string | (Optional) USA |
| serviceRequest .destinationAddress .state | string | (Optional) State |
| serviceRequest .destinationAddress .latitude | number | (Required) Coordinate for latitude |
| serviceRequest .destinationAddress .longitude | number | (Required) Coordinate for longitude |
| provider .id | string | The provider identification number |
| provider .companyName | string | The name of the provider |
| provider .contactName | string | The contact person for the provider |
| provider .contactNumber | string | The provider contact number |
| provider .type | string | The type of rescue being provided |
| provider .providerAddress .addressLine1 | string | (Optional) Disablement address |
| provider .providerAddress .addressLine2 | string | (Optional) Disablement address continued |
| provider .providerAddress .city | string | (Optional) City |
| provider .providerAddress .zipCode | string | (Optional)Zipcode |
| provider .providerAddress .country | string | (Optional) USA |
| provider .providerAddress .state | string | (Optional) State |
| provider .providerAddress .latitude | number | (Required) Coordinate for latitude |
| provider .providerAddress .longitude | number | (Required) Coordinate for longitude |
| driver .id | string | The identification number for the driver |
| driver .name | string | Full name of driver |
| driver .firstName | string | Driver first name |
| driver .lastName | string | Driver last name |
| driver .latitude | number | The latitude of the driver |
| driver .longitude | number | The longitude of the driver |
| driver .contactNumber | string | The contact number for the driver |
| driver .driverProfileImageurl | string | Not supported: The URL to the drivers picture |
| driver .driverEquipmentImageurl | string | Not supported: The URL to the drivers vehicle |
Working...