Arity Developer Portal

Determine Service

Method

Description

POST

https://api-sandbox.arity.com/services/roadside/v1/rescue/tire

Initiates a service request for a TIRE CHANGE service based on factors such as destination address, service type, vehicle, etc., which will be created from the input collected.

POST

createLockoutRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/lockout

Initiates a service request for a LOCKOUT service based on factors such as destination address, service type, vehicle, etc., which will be created from the input collected.

POST

createGasRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/gas

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.

POST

createTowRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/tow

Initiates a service request for a TOW service based on factors such as destination address, service type, vehicle, etc., which will be created from the input collected.

POST

createBatteryRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/battery

Initiates a service request for a BATTERY JUMP service based on factors such as destination address, service type, vehicle, etc., which will be created from the input collected.

Determine Price | Retrieve Benefits

Method

Description

POST

getServiceCost

https://api-sandbox.arity.com/services/roadside/v1/rescue/costs

Retrieve the cost of rescue service by using the lat/long values of both the disablement location and the destination location. Cost is in the form of a flat fee of $x for rescue service type.

GET

getBenefits

https://api-sandbox.arity.com/services/roadside/v1/rescue/benefits

Retrieve the benefit details associated with member ID credentials.

Collect Customer Feedback

Method

Description

POST

createFeedback

https://api-sandbox.arity.com/services/roadside/v1/rescue/feedback

Allows customer to provide feedback of the requested service, once service is completed

Provisioning Services

Method

Description

GET

getMemberDetails

https://api-sandbox.arity.com/services/roadside/v1/provisioning/formpost/member/{memberId}/asset/{assetIntegrationId}/partner/{partnerCd}

It allows users to retrive a members data.

PUT

updateMemberDetails

https://api-sandbox.arity.com/services/roadside/v1/provisioning/formpost/member/{memberId}/asset/{assetIntegrationId}/partner/{partnerCd}

It allows the user to update member data by submitting their updated details.

POST

createMemberForm

https://api-sandbox.arity.com/services/roadside/v1/ars_provisioning_v1/formpost

This service provisions a new account and/or vehicle for a partner’s system.

Dispatch & Track Rescue

Method

Description

GET

getProviders

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}/providers

The application will poll on this API method after the rescue request is created. The results will provide all the service provider related details including providers name, address and contact info. It also brings with cost details. Once the status changes from NEW_JOB to BOOKED, the app should start polling the getServiceRequestInfo method.

POST

cancelServiceRequest

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}/cancel

Cancel the initial request for service. The rescue can only be cancelled before the status is APPROACHING and the ETA is greater than 15 minutes

GET

getETA

https://api-sandbox.arity.com/services/roadside/v1/rescue/eta

Given latitude and longitude values, this API provides average response time in minutes based on recent history.

GET

getServiceRequestInfo

https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}

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.

Get Started

Method

Description

POST

createSession

https://api-sandbox.arity.com/services/roadside/v1/rescue/session

Used to initiate a rescue session when consumer provides a required valid input credentials.

POST

token

https://api-sandbox.arity.com/services/roadside/v1/oauth/accesstoken

Generates an access token when provided with client_ID and base64 encoded client_id & client_secret.

Determine Customer & Vehicle

Method

Description

GET

getMake

https://api-sandbox.arity.com/services/roadside/v1/vehicle/makes

Given a vehicle Year as input, this service provides a list of vehicle Make options.

GET

getModel

https://api-sandbox.arity.com/services/roadside/v1/vehicle/makes/{make}/models

Given a vehicle Make and year as input, this service provides a list of vehicle Models.

GET

getServiceAreaValidation

https://api-sandbox.arity.com/services/roadside/v1/rescue/available

Given latitude, longitude and zipCode, this API checks for location where requested service is available or not.

Provider Services

Method

Description

POST

https://api-sandbox.arity.com/services/roadside/v1/provider/fileservice/search

Used to search for a specific documents in the EDMS (Electronic Document Management System)

GET

retrieve

https://api-sandbox.arity.com/services/roadside/v1/provider/fileservice/retrieve/{contentid}

Given a contentID associated with document, this will retrieve the document.

POST

upload

https://api-sandbox.arity.com/services/roadside/v1/provider/fileservice/upload

Used for uploading documents to EDMS (Electronic Document Management System)

Tow To Locations

Method

Description

POST

getTowToLocations

https://api-sandbox.arity.com/services/roadside/v1/rescue/tow/locations

Retrive a list of locations where the consumer vehicle can choose to be towed.

Rescue Assist Tool

Method

Description

POST

createStatusUpdate

https://api-sandbox.arity.com/services/roadside/v1/rescue/statusUpdate

Allows partners to book a rescue without the assistance of Allstate Roadside. The partners will be able to update status of requested services by using Auto Assist tool.