UCO API (ver. 2.16)

POST api/v1/CollectionRequest/COL_CR_POST_CollectionRequestUpdate

Update an existing Collection Request (if in REQUESTED state).

Request Information

URI Parameters

None.

Body Parameters

Collection Request Object

CollectionRequestPostModel

Name	Type	Additional information
ucocollectionrequestid	integer	None.
DateTimeOfRequest	date	None.
DC_Code	string	None.
CustomerId	globally unique identifier	None.
StoreId	globally unique identifier	None.
SupplierId	globally unique identifier	None.
LocationId	integer	None.
PONumber	string	None.
DeliveryOperator	integer	None.
ExpectedDate	date	None.
EstimatedUco	decimal number	None.
Comments	string	None.
NumEmptyContainersRequired	integer	None.
NumContainersForCollection	integer	None.
Containers	Collection of UCOContainer	None.

Request Formats

application/json, text/json

Sample:

{
  "ucocollectionrequestid": 1,
  "DateTimeOfRequest": "2026-08-16T17:16:16.3574581+00:00",
  "DC_Code": "sample string 1",
  "CustomerId": "4dc52769-7f53-4150-95a7-c551de86737e",
  "StoreId": "7cbef9a7-b7eb-492d-8059-1bf4bf7053a4",
  "SupplierId": "eec4a718-1b17-4e07-b280-9986fead961a",
  "LocationId": 1,
  "PONumber": "sample string 2",
  "DeliveryOperator": 3,
  "ExpectedDate": "2026-08-16T17:16:16.3574581+00:00",
  "EstimatedUco": 1.0,
  "Comments": "sample string 5",
  "NumEmptyContainersRequired": 6,
  "NumContainersForCollection": 7,
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<CollectionRequestPostModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_sharedmodels.Models.CollectionRequest">
  <Comments>sample string 5</Comments>
  <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>
  <CustomerId>4dc52769-7f53-4150-95a7-c551de86737e</CustomerId>
  <DC_Code>sample string 1</DC_Code>
  <DateTimeOfRequest>2026-08-16T17:16:16.3574581+00:00</DateTimeOfRequest>
  <DeliveryOperator>3</DeliveryOperator>
  <EstimatedUco>1</EstimatedUco>
  <ExpectedDate>2026-08-16T17:16:16.3574581+00:00</ExpectedDate>
  <LocationId>1</LocationId>
  <NumContainersForCollection>7</NumContainersForCollection>
  <NumEmptyContainersRequired>6</NumEmptyContainersRequired>
  <PONumber>sample string 2</PONumber>
  <StoreId>7cbef9a7-b7eb-492d-8059-1bf4bf7053a4</StoreId>
  <SupplierId>eec4a718-1b17-4e07-b280-9986fead961a</SupplierId>
  <ucocollectionrequestid>1</ucocollectionrequestid>
</CollectionRequestPostModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

New APIPostResult. If response code is OK, the Id contains the newly inserted id of collection request record. If an error occurred, the message field will contain an error message.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.