POST api/Dispatch/UpdateTrip

Use this method to update a trip

Request Information

URI Parameters

None.

Body Parameters

UpdateTripParm
NameDescriptionTypeAdditional information
auth

Unique authorization identifier

string

Required

Max length: 36

TripID

The Trip ID to update

integer

Required

Name

The Name of the trip

string

Required

Max length: 30

Instructions

Special instructions for the courier related to the trip

string

Max length: 500

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "TripID": 2,
  "Name": "sample string 3",
  "Instructions": "sample string 4"
}

application/xml, text/xml

Sample:
<UpdateTripParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <Instructions>sample string 4</Instructions>
  <Name>sample string 3</Name>
  <TripID>2</TripID>
  <auth>sample string 1</auth>
</UpdateTripParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional 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>