UCO API (ver. 2.16)

POST api/v1/Despatch/newDepatchedEmpty

Record a new despatch record for empty ROCs supplied from despatch.

Request Information

URI Parameters

None.

Body Parameters

Serialized JSON string of despatch information

DespatchEmptyFromCRPost

Name	Description	Type	Additional information
rocCollectionRequestIds	RocCollectionRequestIds must be filled when despatching from Collection Requests	Collection of integer	None.
containers		Collection of DespatchEmptyContainer	None.
userid		globally unique identifier	None.
datetimeofdespatch		date	None.
siteid		globally unique identifier	None.
staffid		integer	None.
truckrego		string	None.
comments		string	None.

Request Formats

application/json, text/json

Sample:

{
  "rocCollectionRequestIds": [
    1,
    2
  ],
  "containers": [
    {
      "containertypeid": 1,
      "containernumber": "sample string 2",
      "containerchecked": true,
      "containerstate": "sample string 4"
    },
    {
      "containertypeid": 1,
      "containernumber": "sample string 2",
      "containerchecked": true,
      "containerstate": "sample string 4"
    }
  ],
  "userid": "51df3bcb-9954-4251-936b-7d5a316cb33b",
  "datetimeofdespatch": "2026-10-11T15:40:48.2703494+00:00",
  "siteid": "69161bd2-49cc-46f4-8714-b1b666fe9a17",
  "staffid": 3,
  "truckrego": "sample string 4",
  "comments": "sample string 5"
}

application/xml, text/xml

Sample:

<DespatchEmptyFromCRPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_api.Models">
  <comments>sample string 5</comments>
  <datetimeofdespatch>2026-10-11T15:40:48.2703494+00:00</datetimeofdespatch>
  <siteid>69161bd2-49cc-46f4-8714-b1b666fe9a17</siteid>
  <staffid>3</staffid>
  <truckrego>sample string 4</truckrego>
  <userid>51df3bcb-9954-4251-936b-7d5a316cb33b</userid>
  <containers>
    <DespatchEmptyContainer>
      <containerchecked>true</containerchecked>
      <containernumber>sample string 2</containernumber>
      <containerstate>sample string 4</containerstate>
      <containertypeid>1</containertypeid>
    </DespatchEmptyContainer>
    <DespatchEmptyContainer>
      <containerchecked>true</containerchecked>
      <containernumber>sample string 2</containernumber>
      <containerstate>sample string 4</containerstate>
      <containertypeid>1</containertypeid>
    </DespatchEmptyContainer>
  </containers>
  <rocCollectionRequestIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </rocCollectionRequestIds>
</DespatchEmptyFromCRPost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DespatchedEmptyPostResult

Name	Description	Type	Additional information
despatchid		integer	None.
errormessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "despatchid": 1,
  "errormessage": "sample string 2"
}

application/xml, text/xml

Sample:

<DespatchedEmptyPostResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_api.Models">
  <despatchid>1</despatchid>
  <errormessage>sample string 2</errormessage>
</DespatchedEmptyPostResult>