POST api/MobileDispatching/GetDispatches

Request Information

URI Parameters

None.

Body Parameters

MobileRequestModel
NameDescriptionTypeAdditional information
AppUserId

integer

None.

DeviceName

string

None.

Parameters

Collection of MobileRequestParameter

None.

ListParameters

Collection of MobileRequestListParameter

None.

Parameters

Object

None.

Request Formats

application/json, text/json

Sample:
{
  "_AppUserId": 1,
  "_DeviceName": "sample string 2",
  "_Parameters": [
    {
      "_Key": "sample string 1",
      "_Value": {}
    },
    {
      "_Key": "sample string 1",
      "_Value": {}
    }
  ],
  "_ListParameters": [
    {
      "_Key": "sample string 1",
      "_Value": [
        {},
        {}
      ]
    },
    {
      "_Key": "sample string 1",
      "_Value": [
        {},
        {}
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<MobileRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreshPackMultiProduce.BusinessObjects">
  <_AppUserId>1</_AppUserId>
  <_DeviceName>sample string 2</_DeviceName>
  <_ListParameters>
    <MobileRequestListParameter>
      <_Key>sample string 1</_Key>
      <_Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </_Value>
    </MobileRequestListParameter>
    <MobileRequestListParameter>
      <_Key>sample string 1</_Key>
      <_Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </_Value>
    </MobileRequestListParameter>
  </_ListParameters>
  <_Parameters>
    <MobileRequestParameter>
      <_Key>sample string 1</_Key>
      <_Value />
    </MobileRequestParameter>
    <MobileRequestParameter>
      <_Key>sample string 1</_Key>
      <_Value />
    </MobileRequestParameter>
  </_Parameters>
</MobileRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MobileRequestModel'.

Response Information

Resource Description

Collection of MobileDispatchModel
NameDescriptionTypeAdditional information
Id

integer

None.

OrderID

integer

None.

Reference

string

None.

PurchaseOrder

string

None.

Customer

string

None.

OrderTypeID

integer

None.

CareOf

string

None.

DispatchDate

date

None.

ETADate

date

None.

Destination

string

None.

Facility

string

None.

SourceFacility

string

None.

UseAllocation

boolean

None.

UseOrderProducts

boolean

None.

DispatchLocation

string

None.

DispatchLocationBarcode

string

None.

OrderComment

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "OrderID": 2,
    "Reference": "sample string 3",
    "PurchaseOrder": "sample string 4",
    "Customer": "sample string 5",
    "OrderTypeID": 6,
    "CareOf": "sample string 7",
    "DispatchDate": "2025-12-06T14:33:56.0360824+10:30",
    "ETADate": "2025-12-06T14:33:56.0360824+10:30",
    "Destination": "sample string 10",
    "Facility": "sample string 11",
    "SourceFacility": "sample string 12",
    "UseAllocation": true,
    "UseOrderProducts": true,
    "DispatchLocation": "sample string 15",
    "DispatchLocationBarcode": "sample string 16",
    "OrderComment": "sample string 17"
  },
  {
    "Id": 1,
    "OrderID": 2,
    "Reference": "sample string 3",
    "PurchaseOrder": "sample string 4",
    "Customer": "sample string 5",
    "OrderTypeID": 6,
    "CareOf": "sample string 7",
    "DispatchDate": "2025-12-06T14:33:56.0360824+10:30",
    "ETADate": "2025-12-06T14:33:56.0360824+10:30",
    "Destination": "sample string 10",
    "Facility": "sample string 11",
    "SourceFacility": "sample string 12",
    "UseAllocation": true,
    "UseOrderProducts": true,
    "DispatchLocation": "sample string 15",
    "DispatchLocationBarcode": "sample string 16",
    "OrderComment": "sample string 17"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMobileDispatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreshPackMultiProduce.BusinessObjects">
  <MobileDispatchModel>
    <CareOf>sample string 7</CareOf>
    <Customer>sample string 5</Customer>
    <Destination>sample string 10</Destination>
    <DispatchDate>2025-12-06T14:33:56.0360824+10:30</DispatchDate>
    <DispatchLocation>sample string 15</DispatchLocation>
    <DispatchLocationBarcode>sample string 16</DispatchLocationBarcode>
    <ETADate>2025-12-06T14:33:56.0360824+10:30</ETADate>
    <Facility>sample string 11</Facility>
    <Id>1</Id>
    <OrderComment>sample string 17</OrderComment>
    <OrderID>2</OrderID>
    <OrderTypeID>6</OrderTypeID>
    <PurchaseOrder>sample string 4</PurchaseOrder>
    <Reference>sample string 3</Reference>
    <SourceFacility>sample string 12</SourceFacility>
    <UseAllocation>true</UseAllocation>
    <UseOrderProducts>true</UseOrderProducts>
  </MobileDispatchModel>
  <MobileDispatchModel>
    <CareOf>sample string 7</CareOf>
    <Customer>sample string 5</Customer>
    <Destination>sample string 10</Destination>
    <DispatchDate>2025-12-06T14:33:56.0360824+10:30</DispatchDate>
    <DispatchLocation>sample string 15</DispatchLocation>
    <DispatchLocationBarcode>sample string 16</DispatchLocationBarcode>
    <ETADate>2025-12-06T14:33:56.0360824+10:30</ETADate>
    <Facility>sample string 11</Facility>
    <Id>1</Id>
    <OrderComment>sample string 17</OrderComment>
    <OrderID>2</OrderID>
    <OrderTypeID>6</OrderTypeID>
    <PurchaseOrder>sample string 4</PurchaseOrder>
    <Reference>sample string 3</Reference>
    <SourceFacility>sample string 12</SourceFacility>
    <UseAllocation>true</UseAllocation>
    <UseOrderProducts>true</UseOrderProducts>
  </MobileDispatchModel>
</ArrayOfMobileDispatchModel>