POST api/event/{eventId}/performDropoff?clientId={clientId}&scheduleId={scheduleId}
Perform a drop off event.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
The id of the client whose events will be performed |
integer |
Required |
scheduleId |
The schedule Id for identifying the event to perform with event Id |
integer |
Required |
eventId |
The event Id for identifying the event to perform with schedule Id |
integer |
Required |
Body Parameters
The data for a drop off event: date and time, latitude, longitude, and trip id
PerformDropoffRequestName | Description | Type | Additional information |
---|---|---|---|
DateTime |
The date and time when the event is performed |
date |
None. |
Longitude |
The longitude of the event |
decimal number |
None. |
Latitude |
The latitude of the event |
decimal number |
None. |
TripId |
The id of the trip that the event associated with |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "dateTime": "2025-07-16T00:11:36.1421223-06:00", "longitude": 2.1, "latitude": 3.1, "tripId": "sample string 4" }
application/xml, text/xml
Sample:
<PerformDropoffRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <DateTime>2025-07-16T00:11:36.1421223-06:00</DateTime> <Latitude>3.1</Latitude> <Longitude>2.1</Longitude> <TripId>sample string 4</TripId> </PerformDropoffRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The PerformEventResult object if the dropoff was performed
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.