GET api/Mobile/SelectOutForDelivery/{UserGUID}/{EntityGUID}

Retrieve information for Out for Delivery Task (OUTFORDEL)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserGUID

Unique user global identifier

 string

Required
EntityGUID

Identifier of the entity that is related to the task

 string

Required

Body Parameters

None.

Response Information

Resource Description

TaskOutForDeliveryItem
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ErrorMessage

string

None.
EntityGUID

Shipment global identifier

 string

Required
ShipmentNumber

System assigned unique number for shipment

 integer

Required
Instructions

Special instructions at delivery

 string

None.
CourierServiceID

System assigned courier service ID

 integer

None.
CourierPhoneNumber

Courier phone number

 string

None.
CourierEmailAddress

Courier email address

 string

None.
SpokeWith

Person at courier company that confirmed the alert

 string

None.
DeliveryAddress

The complete delivery address for display in mobile app

 string

None.
DspDeliveryDateTime

The formatted estimated delivery date/time

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "EntityGUID": "sample string 3",
  "ShipmentNumber": 4,
  "Instructions": "sample string 5",
  "CourierServiceID": 1,
  "CourierPhoneNumber": "sample string 6",
  "CourierEmailAddress": "sample string 7",
  "SpokeWith": "sample string 8",
  "DeliveryAddress": "sample string 9",
  "DspDeliveryDateTime": "sample string 10"
}

application/xml, text/xml

Sample: 
<TaskOutForDeliveryItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile">
  <CourierEmailAddress>sample string 7</CourierEmailAddress>
  <CourierPhoneNumber>sample string 6</CourierPhoneNumber>
  <CourierServiceID>1</CourierServiceID>
  <DeliveryAddress>sample string 9</DeliveryAddress>
  <DspDeliveryDateTime>sample string 10</DspDeliveryDateTime>
  <EntityGUID>sample string 3</EntityGUID>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Instructions>sample string 5</Instructions>
  <IsSuccessful>true</IsSuccessful>
  <ShipmentNumber>4</ShipmentNumber>
  <SpokeWith>sample string 8</SpokeWith>
</TaskOutForDeliveryItem>