GET api/clients/{clientId}/trips/{bookingId}/vehicleInfo

Gets location information about a vehicle that has been assigned to handle a trip.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

The ID of the client to get trips for.

integer

Required

bookingId

The ID of the booking that we're looking for.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns information about the assigned vehicle, or null if the information isn't available.

VehicleLocation
NameDescriptionTypeAdditional information
VehicleNumber

Gets or sets the vehicle's number.

string

None.

Latitude

Gets or sets the vehicle's last known latitude coordinate

decimal number

None.

Longitude

Gets or sets the vehicle's last known longitude coordinate

decimal number

None.

Provider

The provider of the vehicle

string

None.

Direction

The direction the vehicle is travelling, if available. In degrees from North (eg north is 0, east is 90)

decimal number

None.

LastUpdated

Gets or sets the last time the vehicle reported its location.

date

None.

Response Formats

application/json, text/json

Sample:
{
  "vehicleNumber": "sample string 1",
  "latitude": 2.1,
  "longitude": 3.1,
  "provider": "sample string 4",
  "direction": 1.1,
  "lastUpdated": "2021-06-24T03:19:23.5364375-06:00"
}

application/xml, text/xml

Sample:
<VehicleLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <Direction>1.1</Direction>
  <LastUpdated>2021-06-24T03:19:23.5364375-06:00</LastUpdated>
  <Latitude>2.1</Latitude>
  <Longitude>3.1</Longitude>
  <Provider>sample string 4</Provider>
  <VehicleNumber>sample string 1</VehicleNumber>
</VehicleLocation>