POST api/Dispatch/AssignCourierToTrip
Use this method to assign a courier to a trip
Request Information
URI Parameters
None.
Body Parameters
AssignCourierToTripParmName | Description | Type | Additional information |
---|---|---|---|
auth |
Unique authorization identifier |
string |
Required |
TripID |
The identifier of the trip you want to assign the stop to |
integer |
Required |
CourierID |
The courier to assign to the trip |
integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "TripID": 2, "CourierID": 1 }
application/xml, text/xml
Sample:
<AssignCourierToTripParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <CourierID>1</CourierID> <TripID>2</TripID> <auth>sample string 1</auth> </AssignCourierToTripParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AssignCourierToTripRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Method was successful (true/false) |
boolean |
None. |
ErrorMessage |
If unsuccessful, the error message |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<AssignCourierToTripResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </AssignCourierToTripResp>