GET api/Mobile/GetTaskList/{UserGUID}/{LocationData}

Get Task List

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserGUID

string

Required

LocationData

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of TaskItem
NameDescriptionTypeAdditional information
EntityGUID

Unique identifier of this entity (shipment)

string

None.

EntityType

Entity type (SH=shipment, PU=pickup, MN=manifest)

string

None.

TaskType

Used to identify what type of task should be performed

string

None.

DisplayHeader

The header information to display to the user

string

None.

DisplayDateTime

The formated date/time to display to the user

string

None.

DisplayLocation

The location of the task to display to the user

string

None.

OrderNumber

The order number in the system affected by the task

string

None.

IsRed

If set, then the task should appear in red (it is late)

string

None.

SearchKeys

Comma separated list of search keys for this task

string

None.

CustomerID

The primary customer ID associated with this task

integer

None.

AccountNumber

The primary account number associated with this task

string

None.

ShowLabScan

Show Lab scan

boolean

None.

ShowKitScan

Show Kit scan

boolean

None.

TaskName

string

None.

TaskDueDateTimeIsNull

boolean

None.

TaskDueDateTime

date

None.

TaskError

string

None.

DueDateTimeDisplay

string

None.

DueDateTimeColor

string

None.

PickupFrom

string

None.

DeliverTo

string

None.

Instructions

string

None.

OfficePhoneNumber

string

None.

TaskLocation

string

None.

TaskLocationOther

string

None.

DisplayTracking

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EntityGUID": "sample string 1",
    "EntityType": "sample string 2",
    "TaskType": "sample string 3",
    "DisplayHeader": "sample string 4",
    "DisplayDateTime": "sample string 5",
    "DisplayLocation": "sample string 6",
    "OrderNumber": "sample string 7",
    "IsRed": "sample string 8",
    "SearchKeys": "sample string 9",
    "CustomerID": 10,
    "AccountNumber": "sample string 11",
    "ShowLabScan": true,
    "ShowKitScan": true,
    "TaskName": "sample string 14",
    "TaskDueDateTimeIsNull": true,
    "TaskDueDateTime": "2024-09-21T08:11:39.9917013-07:00",
    "TaskError": "sample string 17",
    "DueDateTimeDisplay": "sample string 18",
    "DueDateTimeColor": "sample string 19",
    "PickupFrom": "sample string 20",
    "DeliverTo": "sample string 21",
    "Instructions": "sample string 22",
    "OfficePhoneNumber": "sample string 23",
    "TaskLocation": "",
    "TaskLocationOther": "",
    "DisplayTracking": "sample string 7"
  },
  {
    "EntityGUID": "sample string 1",
    "EntityType": "sample string 2",
    "TaskType": "sample string 3",
    "DisplayHeader": "sample string 4",
    "DisplayDateTime": "sample string 5",
    "DisplayLocation": "sample string 6",
    "OrderNumber": "sample string 7",
    "IsRed": "sample string 8",
    "SearchKeys": "sample string 9",
    "CustomerID": 10,
    "AccountNumber": "sample string 11",
    "ShowLabScan": true,
    "ShowKitScan": true,
    "TaskName": "sample string 14",
    "TaskDueDateTimeIsNull": true,
    "TaskDueDateTime": "2024-09-21T08:11:39.9917013-07:00",
    "TaskError": "sample string 17",
    "DueDateTimeDisplay": "sample string 18",
    "DueDateTimeColor": "sample string 19",
    "PickupFrom": "sample string 20",
    "DeliverTo": "sample string 21",
    "Instructions": "sample string 22",
    "OfficePhoneNumber": "sample string 23",
    "TaskLocation": "",
    "TaskLocationOther": "",
    "DisplayTracking": "sample string 7"
  }
]

application/xml, text/xml

Sample:
<ArrayOfTaskItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile">
  <TaskItem>
    <AccountNumber>sample string 11</AccountNumber>
    <CustomerID>10</CustomerID>
    <DeliverTo>sample string 21</DeliverTo>
    <DisplayDateTime>sample string 5</DisplayDateTime>
    <DisplayHeader>sample string 4</DisplayHeader>
    <DisplayLocation>sample string 6</DisplayLocation>
    <DisplayTracking>sample string 7</DisplayTracking>
    <DueDateTimeColor>sample string 19</DueDateTimeColor>
    <DueDateTimeDisplay>sample string 18</DueDateTimeDisplay>
    <EntityGUID>sample string 1</EntityGUID>
    <EntityType>sample string 2</EntityType>
    <Instructions>sample string 22</Instructions>
    <IsRed>sample string 8</IsRed>
    <OfficePhoneNumber>sample string 23</OfficePhoneNumber>
    <OrderNumber>sample string 7</OrderNumber>
    <PickupFrom>sample string 20</PickupFrom>
    <SearchKeys>sample string 9</SearchKeys>
    <ShowKitScan>true</ShowKitScan>
    <ShowLabScan>true</ShowLabScan>
    <TaskDueDateTime>2024-09-21T08:11:39.9917013-07:00</TaskDueDateTime>
    <TaskDueDateTimeIsNull>true</TaskDueDateTimeIsNull>
    <TaskError>sample string 17</TaskError>
    <TaskLocation></TaskLocation>
    <TaskLocationOther></TaskLocationOther>
    <TaskName>sample string 14</TaskName>
    <TaskType>sample string 3</TaskType>
  </TaskItem>
  <TaskItem>
    <AccountNumber>sample string 11</AccountNumber>
    <CustomerID>10</CustomerID>
    <DeliverTo>sample string 21</DeliverTo>
    <DisplayDateTime>sample string 5</DisplayDateTime>
    <DisplayHeader>sample string 4</DisplayHeader>
    <DisplayLocation>sample string 6</DisplayLocation>
    <DisplayTracking>sample string 7</DisplayTracking>
    <DueDateTimeColor>sample string 19</DueDateTimeColor>
    <DueDateTimeDisplay>sample string 18</DueDateTimeDisplay>
    <EntityGUID>sample string 1</EntityGUID>
    <EntityType>sample string 2</EntityType>
    <Instructions>sample string 22</Instructions>
    <IsRed>sample string 8</IsRed>
    <OfficePhoneNumber>sample string 23</OfficePhoneNumber>
    <OrderNumber>sample string 7</OrderNumber>
    <PickupFrom>sample string 20</PickupFrom>
    <SearchKeys>sample string 9</SearchKeys>
    <ShowKitScan>true</ShowKitScan>
    <ShowLabScan>true</ShowLabScan>
    <TaskDueDateTime>2024-09-21T08:11:39.9917013-07:00</TaskDueDateTime>
    <TaskDueDateTimeIsNull>true</TaskDueDateTimeIsNull>
    <TaskError>sample string 17</TaskError>
    <TaskLocation></TaskLocation>
    <TaskLocationOther></TaskLocationOther>
    <TaskName>sample string 14</TaskName>
    <TaskType>sample string 3</TaskType>
  </TaskItem>
</ArrayOfTaskItem>