The JumpDrive API function “getReturns” allows customers and partners to access data about returning vehicles using the 1st generation JD vehicle device.
Getting Started
Our Partner API requires the following to retrieve vehicle data:
- API URL, Username and Password (please email partner@jumpdrive.com for your credentials)
- Vehicle Identification Number (VIN)
- Familiarity with a programming language supporting REST calls (PHP, Ruby, .NET, and Python)
For best results, we recommend querying the API at least every minute during customer hours of operation.
Steps For Using the API
- Create a script to call our API URL (will be provided via email upon request) and pass your username, password, and response format. By default all results are in XML, for example – getReturns(username, password, vin, response). For JSON formatted results, use getReturns(username, password, vin, json).
- If you receive the message “Invalid Username and/or Password”, please contact partner@jumpdrive.com and we will confirm your credentials.
- IMPORTANT: The API returns only new data generated since the previous request. If no new new information is available, it will return the “No New Records” message.
Sample XML/JSON results
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?> <root> <Trip1> <ID>660102</ID> <JumpDriveID>fffc8d</JumpDriveID> <VIN>5GAKRBED0BJ315904</VIN> <ReturnTime>2016-02-02 16:36:22</ReturnTime> <ReturnFuelInLiters>11.6</ReturnFuelInLiters> <ReturnFuelInPercentage>13.93</ReturnFuelInPercentage> <ReturnMileage>50947</ReturnMileage> <ReturnLotID>273</ReturnLotID> <ReturnLotName>Pine Ridge</ReturnLotName> <CustomerID>67</CustomerID> <CreatedAt>2016-02-02 16:36:22</CreatedAt> </Trip1> <Trip2> <ID>643602</ID> <JumpDriveID>fffc8d</JumpDriveID> <VIN>5GAKRBED0BJ315904</VIN> <ReturnTime>2016-01-29 17:39:53</ReturnTime> <ReturnFuelInLiters>22.55</ReturnFuelInLiters> <ReturnFuelInPercentage>27.08</ReturnFuelInPercentage> <ReturnMileage>50491</ReturnMileage> <ReturnLotID>273</ReturnLotID> <ReturnLotName>Pine Ridge</ReturnLotName> <CustomerID>67</CustomerID> <CreatedAt>2016-01-29 17:39:53</CreatedAt> </Trip2> <Trip3> <ID>635702</ID> <JumpDriveID>fffc8d</JumpDriveID> <VIN>5GAKRBED0BJ315904</VIN> <ReturnTime>2016-01-28 16:53:34</ReturnTime> <ReturnFuelInLiters>27.2</ReturnFuelInLiters> <ReturnFuelInPercentage>32.66</ReturnFuelInPercentage> <ReturnMileage>50303</ReturnMileage> <ReturnLotID>273</ReturnLotID> <ReturnLotName>Pine Ridge</ReturnLotName> <CustomerID>67</CustomerID> <CreatedAt>2016-01-28 16:53:34</CreatedAt> </Trip3> <Trip4> <ID>631102</ID> <JumpDriveID>fffc8d</JumpDriveID> <VIN>5GAKRBED0BJ315904</VIN> <ReturnTime>2016-01-27 17:51:21</ReturnTime> <ReturnFuelInLiters>23.86</ReturnFuelInLiters> <ReturnFuelInPercentage>28.65</ReturnFuelInPercentage> <ReturnMileage>50295</ReturnMileage> <ReturnLotID>273</ReturnLotID> <ReturnLotName>Pine Ridge</ReturnLotName> <CustomerID>67</CustomerID> <CreatedAt>2016-01-27 17:51:21</CreatedAt> </Trip4> <Trip5> <ID>627402</ID> <JumpDriveID>fffc8d</JumpDriveID> <VIN>5GAKRBED0BJ315904</VIN> <ReturnTime>2016-01-27 10:46:41</ReturnTime> <ReturnFuelInLiters>32.08</ReturnFuelInLiters> <ReturnFuelInPercentage>38.52</ReturnFuelInPercentage> <ReturnMileage>50289</ReturnMileage> <ReturnLotID>273</ReturnLotID> <ReturnLotName>Pine Ridge</ReturnLotName> <CustomerID>67</CustomerID> <CreatedAt>2016-01-27 10:46:41</CreatedAt> </Trip5> </root>
Sample JSON Response
{
"root": {
"Trip1": {
"ID": "660102",
"JumpDriveID": "fffc8d",
"VIN": "5GAKRBED0BJ315904",
"ReturnTime": "2016-02-02 16:36:22",
"ReturnFuelInLiters": "11.6",
"ReturnFuelInPercentage": "13.93",
"ReturnMileage": "50947",
"ReturnLotID": "273",
"ReturnLotName": "Pine Ridge",
"CustomerID": "67",
"CreatedAt": "2016-02-02 16:36:22"
},
"Trip2": {
"ID": "643602",
"JumpDriveID": "fffc8d",
"VIN": "5GAKRBED0BJ315904",
"ReturnTime": "2016-01-29 17:39:53",
"ReturnFuelInLiters": "22.55",
"ReturnFuelInPercentage": "27.08",
"ReturnMileage": "50491",
"ReturnLotID": "273",
"ReturnLotName": "Pine Ridge",
"CustomerID": "67",
"CreatedAt": "2016-01-29 17:39:53"
},
"Trip3": {
"ID": "635702",
"JumpDriveID": "fffc8d",
"VIN": "5GAKRBED0BJ315904",
"ReturnTime": "2016-01-28 16:53:34",
"ReturnFuelInLiters": "27.2",
"ReturnFuelInPercentage": "32.66",
"ReturnMileage": "50303",
"ReturnLotID": "273",
"ReturnLotName": "Pine Ridge",
"CustomerID": "67",
"CreatedAt": "2016-01-28 16:53:34"
},
"Trip4": {
"ID": "631102",
"JumpDriveID": "fffc8d",
"VIN": "5GAKRBED0BJ315904",
"ReturnTime": "2016-01-27 17:51:21",
"ReturnFuelInLiters": "23.86",
"ReturnFuelInPercentage": "28.65",
"ReturnMileage": "50295",
"ReturnLotID": "273",
"ReturnLotName": "Pine Ridge",
"CustomerID": "67",
"CreatedAt": "2016-01-27 17:51:21"
},
"Trip5": {
"ID": "627402",
"JumpDriveID": "fffc8d",
"VIN": "5GAKRBED0BJ315904",
"ReturnTime": "2016-01-27 10:46:41",
"ReturnFuelInLiters": "32.08",
"ReturnFuelInPercentage": "38.52",
"ReturnMileage": "50289",
"ReturnLotID": "273",
"ReturnLotName": "Pine Ridge",
"CustomerID": "67",
"CreatedAt": "2016-01-27 10:46:41"
}
}
}
Description Of Each Field Showing In XML/JSON Responses Above
- Trip# = Trip count of VIN within last 3 days and max 5 trips.
- ID = Unique Auto Increment ID of each return record stored in the JumpDrive DB
- JumpDriveID = JumpDrive device ID assigned to each customer
- VIN = Vehicle Identification Number
- ReturnTime = Time when vehicle returned (in local time zone)
- ReturnFuelInLiters = Fuel in liters at return
- ReturnFuelInPercentage = Fuel in percentage at return
- ReturnMileage = Vehicle mileage at return (in km)
- ReturnLotID = Location ID of vehicle at return
- ReturnLotName = Location name of vehicle at return
- CustomerID = Internal JumpDrive customer identifier
- CreatedAt = Timestamp of return record (in local time zone)
Additional questions?
Please email support@jumpdrive.com if you have any questions or require additional support.