GET api/clients/{clientID}/trips/{bookingId}/status
Gets the current status of a trip.
Request Information
URI Parameters
| Name | Description | Type | Additional 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 current status of the trip.
TripStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | TripStatusCode |
None. |
|
| InternalCode | string |
None. |
|
| Notes | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": 0,
"internalCode": "sample string 1",
"notes": "sample string 2"
}
application/xml, text/xml
Sample:
<TripStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <InternalCode>sample string 1</InternalCode> <Notes>sample string 2</Notes> <Status>Unscheduled</Status> </TripStatus>