UCO API (ver. 2.16)

POST api/v1/Despatch/DES_CR_POST_Despatch

Despatch empty ROCs to Neutral Fuels, Customer or Supplier Trucks.

Request Information

URI Parameters

None.

Body Parameters

Despatch record of empty ROCs. When despatching from collection requests, supply a list of Collection Request Ids in 'rocCollectionRequestIds'

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": "d3e6643f-7e2f-484f-a305-9292c8f75dc6",
  "datetimeofdespatch": "2026-08-16T17:18:12.1276811+00:00",
  "siteid": "9034bff6-3a89-476a-9f3d-dc9c32914763",
  "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-08-16T17:18:12.1276811+00:00</datetimeofdespatch>
  <siteid>9034bff6-3a89-476a-9f3d-dc9c32914763</siteid>
  <staffid>3</staffid>
  <truckrego>sample string 4</truckrego>
  <userid>d3e6643f-7e2f-484f-a305-9292c8f75dc6</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

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.