POST api/event/{eventId}/performPickup?clientId={clientId}&scheduleId={scheduleId}
Perform a pick up 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 time when the event is performed in a TimeSpan
time intervalRequest Formats
application/json, text/json
Sample:
"00:00:00.1234567"
application/xml, text/xml
Sample:
<duration xmlns="http://schemas.microsoft.com/2003/10/Serialization/">PT0.1234567S</duration>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The PerformEventResult object if the pickup was performed
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.