UCO API (ver. 2.16)

GET api/v1/ROCCollection/Collection?collectionid={collectionid}

Query ROC collection information using the collection id.

Request Information

URI Parameters

Name	Description	Type	Additional information
collectionid	Collection id of the ROC collection record	integer	Required

Body Parameters

None.

Response Information

Resource Description

UcoROCCollectionGet

Name	Type	Additional information
ucocollectionid	integer	None.
userid	globally unique identifier	None.
deliverystatusid	integer	None.
storenumber	integer	None.
store_name	string	None.
employeeid	integer	None.
driverfirstname	string	None.
driverlastname	string	None.
containers	Collection of UcoROCCollectionGetContainer	None.
emptyROCsSupplied	Collection of UcoROCCollectionEmptyContainer	None.
storeid	globally unique identifier	None.
ucoreceiptnumber	string	None.
datetimeofcollection	date	None.
supervisorid	integer	None.
supervisorname	string	None.
truckrego	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ucocollectionid": 1,
  "userid": "4e997a39-31d9-486a-8c94-c9e9a9429ba7",
  "deliverystatusid": 1,
  "storenumber": 3,
  "store_name": "sample string 4",
  "employeeid": 1,
  "driverfirstname": "sample string 5",
  "driverlastname": "sample string 6",
  "containers": [
    {
      "ucocollectionid": 1,
      "rocnumber": "sample string 2",
      "quantity": 3.0,
      "state": "sample string 4",
      "containertypeid": 5
    },
    {
      "ucocollectionid": 1,
      "rocnumber": "sample string 2",
      "quantity": 3.0,
      "state": "sample string 4",
      "containertypeid": 5
    }
  ],
  "emptyROCsSupplied": [
    {
      "rocnumber": "sample string 1"
    },
    {
      "rocnumber": "sample string 1"
    }
  ],
  "storeid": "75ddb340-237e-45c4-b297-29d8ddb578dd",
  "ucoreceiptnumber": "sample string 8",
  "datetimeofcollection": "2026-08-16T17:17:36.9331984+00:00",
  "supervisorid": 9,
  "supervisorname": "sample string 10",
  "truckrego": "sample string 11"
}

application/xml, text/xml

Sample:

<UcoROCCollectionGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_api.Models">
  <datetimeofcollection>2026-08-16T17:17:36.9331984+00:00</datetimeofcollection>
  <storeid>75ddb340-237e-45c4-b297-29d8ddb578dd</storeid>
  <supervisorid>9</supervisorid>
  <supervisorname>sample string 10</supervisorname>
  <truckrego>sample string 11</truckrego>
  <ucoreceiptnumber>sample string 8</ucoreceiptnumber>
  <containers>
    <UcoROCCollectionGetContainer>
      <containertypeid>5</containertypeid>
      <quantity>3</quantity>
      <rocnumber>sample string 2</rocnumber>
      <state>sample string 4</state>
      <ucocollectionid>1</ucocollectionid>
    </UcoROCCollectionGetContainer>
    <UcoROCCollectionGetContainer>
      <containertypeid>5</containertypeid>
      <quantity>3</quantity>
      <rocnumber>sample string 2</rocnumber>
      <state>sample string 4</state>
      <ucocollectionid>1</ucocollectionid>
    </UcoROCCollectionGetContainer>
  </containers>
  <deliverystatusid>1</deliverystatusid>
  <driverfirstname>sample string 5</driverfirstname>
  <driverlastname>sample string 6</driverlastname>
  <employeeid>1</employeeid>
  <emptyROCsSupplied>
    <UcoROCCollectionEmptyContainer>
      <rocnumber>sample string 1</rocnumber>
    </UcoROCCollectionEmptyContainer>
    <UcoROCCollectionEmptyContainer>
      <rocnumber>sample string 1</rocnumber>
    </UcoROCCollectionEmptyContainer>
  </emptyROCsSupplied>
  <store_name>sample string 4</store_name>
  <storenumber>3</storenumber>
  <ucocollectionid>1</ucocollectionid>
  <userid>4e997a39-31d9-486a-8c94-c9e9a9429ba7</userid>
</UcoROCCollectionGet>