POST api/Dispatch/AddStopToTrip

Add stop (pickup or delivery) to trip

Request Information

URI Parameters

None.

Body Parameters

Name	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
Sequence	The sequence number of the stop (legacy, not used, see PreviousTripDetailID field)	integer	Required
EntityType	The type of entity P=pickup, D=delivery (from GetUnassignedStops method)	string	Required
EntityGUID	The unique identifier of the entity (from GetUnassignedStops method)	string	Required
NextTripDetailID	When specified, the new stop will be added before the stop identified by this field, otherwise the trip will be added to the end	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "TripID": 2,
  "Sequence": 3,
  "EntityType": "sample string 4",
  "EntityGUID": "sample string 5",
  "NextTripDetailID": 1
}

application/xml, text/xml

Sample:

<AddStopToTripParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <EntityGUID>sample string 5</EntityGUID>
  <EntityType>sample string 4</EntityType>
  <NextTripDetailID>1</NextTripDetailID>
  <Sequence>3</Sequence>
  <TripID>2</TripID>
  <auth>sample string 1</auth>
</AddStopToTripParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddStopToTripResp

Name	Description	Type	Additional information
IsSuccessful	Method was successful (true/false)	boolean	None.
ErrorMessage	If unsuccessful, the error message	string	None.
TripDetailID	If successful, this is the new TripDetailID that was created	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "TripDetailID": 1
}

application/xml, text/xml

Sample:

<AddStopToTripResp 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>
  <TripDetailID>1</TripDetailID>
</AddStopToTripResp>