POST api/Dispatch/TripTemplate/Add
Use this method to add a new trip template
Request Information
URI Parameters
None.
Body Parameters
AddTripTemplateParmName | Description | Type | Additional information |
---|---|---|---|
auth |
User authorization identifier |
string |
None. |
OfficeID |
Office identifier (if blank will default to users office) |
integer |
None. |
Name |
Name of the trip template |
string |
None. |
Instructions |
Instructions for courier related to trip template |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "OfficeID": 1, "Name": "sample string 2", "Instructions": "sample string 3" }
application/xml, text/xml
Sample:
<AddTripTemplateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <Instructions>sample string 3</Instructions> <Name>sample string 2</Name> <OfficeID>1</OfficeID> <auth>sample string 1</auth> </AddTripTemplateParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Set to true if method was successful |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ResponseBase 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> </ResponseBase>