POST api/clients/{clientId}/solutionsets
Tries to find solutions for scheduling one or more trips.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
The ID of the client whose trips are being scheduled. |
integer |
Required |
Body Parameters
The IDs of the bookings to schedule.
Collection of integerRequest Formats
application/json, text/json
Sample:
[ 1, 2 ]
application/xml, text/xml
Sample:
<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>1</int> <int>2</int> </ArrayOfint>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the list of scheduling solutions for the trip(s). May return more than one if the schedule server cannot generate an itinerary solution for all bookings.
ScheduleSolutionSetName | Description | Type | Additional information |
---|---|---|---|
ID |
Gets the ID of the solution set. |
integer |
None. |
ItinerarySolutions |
Gets the list of solutions that can be selected. |
Collection of ScheduleItinerarySolution |
None. |
Response Formats
application/json, text/json
Sample:
{ "id": 1, "itinerarySolutions": [ { "solutionNumber": 1, "scheduleId": 2, "tripSolutions": [ { "tripId": 1, "pickupTime": "00:00:00.1234567", "dropoffTime": "00:00:00.1234567", "scheduledPickupTime": "00:00:00.1234567", "scheduledDropoffTime": "00:00:00.1234567", "scheduledDropoffEarly": "00:00:00.1234567", "scheduledDropoffLate": "00:00:00.1234567", "scheduledPickupEarly": "00:00:00.1234567", "scheduledPickupLate": "00:00:00.1234567", "transportMode": 0, "runName": "sample string 4" }, { "tripId": 1, "pickupTime": "00:00:00.1234567", "dropoffTime": "00:00:00.1234567", "scheduledPickupTime": "00:00:00.1234567", "scheduledDropoffTime": "00:00:00.1234567", "scheduledDropoffEarly": "00:00:00.1234567", "scheduledDropoffLate": "00:00:00.1234567", "scheduledPickupEarly": "00:00:00.1234567", "scheduledPickupLate": "00:00:00.1234567", "transportMode": 0, "runName": "sample string 4" } ] }, { "solutionNumber": 1, "scheduleId": 2, "tripSolutions": [ { "tripId": 1, "pickupTime": "00:00:00.1234567", "dropoffTime": "00:00:00.1234567", "scheduledPickupTime": "00:00:00.1234567", "scheduledDropoffTime": "00:00:00.1234567", "scheduledDropoffEarly": "00:00:00.1234567", "scheduledDropoffLate": "00:00:00.1234567", "scheduledPickupEarly": "00:00:00.1234567", "scheduledPickupLate": "00:00:00.1234567", "transportMode": 0, "runName": "sample string 4" }, { "tripId": 1, "pickupTime": "00:00:00.1234567", "dropoffTime": "00:00:00.1234567", "scheduledPickupTime": "00:00:00.1234567", "scheduledDropoffTime": "00:00:00.1234567", "scheduledDropoffEarly": "00:00:00.1234567", "scheduledDropoffLate": "00:00:00.1234567", "scheduledPickupEarly": "00:00:00.1234567", "scheduledPickupLate": "00:00:00.1234567", "transportMode": 0, "runName": "sample string 4" } ] } ] }
application/xml, text/xml
Sample:
<ScheduleSolutionSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources" />