UCO API (ver. 2.16)

GET api/v1/Collection/COL_GET_EntityCollections?entityid={entityid}&locationid={locationid}&fromdate={fromdate}&todate={todate}

Query collection information for the enity and location over a specific time period.

Request Information

URI Parameters

Name	Description	Type	Additional information
entityid	Id of the supplier, customer or store.	globally unique identifier	Required
locationid	Id of the supplier location.	integer	Default value is 0
fromdate	Optional - start date of collections.	date	None.
todate	Optional - end date of collections.	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection information pertaining to the entity, given a from and to date. If date parameters are empty, all collections will be returned.

Collection of UCOCollectionGet

Name	Type	Additional information
collectionid	integer	None.
entityid	globally unique identifier	None.
entityname	string	None.
entitytypename	string	None.
locationid	integer	None.
locationname	string	None.
supervisorid	integer	None.
supervisorname	string	None.
datetimeofcollection	date	None.
purchaseordernumber	string	None.
truckrego	string	None.
containers	Collection of UCOContainer	None.
emptycontainers	Collection of UCOEmptyContainer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "collectionid": 1,
    "entityid": "92aaf66c-3e5b-45a0-8f43-d75007fea14b",
    "entityname": "sample string 3",
    "entitytypename": "sample string 4",
    "locationid": 1,
    "locationname": "sample string 5",
    "supervisorid": 6,
    "supervisorname": "sample string 7",
    "datetimeofcollection": "2026-08-16T17:18:53.4588946+00:00",
    "purchaseordernumber": "sample string 8",
    "truckrego": "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"
      }
    ]
  },
  {
    "collectionid": 1,
    "entityid": "92aaf66c-3e5b-45a0-8f43-d75007fea14b",
    "entityname": "sample string 3",
    "entitytypename": "sample string 4",
    "locationid": 1,
    "locationname": "sample string 5",
    "supervisorid": 6,
    "supervisorname": "sample string 7",
    "datetimeofcollection": "2026-08-16T17:18:53.4588946+00:00",
    "purchaseordernumber": "sample string 8",
    "truckrego": "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:

<ArrayOfUCOCollectionGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Collection">
  <UCOCollectionGet>
    <collectionid>1</collectionid>
    <containers xmlns:d3p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
      <d3p1:UCOContainer>
        <d3p1:containernumber>sample string 4</d3p1:containernumber>
        <d3p1:state>sample string 3</d3p1:state>
        <d3p1:containertypeid>2</d3p1:containertypeid>
        <d3p1:quantity>1</d3p1:quantity>
      </d3p1:UCOContainer>
      <d3p1:UCOContainer>
        <d3p1:containernumber>sample string 4</d3p1:containernumber>
        <d3p1:state>sample string 3</d3p1:state>
        <d3p1:containertypeid>2</d3p1:containertypeid>
        <d3p1:quantity>1</d3p1:quantity>
      </d3p1:UCOContainer>
    </containers>
    <datetimeofcollection>2026-08-16T17:18:53.4588946+00:00</datetimeofcollection>
    <emptycontainers xmlns:d3p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
      <d3p1:UCOEmptyContainer>
        <d3p1:containernumber>sample string 2</d3p1:containernumber>
        <d3p1:state>sample string 1</d3p1:state>
      </d3p1:UCOEmptyContainer>
      <d3p1:UCOEmptyContainer>
        <d3p1:containernumber>sample string 2</d3p1:containernumber>
        <d3p1:state>sample string 1</d3p1:state>
      </d3p1:UCOEmptyContainer>
    </emptycontainers>
    <entityid>92aaf66c-3e5b-45a0-8f43-d75007fea14b</entityid>
    <entityname>sample string 3</entityname>
    <entitytypename>sample string 4</entitytypename>
    <locationid>1</locationid>
    <locationname>sample string 5</locationname>
    <purchaseordernumber>sample string 8</purchaseordernumber>
    <supervisorid>6</supervisorid>
    <supervisorname>sample string 7</supervisorname>
    <truckrego>sample string 9</truckrego>
  </UCOCollectionGet>
  <UCOCollectionGet>
    <collectionid>1</collectionid>
    <containers xmlns:d3p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
      <d3p1:UCOContainer>
        <d3p1:containernumber>sample string 4</d3p1:containernumber>
        <d3p1:state>sample string 3</d3p1:state>
        <d3p1:containertypeid>2</d3p1:containertypeid>
        <d3p1:quantity>1</d3p1:quantity>
      </d3p1:UCOContainer>
      <d3p1:UCOContainer>
        <d3p1:containernumber>sample string 4</d3p1:containernumber>
        <d3p1:state>sample string 3</d3p1:state>
        <d3p1:containertypeid>2</d3p1:containertypeid>
        <d3p1:quantity>1</d3p1:quantity>
      </d3p1:UCOContainer>
    </containers>
    <datetimeofcollection>2026-08-16T17:18:53.4588946+00:00</datetimeofcollection>
    <emptycontainers xmlns:d3p1="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.Containers">
      <d3p1:UCOEmptyContainer>
        <d3p1:containernumber>sample string 2</d3p1:containernumber>
        <d3p1:state>sample string 1</d3p1:state>
      </d3p1:UCOEmptyContainer>
      <d3p1:UCOEmptyContainer>
        <d3p1:containernumber>sample string 2</d3p1:containernumber>
        <d3p1:state>sample string 1</d3p1:state>
      </d3p1:UCOEmptyContainer>
    </emptycontainers>
    <entityid>92aaf66c-3e5b-45a0-8f43-d75007fea14b</entityid>
    <entityname>sample string 3</entityname>
    <entitytypename>sample string 4</entitytypename>
    <locationid>1</locationid>
    <locationname>sample string 5</locationname>
    <purchaseordernumber>sample string 8</purchaseordernumber>
    <supervisorid>6</supervisorid>
    <supervisorname>sample string 7</supervisorname>
    <truckrego>sample string 9</truckrego>
  </UCOCollectionGet>
</ArrayOfUCOCollectionGet>