Partner API – getInventoryData

Home » Partner API » Partner API – getInventoryData
Partner API No Comments

The JumpDrive Partner API function “getInventoryData” allows partners to access current inventory data about vehicles using the 1st generation JD vehicle device.

Getting Started

Our Partner API requires the following to retrieve vehicle data:

  1. API URL, Username and Password (please email for API URL and your credentials)
  2. Vehicle Identification Number (VIN)
  3. Familiarity with a programming language supporting REST calls (PHP, Ruby, .NET, Python, etc.)

For best results, we recommend querying the API during the check out process on demand.

Steps For Using the API

  1. Create a script to call our API URL (will be provided via email upon request) and pass your username, password, VIN and response format.  By default all results are in XML, for example – getInventoryData(username, password, VIN, format).  For JSON formatted results, use getInventoryData(username, password, VIN, ‘json’) and for XML formatted results use getInventoryData(username, password, VIN, ‘xml’).
  2. If you receive the message “Invalid Username and/or Password”, please contact and we will confirm your credentials.

Sample XML/JSON results

Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
   <LotName>Pine Ridge</LotName>
   <LastTimeIn>2015-04-11 13:01:48</LastTimeIn>
Sample JSON Response
[{"VIN":"5GAKRBED0BJ315901","JumpDriveID":"ffff31","LotID":"218","LotName":"Pine Ridge","LastTimeIn":"2015-04-11 13:01:48","StartMileage":"42646","LastMileage":"36645","FuelPercent":"34.48","FuelVolume":"20.88","Battery":"13.13","Longitude":"-79.519729614258","Latitude": "8.9935998916626","IndoorLocation":"B216","Damage1Count":"12","Damage2Count":"2","Speeding1Count":"344","Speeding2Count":"10"}]

Description Of Each Field Showing In XML/JSON Responses Above

  1. VIN = Vehicle Identification Number
  2. JumpDriveID = JumpDrive device ID assigned to each customer
  3. LotID = ID of the current location of the vehicle
  4. LotName = Name of the current location of the vehicle
  5. LastTimeIn = Most recent time when vehicle checked in (in local time zone)
  6. StartMileage = Starting mileage (in km) of vehicle when it was registered with a JumpDrive Vehicle Device.  If this value is 0, the vehicle mileage was not registered and mileage value will not be up to date.
  7. LastMileage = Latest vehicle mileage (in km)
  8. FuelPercent = Current percentage of fuel tank full (100% is full, 0% is empty)
  9. FuelVolume = Current fuel volume in fuel tank, in liters
  10. Battery = Current battery level reported by vehicle in V
  11. Longitude = Current longitude value reported by vehicle
  12. Latitude = Current latitude value reported by vehicle
  13. IndoorLocation = Indoor slot or zone based on indoor sensor network
  14. Damage1Count = Total number of possible damage impact events on this vehicle
  15. Damage2Count = Total number of likely damage impact events on this vehicle
  16. Speeding1Count = Total number of seconds of speeding between 85mph and 99mph
  17. Speeding2Count = Total number of seconds of speeding 100mph and above

Additional questions?

Please email if you have any questions or require additional support.