POST api/Dispatch?companyCode={companyCode}

Get Dispatches

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

Company Identifier

string

Required

Body Parameters

List of dispatches

Collection of string

Request Formats

application/json, text/json

Sample:
[
  "string 1",
  "string 2"
]

application/xml, text/xml

Sample:
<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <string>string 1</string>
  <string>string 2</string>
</ArrayOfString>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response message with requested dispatches.

GetDispatchMessageResponse
NameDescriptionTypeAdditional information
Header

MessageHeader

None.

Dispatches

Collection of DispatchResponse

None.

Footer

MessageFooter

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "Dispatches": [
    {
      "DispatchType": "Inbound",
      "WarehouseIdentifier": "string 1",
      "PlannedStation": "string 2",
      "DispatchIdentifier": "string 3",
      "RideNumber": "string 4",
      "CarNumber": "string 5",
      "DriverNumber": "string 6",
      "DispatchTime": "2025-12-06T03:59:23.2323498+01:00",
      "DispatchTimeSpecified": true
    },
    {
      "DispatchType": "Inbound",
      "WarehouseIdentifier": "string 1",
      "PlannedStation": "string 2",
      "DispatchIdentifier": "string 3",
      "RideNumber": "string 4",
      "CarNumber": "string 5",
      "DriverNumber": "string 6",
      "DispatchTime": "2025-12-06T03:59:23.2323498+01:00",
      "DispatchTimeSpecified": true
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:
<GetDispatchMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <Dispatches>
    <DispatchResponse>
      <DispatchIdentifier>string 3</DispatchIdentifier>
      <RideNumber>string 4</RideNumber>
      <CarNumber>string 5</CarNumber>
      <DriverNumber>string 6</DriverNumber>
      <DispatchTime>2025-12-06T03:59:23.2323498+01:00</DispatchTime>
      <DispatchTimeSpecified>true</DispatchTimeSpecified>
      <DispatchType>Inbound</DispatchType>
      <WarehouseIdentifier>string 1</WarehouseIdentifier>
      <PlannedStation>string 2</PlannedStation>
    </DispatchResponse>
    <DispatchResponse>
      <DispatchIdentifier>string 3</DispatchIdentifier>
      <RideNumber>string 4</RideNumber>
      <CarNumber>string 5</CarNumber>
      <DriverNumber>string 6</DriverNumber>
      <DispatchTime>2025-12-06T03:59:23.2323498+01:00</DispatchTime>
      <DispatchTimeSpecified>true</DispatchTimeSpecified>
      <DispatchType>Inbound</DispatchType>
      <WarehouseIdentifier>string 1</WarehouseIdentifier>
      <PlannedStation>string 2</PlannedStation>
    </DispatchResponse>
  </Dispatches>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetDispatchMessageResponse>