UCO API (ver. 2.16)

POST api/v1/Despatch/DES_POST_AdhocDespatch

Despatch empty ROCs to customer or supplier truck

Request Information

URI Parameters

None.

Body Parameters

Ad-hoc despatch record of empty ROCs. Assuming no collection request, entity id and entity type name needs to be specified.

DespatchEmptyAdhocPost

Name	Type	Additional information
entityid	globally unique identifier	None.
entitytypename	string	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:

{
  "entityid": "da307170-8a53-4fbd-9553-b6e3495784e1",
  "entitytypename": "sample string 1",
  "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": "62ecd04e-dfdc-4180-8080-17a77df7567a",
  "datetimeofdespatch": "2026-08-16T17:17:50.7257021+00:00",
  "siteid": "0b83fdfe-f25b-48e0-a886-fa663fdc3e84",
  "staffid": 4,
  "truckrego": "sample string 5",
  "comments": "sample string 6"
}

application/xml, text/xml

Sample:

<DespatchEmptyAdhocPost 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:17:50.7257021+00:00</datetimeofdespatch>
  <siteid>0b83fdfe-f25b-48e0-a886-fa663fdc3e84</siteid>
  <staffid>4</staffid>
  <truckrego>sample string 5</truckrego>
  <userid>62ecd04e-dfdc-4180-8080-17a77df7567a</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>
  <entityid>da307170-8a53-4fbd-9553-b6e3495784e1</entityid>
  <entitytypename>sample string 1</entitytypename>
</DespatchEmptyAdhocPost>

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.