POST api/Dispatch/GetUnassignedStops

Get the list of unassigned stops (pickup or delivery) (with filter parameters) (only deliveries or inbound shipments are provided at this point)

Request Information

URI Parameters

None.

Body Parameters

GetUnassignedStopsParm

Name	Description	Type	Additional information
auth	Unique authorization identifier	string	None.
RouteCode	Filter only orders destinated for this routing code	string	None.
Status	Filter only orders on or after this status # 210 = After pickup 270 = After departure 280 = After arrival 300 = After recovery	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "RouteCode": "sample string 2",
  "Status": 1
}

application/xml, text/xml

Sample:

<GetUnassignedStopsParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <RouteCode>sample string 2</RouteCode>
  <Status>1</Status>
  <auth>sample string 1</auth>
</GetUnassignedStopsParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetUnassignedStopsResp

Name	Description	Type	Additional information
IsSuccessful	Method was successful (true/false)	boolean	None.
ErrorMessage	If unsuccessful, the error message	string	None.
Items	The list of unassigned pickups and deliveries for your service area	Collection of DispatchItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Items": null
}

application/xml, text/xml

Sample:

<GetUnassignedStopsResp 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>
  <Items i:nil="true" />
</GetUnassignedStopsResp>