GET api/clients/{clientId}/trip/{tripId}?additionalPassengerMode={additionalPassengerMode}
Gets information about a booked trip.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
ID of the client that the trip is for. |
integer |
Required |
| tripId |
ID of the trip. |
integer |
Required |
| additionalPassengerMode |
If set to , the client will be automatically included in the additional passengers list. |
AdditionalPassengerMode |
Default value is ClientPlusAdditionalPassengers |
Body Parameters
None.
Response Information
Resource Description
Returns information about the booked trip.
BookedTrip| Name | Description | Type | Additional information |
|---|---|---|---|
| TripType |
Gets the type of the trip (Recurring/OneTime) |
TripType |
None. |
| Status |
Gets or sets the current status of the trip. |
TripStatus |
None. |
| CreationDate |
The date the trip was created |
date |
None. |
| ModifiedDate |
The date the trip was modified |
date |
None. |
| FareToCollect |
Gets or sets any remaining part of the fare that needs to be collected for this trip |
decimal number |
None. |
| PassengerFares |
Gets or sets the fares for each passenger on the trip |
Collection of PassengerFare |
None. |
| RunInfo |
Run information for a booked trip. |
BookedTripRunInfo |
None. |
| Pickup | BookedTripLeg |
None. |
|
| Dropoff | BookedTripLeg |
None. |
|
| Date | date |
None. |
|
| ClientID | integer |
None. |
|
| MobilityAidCodes | Collection of string |
None. |
|
| AdditionalPassengers | Collection of Passenger |
None. |
|
| BookingPurposeCode | string |
None. |
|
| BookingSubtypeCode | string |
None. |
|
| ID | integer |
None. |
|
| ItineraryID | integer |
None. |
|
| CallbackPhoneNumber | string |
None. |
|
| ServiceTypeId | integer |
None. |
|
| Provider | TripProviderInfo |
None. |
|
| UserDefinedFields | Dictionary of string [key] and Object [value] |
None. |
|
| Comments | string |
None. |
|
| DirectDistance | decimal number |
None. |
|
| DirectTime | integer |
None. |
|
| FundingProgramIds | Collection of integer |
None. |
|
| SubscriptionId | integer |
None. |
|
| CallerId | integer |
None. |
|
| Notifications | Collection of NotificationType |
None. |
|
| ClientOptions | ClientOptions |
None. |
|
| IsOriginallyWillCall | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"tripType": 0,
"status": {
"status": 0,
"internalCode": "sample string 1",
"notes": "sample string 2"
},
"creationDate": "2024-12-23T12:31:06.9230662-07:00",
"modifiedDate": "2024-12-23T12:31:06.9230662-07:00",
"fareToCollect": 1.1,
"passengerFares": [
{
"passengerType": {
"code": "sample string 1",
"name": "sample string 2",
"defaultSpaceType": "sample string 3",
"fareTypeId": 4
},
"spaceTypeCode": "sample string 1",
"fareTypeId": 1,
"fare": 2.1
},
{
"passengerType": {
"code": "sample string 1",
"name": "sample string 2",
"defaultSpaceType": "sample string 3",
"fareTypeId": 4
},
"spaceTypeCode": "sample string 1",
"fareTypeId": 1,
"fare": 2.1
}
],
"runInfo": {
"runName": "sample string 1"
},
"pickup": {
"estimatedTime": "00:00:00.1234567",
"actualTime": "00:00:00.1234567",
"status": {
"status": 0,
"internalCode": "sample string 1",
"notes": "sample string 2"
},
"location": {
"id": 1,
"description": "sample string 1",
"category": "sample string 2",
"categoryId": "sample string 3",
"name": "sample string 4",
"latitude": 1.1,
"longitude": 1.1,
"streetNumber": "sample string 5",
"onStreet": "sample string 6",
"atStreet": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"postalCode": "sample string 10",
"itemType": 0,
"internalType": 0,
"unit": "sample string 11",
"comments": "sample string 12",
"isGeocoded": true,
"contact": {
"id": 1,
"referenceId": "sample string 2",
"contactType": "sample string 3",
"firstName": "sample string 4",
"lastName": "sample string 5",
"comments": "sample string 6",
"details": [
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
},
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
}
]
},
"country": "sample string 14",
"stopCode": "sample string 15",
"procedureModifier": "sample string 16",
"timeZoneId": "sample string 17"
},
"requestedTimeEarly": "00:00:00.1234567",
"requestedTime": "00:00:00.1234567",
"requestedTimeLate": "00:00:00.1234567",
"negotiatedTimeEarly": "00:00:00.1234567",
"negotiatedTime": "00:00:00.1234567",
"negotiatedTimeLate": "00:00:00.1234567",
"scheduledTimeEarly": "00:00:00.1234567",
"scheduledTime": "00:00:00.1234567",
"scheduledTimeLate": "00:00:00.1234567",
"comments": "sample string 1",
"phone": "sample string 2"
},
"dropoff": {
"estimatedTime": "00:00:00.1234567",
"actualTime": "00:00:00.1234567",
"status": {
"status": 0,
"internalCode": "sample string 1",
"notes": "sample string 2"
},
"location": {
"id": 1,
"description": "sample string 1",
"category": "sample string 2",
"categoryId": "sample string 3",
"name": "sample string 4",
"latitude": 1.1,
"longitude": 1.1,
"streetNumber": "sample string 5",
"onStreet": "sample string 6",
"atStreet": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"postalCode": "sample string 10",
"itemType": 0,
"internalType": 0,
"unit": "sample string 11",
"comments": "sample string 12",
"isGeocoded": true,
"contact": {
"id": 1,
"referenceId": "sample string 2",
"contactType": "sample string 3",
"firstName": "sample string 4",
"lastName": "sample string 5",
"comments": "sample string 6",
"details": [
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
},
{
"id": 1,
"contactString": "sample string 2",
"type": {
"code": "sample string 1",
"name": "sample string 2",
"type": 0
},
"isPreferred": true
}
]
},
"country": "sample string 14",
"stopCode": "sample string 15",
"procedureModifier": "sample string 16",
"timeZoneId": "sample string 17"
},
"requestedTimeEarly": "00:00:00.1234567",
"requestedTime": "00:00:00.1234567",
"requestedTimeLate": "00:00:00.1234567",
"negotiatedTimeEarly": "00:00:00.1234567",
"negotiatedTime": "00:00:00.1234567",
"negotiatedTimeLate": "00:00:00.1234567",
"scheduledTimeEarly": "00:00:00.1234567",
"scheduledTime": "00:00:00.1234567",
"scheduledTimeLate": "00:00:00.1234567",
"comments": "sample string 1",
"phone": "sample string 2"
},
"date": "2024-12-23",
"clientID": 3,
"mobilityAidCodes": [
"sample string 1",
"sample string 2"
],
"additionalPassengers": [
{
"passengerTypeCode": "sample string 1",
"spaceTypeCode": "sample string 2",
"fareTypeID": 1,
"fundingProgramIds": [
1,
2
]
},
{
"passengerTypeCode": "sample string 1",
"spaceTypeCode": "sample string 2",
"fareTypeID": 1,
"fundingProgramIds": [
1,
2
]
}
],
"bookingPurposeCode": "sample string 4",
"bookingSubtypeCode": "sample string 5",
"id": 6,
"itineraryID": 7,
"callbackPhoneNumber": "sample string 8",
"serviceTypeId": 1,
"provider": {
"providerId": 1,
"name": "sample string 2",
"description": "sample string 3",
"providerStatus": 0
},
"userDefinedFields": {
"sample string 1": {},
"sample string 3": {}
},
"comments": "sample string 9",
"directDistance": 10.1,
"directTime": 1,
"fundingProgramIds": [
1,
2
],
"subscriptionId": 11,
"callerId": 1,
"notifications": [
{
"typeCode": "sample string 1",
"typeName": "sample string 2",
"method": 0,
"enabled": true
},
{
"typeCode": "sample string 1",
"typeName": "sample string 2",
"method": 0,
"enabled": true
}
],
"clientOptions": {
"spaceTypeCode": "sample string 1"
},
"isOriginallyWillCall": true
}
application/xml, text/xml
Sample:
<BookedTrip xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
<AdditionalPassengers>
<Passenger>
<FareTypeID>1</FareTypeID>
<FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</FundingProgramIds>
<PassengerTypeCode>sample string 1</PassengerTypeCode>
<SpaceTypeCode>sample string 2</SpaceTypeCode>
</Passenger>
<Passenger>
<FareTypeID>1</FareTypeID>
<FundingProgramIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</FundingProgramIds>
<PassengerTypeCode>sample string 1</PassengerTypeCode>
<SpaceTypeCode>sample string 2</SpaceTypeCode>
</Passenger>
</AdditionalPassengers>
<BookingPurposeCode>sample string 4</BookingPurposeCode>
<BookingSubtypeCode>sample string 5</BookingSubtypeCode>
<CallbackPhoneNumber>sample string 8</CallbackPhoneNumber>
<CallerId>1</CallerId>
<ClientID>3</ClientID>
<ClientOptions>
<SpaceTypeCode>sample string 1</SpaceTypeCode>
</ClientOptions>
<Comments>sample string 9</Comments>
<Date>2024-12-23T12:31:06.9230662-07:00</Date>
<DirectDistance>10.1</DirectDistance>
<DirectTime>1</DirectTime>
<Dropoff>
<Comments>sample string 1</Comments>
<Location>
<AtStreet>sample string 7</AtStreet>
<Category>sample string 2</Category>
<CategoryId>sample string 3</CategoryId>
<City>sample string 8</City>
<Comments>sample string 12</Comments>
<Contact>
<Comments>sample string 6</Comments>
<ContactType>sample string 3</ContactType>
<Details>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
</Details>
<FirstName>sample string 4</FirstName>
<ID>1</ID>
<LastName>sample string 5</LastName>
<ReferenceId>sample string 2</ReferenceId>
</Contact>
<Country>sample string 14</Country>
<Description>sample string 1</Description>
<ID>1</ID>
<InternalType>Location</InternalType>
<IsGeocoded>true</IsGeocoded>
<ItemType>Location</ItemType>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<Name>sample string 4</Name>
<OnStreet>sample string 6</OnStreet>
<PostalCode>sample string 10</PostalCode>
<ProcedureModifier>sample string 16</ProcedureModifier>
<State>sample string 9</State>
<StopCode>sample string 15</StopCode>
<StreetNumber>sample string 5</StreetNumber>
<TimeZoneId>sample string 17</TimeZoneId>
<Unit>sample string 11</Unit>
</Location>
<NegotiatedTime>PT0.1234567S</NegotiatedTime>
<NegotiatedTimeEarly>PT0.1234567S</NegotiatedTimeEarly>
<NegotiatedTimeLate>PT0.1234567S</NegotiatedTimeLate>
<Phone>sample string 2</Phone>
<RequestedTime>PT0.1234567S</RequestedTime>
<RequestedTimeEarly>PT0.1234567S</RequestedTimeEarly>
<RequestedTimeLate>PT0.1234567S</RequestedTimeLate>
<ScheduledTime>PT0.1234567S</ScheduledTime>
<ScheduledTimeEarly>PT0.1234567S</ScheduledTimeEarly>
<ScheduledTimeLate>PT0.1234567S</ScheduledTimeLate>
<ActualTime>PT0.1234567S</ActualTime>
<EstimatedTime>PT0.1234567S</EstimatedTime>
<Status>
<InternalCode>sample string 1</InternalCode>
<Notes>sample string 2</Notes>
<Status>Unscheduled</Status>
</Status>
</Dropoff>
<FundingProgramIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</FundingProgramIds>
<ID>6</ID>
<IsOriginallyWillCall>true</IsOriginallyWillCall>
<ItineraryID>7</ItineraryID>
<MobilityAidCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</MobilityAidCodes>
<Notifications>
<NotificationType>
<Enabled>true</Enabled>
<Method>Voice</Method>
<TypeCode>sample string 1</TypeCode>
<TypeName>sample string 2</TypeName>
</NotificationType>
<NotificationType>
<Enabled>true</Enabled>
<Method>Voice</Method>
<TypeCode>sample string 1</TypeCode>
<TypeName>sample string 2</TypeName>
</NotificationType>
</Notifications>
<Pickup>
<Comments>sample string 1</Comments>
<Location>
<AtStreet>sample string 7</AtStreet>
<Category>sample string 2</Category>
<CategoryId>sample string 3</CategoryId>
<City>sample string 8</City>
<Comments>sample string 12</Comments>
<Contact>
<Comments>sample string 6</Comments>
<ContactType>sample string 3</ContactType>
<Details>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
<ContactDetail>
<ContactString>sample string 2</ContactString>
<ID>1</ID>
<IsPreferred>true</IsPreferred>
<Type>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
<Type>Phone</Type>
</Type>
</ContactDetail>
</Details>
<FirstName>sample string 4</FirstName>
<ID>1</ID>
<LastName>sample string 5</LastName>
<ReferenceId>sample string 2</ReferenceId>
</Contact>
<Country>sample string 14</Country>
<Description>sample string 1</Description>
<ID>1</ID>
<InternalType>Location</InternalType>
<IsGeocoded>true</IsGeocoded>
<ItemType>Location</ItemType>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<Name>sample string 4</Name>
<OnStreet>sample string 6</OnStreet>
<PostalCode>sample string 10</PostalCode>
<ProcedureModifier>sample string 16</ProcedureModifier>
<State>sample string 9</State>
<StopCode>sample string 15</StopCode>
<StreetNumber>sample string 5</StreetNumber>
<TimeZoneId>sample string 17</TimeZoneId>
<Unit>sample string 11</Unit>
</Location>
<NegotiatedTime>PT0.1234567S</NegotiatedTime>
<NegotiatedTimeEarly>PT0.1234567S</NegotiatedTimeEarly>
<NegotiatedTimeLate>PT0.1234567S</NegotiatedTimeLate>
<Phone>sample string 2</Phone>
<RequestedTime>PT0.1234567S</RequestedTime>
<RequestedTimeEarly>PT0.1234567S</RequestedTimeEarly>
<RequestedTimeLate>PT0.1234567S</RequestedTimeLate>
<ScheduledTime>PT0.1234567S</ScheduledTime>
<ScheduledTimeEarly>PT0.1234567S</ScheduledTimeEarly>
<ScheduledTimeLate>PT0.1234567S</ScheduledTimeLate>
<ActualTime>PT0.1234567S</ActualTime>
<EstimatedTime>PT0.1234567S</EstimatedTime>
<Status>
<InternalCode>sample string 1</InternalCode>
<Notes>sample string 2</Notes>
<Status>Unscheduled</Status>
</Status>
</Pickup>
<Provider>
<Description>sample string 3</Description>
<Name>sample string 2</Name>
<ProviderId>1</ProviderId>
<ProviderStatus>None</ProviderStatus>
</Provider>
<ServiceTypeId>1</ServiceTypeId>
<SubscriptionId>11</SubscriptionId>
<UserDefinedFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</UserDefinedFields>
<CreationDate>2024-12-23T12:31:06.9230662-07:00</CreationDate>
<FareToCollect>1.1</FareToCollect>
<ModifiedDate>2024-12-23T12:31:06.9230662-07:00</ModifiedDate>
<PassengerFares>
<PassengerFare>
<Fare>2.1</Fare>
<FareTypeId>1</FareTypeId>
<PassengerType>
<Code>sample string 1</Code>
<DefaultSpaceType>sample string 3</DefaultSpaceType>
<FareTypeId>4</FareTypeId>
<Name>sample string 2</Name>
</PassengerType>
<SpaceTypeCode>sample string 1</SpaceTypeCode>
</PassengerFare>
<PassengerFare>
<Fare>2.1</Fare>
<FareTypeId>1</FareTypeId>
<PassengerType>
<Code>sample string 1</Code>
<DefaultSpaceType>sample string 3</DefaultSpaceType>
<FareTypeId>4</FareTypeId>
<Name>sample string 2</Name>
</PassengerType>
<SpaceTypeCode>sample string 1</SpaceTypeCode>
</PassengerFare>
</PassengerFares>
<RunInfo>
<RunName>sample string 1</RunName>
</RunInfo>
<Status>
<InternalCode>sample string 1</InternalCode>
<Notes>sample string 2</Notes>
<Status>Unscheduled</Status>
</Status>
<TripType>Unknown</TripType>
</BookedTrip>