GET api/v1/Cars?Token={Token}

Get the current status of the car associated with the given job tracking token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Token

string

Required

Body Parameters

None.

Response Information

Resource Description

Car
NameDescriptionTypeAdditional information
JobID

The Job ID that this car is currently associated with

integer

None.

JobStatus

The current status of the job

string

None.

DriverName

The name of the driver

string

None.

DriverMobile

The driver's mobile phone number

string

None.

DDI

The allocated DDI phone number

string

None.

Registration

The registration plate of the car

string

None.

PassengerOnBoardTime

The time the passenger entered the car

date

None.

PassengerDropOffTime

The time the passenger was dropped off

date

None.

DriverOnSiteTime

The time the driver arrived at the pickup location for the job

date

None.

Latitude

The last known latitude of the car

decimal number

None.

Longitude

The last known longitude of the car

decimal number

None.

HorizontalAccuracy

The accuracy, in metres of the latitude and longitude

decimal number

None.

LastLocationTime

The time the last known location was reported

date

None.

FormattedAddress

The formatted address of the current location

string

None.

ExtRefID

An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "jobID": 1,
  "jobStatus": "sample string 2",
  "driverName": "sample string 3",
  "driverMobile": "sample string 4",
  "ddi": "sample string 5",
  "registration": "sample string 6",
  "passengerOnBoardTime": "2024-06-25T01:50:20.9978538+00:00",
  "passengerDropOffTime": "2024-06-25T01:50:20.9978538+00:00",
  "driverOnSiteTime": "2024-06-25T01:50:20.9978538+00:00",
  "latitude": 1.1,
  "longitude": 1.1,
  "horizontalAccuracy": 1.1,
  "lastLocationTime": "2024-06-25T01:50:20.9978538+00:00",
  "formattedAddress": "sample string 7",
  "extRefID": "sample string 8"
}