POST api/VehicleSchedules/PassengerStop

Add passenger collect and drop-offs at a stop

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
VehicleScheduleId	TMS Vehicle Schedule ID	integer	Required
DriverCode	TMS Driver Code - GUID	string	None.
StopTimeStampUTC	Date and time collection and/or drop-off occurred at stop	date	Required
LocationID	TMS Location ID	integer	Required
Latitude	Latitude at stop	decimal number	None.
Longitude	Longitude at stop	decimal number	None.
CollectedPassengers	Passengers collected at stop	Collection of PickupPassengerDTO	None.
DropOffPassengers	Passengers dropped-off at stop	Collection of DropOffPassengerDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "VehicleScheduleId": 1,
  "DriverCode": "sample string 2",
  "StopTimeStampUTC": "2025-12-11T05:27:57.8493329+02:00",
  "LocationID": 4,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "CollectedPassengers": [
    {
      "OrderPassengerId": 1,
      "IsCollected": true,
      "CollectionComments": "sample string 3"
    },
    {
      "OrderPassengerId": 1,
      "IsCollected": true,
      "CollectionComments": "sample string 3"
    }
  ],
  "DropOffPassengers": [
    {
      "OrderPassengerId": 1,
      "IsDroppedOff": true
    },
    {
      "OrderPassengerId": 1,
      "IsDroppedOff": true
    }
  ]
}

application/xml, text/xml

Sample:

<PassengerStopDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMS.Models">
  <CollectedPassengers>
    <PickupPassengerDTO>
      <CollectionComments>sample string 3</CollectionComments>
      <IsCollected>true</IsCollected>
      <OrderPassengerId>1</OrderPassengerId>
    </PickupPassengerDTO>
    <PickupPassengerDTO>
      <CollectionComments>sample string 3</CollectionComments>
      <IsCollected>true</IsCollected>
      <OrderPassengerId>1</OrderPassengerId>
    </PickupPassengerDTO>
  </CollectedPassengers>
  <DriverCode>sample string 2</DriverCode>
  <DropOffPassengers>
    <DropOffPassengerDTO>
      <IsDroppedOff>true</IsDroppedOff>
      <OrderPassengerId>1</OrderPassengerId>
    </DropOffPassengerDTO>
    <DropOffPassengerDTO>
      <IsDroppedOff>true</IsDroppedOff>
      <OrderPassengerId>1</OrderPassengerId>
    </DropOffPassengerDTO>
  </DropOffPassengers>
  <Latitude>1.1</Latitude>
  <LocationID>4</LocationID>
  <Longitude>1.1</Longitude>
  <StopTimeStampUTC>2025-12-11T05:27:57.8493329+02:00</StopTimeStampUTC>
  <VehicleScheduleId>1</VehicleScheduleId>
</PassengerStopDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PassengerStopDTO'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.