Booking Quickstart Guide

Shared Mobility’s Booking API allows Fleet Utilization OBDII customers to send additional booking or “rental” data to pair their vehicle trip history to their users or “drivers.” This documentation includes everything needed to successfully pair users to vehicles for an allotted amount of time. If you have any additional questions around using the Booking API, please contact your Customer Success team.

All requests to Arity require authentication and all applications must be registered with us.


  1. Client ID and Client Secret
    Get your Client ID and Client Secret. These have already been created and approved by Arity, and have been sent to you. Contact us if you need help locating them.
  2. Access token
    Generate an access token with the Authorization API. This access token expires every hour and must be passed in the header of all subsequent API calls.
    Use generateToken to generate a b2b-scope access token by sending your Client ID and Client Secret. This access token expires every hour and must be passed in the header of all subsequent API calls.
  3. User
    We require a user to pair them to a vehicle’s trip history. In Fleet Utilization, a user refers to the driver booking or “renting” a vehicle. A dateOfBirth, in the format of YYYY-MM-DD, is not required to create a user or to pair them to a vehicle.
    Use the POST /users/{userId} method to create a new user. You can specify the userId or leave it blank and let Arity generate it for you. To create a user with an auto-generated id leave the userId field NULL or remove the key-value pair entirely.
  4. Vehicle:Device Pairing
    In addition to userId data, we require a Vehicle Identification Number (VIN) and am International Mobile Equipment Identity (IMEI) in order to later pair all three together.
  5. Use the POST /vehicles/{vin}/devices/{imei} method to create a new or modify an existing VIN:IMEI pairing.
  6. Create New Booking
    Once a userId is created and a VIN:IMEI is paired, you can start a Booking. Along with the userId, VIN and IMEI, we require a startTimestamp and an estimatedEndTimestamp to start a Booking. The startTimestamp must be in Epoch format and it indicates the time the Booking started. The estimatedEndTimestamp must also be in Epoch format and it indicates the estimated time the Booking will end.
  7. Use the POST /vehicles/{vin}/users/{userId}?startTimestamp={}&estimatedEndTimestamp={} method to create a new Booking.
  8. End Existing Booking
    Once a Booking has started and a user is done with a vehicle, you can end a Booking. Along with the userId, VIN and IMEI, we require a actualEndTimestamp. The actualEndTimestamp must be in Epoch format and it indicates the actual time the Booking ends.
  9. Use the PUT /vehicles/{vin}/users/{userId}?actualEndTimestamp={} method to create a new Booking.
  10. Retrieve Vehicle or User Trip History
    At any time following the successful creation of a userId, VIN and IMEI pairing, creating a new Booking and then ending an existing Booking, you may retrieve Trip History data via separate endpoints:
  11. Use GET /vehicles/{vin}/trips to retrieve a list of trip summaries for a vehicle.
    Use GET /users/{userId}/trips to retrieve a list of trip summaries for a user.

vehicle-controller

Method
Description

POST

postUserVehiclePairingUsingPOST

http://fleet-utilization.platform.allstate.com//vehicles/{vin}/users/{userId}

postUserVehiclePairing

POST

createVehicleUsingPOST

http://fleet-utilization.platform.allstate.com//vehicles

createVehicle

POST

addDeviceToVehicleUsingPOST

http://fleet-utilization.platform.allstate.com//vehicles/{vin}/devices

addDeviceToVehicle

GET

getDevicesUsingGET_1

http://fleet-utilization.platform.allstate.com//vehicles/{vin}/devices

getDevices

GET

getVehicleTripsUsingGET

http://fleet-utilization.platform.allstate.com//vehicles/{vin}/trips

getVehicleTrips

authorization-controller

Method
Description

POST

generateToken

http://fleet-utilization.platform.allstate.com//platform/oauth/v1/token

Generate an access token to use for authorization on subsequent API calls. Token expires every hour and must be passed in the header of all subsequent API calls.

device-controller

Method
Description

GET

getTripsUsingGET

http://fleet-utilization.platform.allstate.com//devices/{imei}/trips

getTrips

POST

createDeviceUsingPOST

http://fleet-utilization.platform.allstate.com//devices

createDevice

GET

getDiagnosticsUsingGET

http://fleet-utilization.platform.allstate.com//devices/{imei}/diagnostics

getDiagnostics

GET

getTripDetailsByIdUsingGET

http://fleet-utilization.platform.allstate.com//devices/{imei}/trips/{tripId}

getTripDetailsById

user-controller

Method
Description

GET

getTripsUsingGET_1

http://fleet-utilization.platform.allstate.com//users/{userId}/trips

getTrips

© 2019 Arity, LLC. All rights reserved.  | Privacy Policy | Terms of Use | Legacy APIs