UCO API (ver. 2.16)

POST api/v1/Collection/COL_POST_NewReceiptsCollection

New ROC Collection Record when collecting from Store or Customer

Request Information

URI Parameters

None.

Body Parameters

Serialized JSON string of collection information. When collecting from store, entityid is storeid. When collecting from customer, entityid is customerid.

UCOCollectionPost

Name	Type	Additional information
isadhoctruck	boolean	None.
purchaseordernumber	string	None.
comments	string	None.
entityid	globally unique identifier	None.
locationid	integer	None.
supervisorid	integer	None.
supervisorname	string	None.
datetimeofcollection	date	None.
ucoreceiptnumber	string	None.
truckrego	string	None.
latitude	decimal number	None.
longitude	decimal number	None.
image	string	None.
verifycode	string	None.
containers	Collection of UCOContainer	None.
emptycontainers	Collection of UCOEmptyContainer	None.
collectionrequestids	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "collectionrequestids": [
    1,
    1
  ],
  "isadhoctruck": true,
  "purchaseordernumber": "sample string 1",
  "comments": "sample string 2",
  "entityid": "8d0bfe06-99e5-461b-9567-777592e26925",
  "locationid": 1,
  "supervisorid": 4,
  "supervisorname": "sample string 5",
  "datetimeofcollection": "2026-08-16T17:17:36.4187351+00:00",
  "ucoreceiptnumber": "sample string 6",
  "truckrego": "sample string 7",
  "latitude": 1.0,
  "longitude": 1.0,
  "image": "sample string 8",
  "verifycode": "sample string 9",
  "containers": [
    {
      "quantity": 1.0,
      "containertypeid": 2,
      "state": "sample string 3",
      "containernumber": "sample string 4"
    },
    {
      "quantity": 1.0,
      "containertypeid": 2,
      "state": "sample string 3",
      "containernumber": "sample string 4"
    }
  ],
  "emptycontainers": [
    {
      "state": "sample string 1",
      "containernumber": "sample string 2"
    },
    {
      "state": "sample string 1",
      "containernumber": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<UCOCollectionPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Collection">
  <collectionrequestids xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </collectionrequestids>
  <containers xmlns:d2p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
    <d2p1:UCOContainer>
      <d2p1:containernumber>sample string 4</d2p1:containernumber>
      <d2p1:state>sample string 3</d2p1:state>
      <d2p1:containertypeid>2</d2p1:containertypeid>
      <d2p1:quantity>1</d2p1:quantity>
    </d2p1:UCOContainer>
    <d2p1:UCOContainer>
      <d2p1:containernumber>sample string 4</d2p1:containernumber>
      <d2p1:state>sample string 3</d2p1:state>
      <d2p1:containertypeid>2</d2p1:containertypeid>
      <d2p1:quantity>1</d2p1:quantity>
    </d2p1:UCOContainer>
  </containers>
  <datetimeofcollection>2026-08-16T17:17:36.4187351+00:00</datetimeofcollection>
  <emptycontainers xmlns:d2p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
    <d2p1:UCOEmptyContainer>
      <d2p1:containernumber>sample string 2</d2p1:containernumber>
      <d2p1:state>sample string 1</d2p1:state>
    </d2p1:UCOEmptyContainer>
    <d2p1:UCOEmptyContainer>
      <d2p1:containernumber>sample string 2</d2p1:containernumber>
      <d2p1:state>sample string 1</d2p1:state>
    </d2p1:UCOEmptyContainer>
  </emptycontainers>
  <entityid>8d0bfe06-99e5-461b-9567-777592e26925</entityid>
  <image>sample string 8</image>
  <latitude>1</latitude>
  <locationid>1</locationid>
  <longitude>1</longitude>
  <supervisorid>4</supervisorid>
  <supervisorname>sample string 5</supervisorname>
  <truckrego>sample string 7</truckrego>
  <ucoreceiptnumber>sample string 6</ucoreceiptnumber>
  <verifycode>sample string 9</verifycode>
  <comments>sample string 2</comments>
  <isadhoctruck>true</isadhoctruck>
  <purchaseordernumber>sample string 1</purchaseordernumber>
</UCOCollectionPost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

New collection id with blank error message if successful. If failed, collection id is zero with error message filled.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.