getBenefits
get
getBenefits
Resource URL
https://api-sandbox.arity.com/services/roadside/v1/rescue/benefits
Query Parameters
| Name | Values | Description |
|---|---|---|
|
appId
(required) |
Partner specific App id. |
|
|
sessionId
(required) |
Session id produced from a successful response of the create service API. |
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Bearer Token generated from OAuth API (client_credentials grant) |
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 Price | Retrieve Benefits |
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| status | string | The current status of the beneifts (Active, Inactive etc) |
| maxClaimCount | string | The maximum number of claim counts for the benefit |
| usageCount | string | The number of claims that have been used |
| arrivalSrTime | number | |
| towToDealershipRequired | boolean | This flag (true or false) indicates if the vehicle needs to be towed to a dealership rather than a non dealer for service |
| membershipExpDate | string | Expiration date for the membership |
| policyNumber | string | Assigned Policy Number |
| memberId | string | Assigned Member ID |
| partnerCode | string | Partner specific App id. |
| services | array | Information on each of the 5 resuce services |
| services[] .type | string | The type of rescue (Gas, Tow, Changetire, Battery, Lockout) |
| services[] .claimCount | string | The number of claims that have been used |
| services[] .maxClaimCount | string | The maximum number of claim counts for the benefit |
| services[] .fuelQty | number | The amount of fuel provided in Gallons |
| services[] .fuelQtyUnit | string | The unit of measure used for the fuel. Gallon |
| services[] .fuelQtyCan | number | The amount of fuel provide in liters |
| services[] .fuelQtyUnitCan | string | The unit of measure used for the fuel. Liter |
| services[] .towIncludedQty | number | This is the distance that is covered for the tow |
| services[] .towIncludedQtyUnit | string | This is the units of measure for the distance included for the tow (MILES) |
| vehicles | array | Details on Vehicle |
| vehicles[] .coverageAmount | number | The dollar amount that will be covered for the rescue (eg. 75) |
| vehicles[] .year | string | The vehicle year |
| vehicles[] .model | string | The vehicle model |
| vehicles[] .make | string | The vehicle make |
| vehicles[] .color | string | The vehicle model |
| vehicles[] .vehiclePropId | number | |
| vehicles[] .suspendIndicator | string | |
| vehicles[] .vehicleId | string | Unique Vehicle Identifier could be the VIN |
| vehicles[] .vin | string | The VIN for the Vehicle |
| vehicles[] .equipmentClass | string | The classifcation of the vehicle. Light (1) <10,000 lbs. Medium (2) 10,001 - 26,000 lbs. Heavy (3) >26,001 lbs. |
| vehicles[] .knownMilage | number | The known mileage for the vehicle |
| vehicles[] .warrantyEndMilage | number | The mileage at which the warranty ends |
| operators | array | Details on the Vehicle Operator/Owner |
| operators[] .firstName | string | Rescuers first name |
| operators[] .lastName | string | Rescuers last name |
| operators[] .operatorPropId | number | Rescuers vehicle description |
Working...