PUT api/ordDocument/{id}

Update an existing record from the ord.Documents table.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

ordDocument

Name	Type	Additional information
DocumentID	integer	None.
DocumentTypeID	integer	Required
OrderID	integer	Required
InvoiceID	integer	None.
FreightLegID	integer	None.
FreightPayableID	integer	None.
FreightFeeID	integer	None.
FreightHandlingID	integer	None.
TaskID	integer	None.
TrackingID	integer	None.
WarehouseAlertID	integer	None.
WONumber	integer	None.
QuoteID	integer	None.
DocumentName	string	Max length: 240
DocumentPath	string	Max length: 240
DocumentDescription	string	Max length: 3000
ContentType	string	None.
ClientVisible	boolean	None.
CreatedBy	integer	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedDate	date	None.
IsNew	boolean	None.
results	Collection of ValidationResult	None.

Request Formats

application/json, text/json

Sample:

{
  "results": null,
  "DocumentID": 1,
  "DocumentTypeID": 2,
  "OrderID": 3,
  "InvoiceID": 1,
  "FreightLegID": 1,
  "FreightPayableID": 1,
  "FreightFeeID": 1,
  "FreightHandlingID": 1,
  "TaskID": 1,
  "TrackingID": 1,
  "WarehouseAlertID": 1,
  "WONumber": 1,
  "QuoteID": 1,
  "DocumentName": "sample string 4",
  "DocumentPath": "sample string 5",
  "DocumentDescription": "sample string 6",
  "ContentType": "sample string 7",
  "ClientVisible": true,
  "CreatedBy": 9,
  "CreatedDate": "2025-12-06T23:41:06.4386445+00:00",
  "UpdatedBy": 11,
  "UpdatedDate": "2025-12-06T23:41:06.4386445+00:00",
  "IsNew": true
}

application/xml, text/xml

Sample:

<ordDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <ClientVisible>true</ClientVisible>
  <ContentType>sample string 7</ContentType>
  <CreatedBy>9</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:41:06.4386445Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DocumentDescription>sample string 6</DocumentDescription>
  <DocumentID>1</DocumentID>
  <DocumentName>sample string 4</DocumentName>
  <DocumentPath>sample string 5</DocumentPath>
  <DocumentTypeID>2</DocumentTypeID>
  <FreightFeeID>1</FreightFeeID>
  <FreightHandlingID>1</FreightHandlingID>
  <FreightLegID>1</FreightLegID>
  <FreightPayableID>1</FreightPayableID>
  <InvoiceID>1</InvoiceID>
  <IsNew>true</IsNew>
  <OrderID>3</OrderID>
  <QuoteID>1</QuoteID>
  <TaskID>1</TaskID>
  <TrackingID>1</TrackingID>
  <UpdatedBy>11</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-06T23:41:06.4386445Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
  <WONumber>1</WONumber>
  <WarehouseAlertID>1</WarehouseAlertID>
</ordDocument>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ordDocument'.

Response Information

Resource Description

UpsertRetOfordDocument

Name	Type	Additional information
returnID	integer	None.
results	Collection of ValidationResult	None.
returnItem	ordDocument	None.
displayMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "DocumentID": 1,
    "DocumentTypeID": 2,
    "OrderID": 3,
    "InvoiceID": 1,
    "FreightLegID": 1,
    "FreightPayableID": 1,
    "FreightFeeID": 1,
    "FreightHandlingID": 1,
    "TaskID": 1,
    "TrackingID": 1,
    "WarehouseAlertID": 1,
    "WONumber": 1,
    "QuoteID": 1,
    "DocumentName": "sample string 4",
    "DocumentPath": "sample string 5",
    "DocumentDescription": "sample string 6",
    "ContentType": "sample string 7",
    "ClientVisible": true,
    "CreatedBy": 9,
    "CreatedDate": "2025-12-06T23:41:06.4698509+00:00",
    "UpdatedBy": 11,
    "UpdatedDate": "2025-12-06T23:41:06.4698509+00:00",
    "IsNew": true
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<UpsertRetOfordDocument66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <displayMessage>sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
  <returnID>1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:ClientVisible>true</d2p1:ClientVisible>
    <d2p1:ContentType>sample string 7</d2p1:ContentType>
    <d2p1:CreatedBy>9</d2p1:CreatedBy>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:06.4698509Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:DocumentDescription>sample string 6</d2p1:DocumentDescription>
    <d2p1:DocumentID>1</d2p1:DocumentID>
    <d2p1:DocumentName>sample string 4</d2p1:DocumentName>
    <d2p1:DocumentPath>sample string 5</d2p1:DocumentPath>
    <d2p1:DocumentTypeID>2</d2p1:DocumentTypeID>
    <d2p1:FreightFeeID>1</d2p1:FreightFeeID>
    <d2p1:FreightHandlingID>1</d2p1:FreightHandlingID>
    <d2p1:FreightLegID>1</d2p1:FreightLegID>
    <d2p1:FreightPayableID>1</d2p1:FreightPayableID>
    <d2p1:InvoiceID>1</d2p1:InvoiceID>
    <d2p1:IsNew>true</d2p1:IsNew>
    <d2p1:OrderID>3</d2p1:OrderID>
    <d2p1:QuoteID>1</d2p1:QuoteID>
    <d2p1:TaskID>1</d2p1:TaskID>
    <d2p1:TrackingID>1</d2p1:TrackingID>
    <d2p1:UpdatedBy>11</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:41:06.4698509Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
    <d2p1:WONumber>1</d2p1:WONumber>
    <d2p1:WarehouseAlertID>1</d2p1:WarehouseAlertID>
  </returnItem>
</UpsertRetOfordDocument66KPc_SrH>