GET api/clients/{clientID}/recenttrips?bookingsCount={bookingsCount}&additionalPassengerMode={additionalPassengerMode}
Gets the list of trips that a client has recently created or completed.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
The ID of the client to get trips for |
integer |
Required |
bookingsCount |
Number of bookings required. |
integer |
Default value is 5 |
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 the list of recent trip itineraries.
Collection of BookedTripItineraryName | Description | Type | Additional information |
---|---|---|---|
Trips | Collection of BookedTrip |
None. |
|
ContainsReturnTrip | boolean |
None. |
|
Count | integer |
None. |
|
Item | BookedTrip |
None. |
Response Formats
application/json, text/json
Sample:
[ { "trips": [ { "tripType": 0, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "creationDate": "2024-12-23T11:50:51.5312628-07:00", "modifiedDate": "2024-12-23T11:50:51.5312628-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 }, { "tripType": 0, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "creationDate": "2024-12-23T11:50:51.5312628-07:00", "modifiedDate": "2024-12-23T11:50:51.5312628-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 } ], "containsReturnTrip": true, "count": 2 }, { "trips": [ { "tripType": 0, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "creationDate": "2024-12-23T11:50:51.5312628-07:00", "modifiedDate": "2024-12-23T11:50:51.5312628-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 }, { "tripType": 0, "status": { "status": 0, "internalCode": "sample string 1", "notes": "sample string 2" }, "creationDate": "2024-12-23T11:50:51.5312628-07:00", "modifiedDate": "2024-12-23T11:50:51.5312628-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 } ], "containsReturnTrip": true, "count": 2 } ]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.