UCO API (ver. 2.16)

GET api/v1/Despatch/DespatchedEmpty?despatchid={despatchid}

Query empty ROCs supplied during a depatch operation.

Request Information

URI Parameters

Name	Description	Type	Additional information
despatchid		integer	Required

Body Parameters

None.

Response Information

Resource Description

DespatchEmptyGet

Name	Type	Additional information
despatchid	integer	None.
containers	Collection of DespatchEmptyContainerGet	None.
userid	globally unique identifier	None.
datetimeofdespatch	date	None.
siteid	globally unique identifier	None.
staffid	integer	None.
truckrego	string	None.
comments	string	None.

Response Formats

application/json, text/json

Sample:

{
  "despatchid": 1,
  "containers": [
    {
      "containerdetailid": 1,
      "containertypename": "sample string 2",
      "containertypeid": 3,
      "containernumber": "sample string 4",
      "containerchecked": true,
      "containerstate": "sample string 6"
    },
    {
      "containerdetailid": 1,
      "containertypename": "sample string 2",
      "containertypeid": 3,
      "containernumber": "sample string 4",
      "containerchecked": true,
      "containerstate": "sample string 6"
    }
  ],
  "userid": "4de7c5f1-8abe-4ebc-b6e4-0c5840c6c5dc",
  "datetimeofdespatch": "2026-08-16T17:16:12.9760871+00:00",
  "siteid": "37e58bd6-0646-4854-b210-22de8b5fbff8",
  "staffid": 4,
  "truckrego": "sample string 5",
  "comments": "sample string 6"
}

application/xml, text/xml

Sample:

<DespatchEmptyGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_api.Models">
  <comments>sample string 6</comments>
  <datetimeofdespatch>2026-08-16T17:16:12.9760871+00:00</datetimeofdespatch>
  <siteid>37e58bd6-0646-4854-b210-22de8b5fbff8</siteid>
  <staffid>4</staffid>
  <truckrego>sample string 5</truckrego>
  <userid>4de7c5f1-8abe-4ebc-b6e4-0c5840c6c5dc</userid>
  <containers>
    <DespatchEmptyContainerGet>
      <containerchecked>true</containerchecked>
      <containernumber>sample string 4</containernumber>
      <containerstate>sample string 6</containerstate>
      <containertypeid>3</containertypeid>
      <containerdetailid>1</containerdetailid>
      <containertypename>sample string 2</containertypename>
    </DespatchEmptyContainerGet>
    <DespatchEmptyContainerGet>
      <containerchecked>true</containerchecked>
      <containernumber>sample string 4</containernumber>
      <containerstate>sample string 6</containerstate>
      <containertypeid>3</containertypeid>
      <containerdetailid>1</containerdetailid>
      <containertypename>sample string 2</containertypename>
    </DespatchEmptyContainerGet>
  </containers>
  <despatchid>1</despatchid>
</DespatchEmptyGet>