GET api/ordDocument/{id}
Return a single value from the ord.Documents table using the primary key as ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ord.Documents Primary Key. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A single ord.Document record
ordDocument| Name | Description | 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. |
Response 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:43:09.120185+00:00",
"UpdatedBy": 11,
"UpdatedDate": "2025-12-06T23:43:09.120185+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:43:09.120185Z</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:43:09.120185Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
<WONumber>1</WONumber>
<WarehouseAlertID>1</WarehouseAlertID>
</ordDocument>