GET api/cfgOrderHold/{id}
Return a single value from the OrderHolds table using the primary key as ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The OrderHolds Primary Key. |
byte |
Required |
Body Parameters
None.
Response Information
Resource Description
cfgOrderHoldDb| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderHoldID | integer |
None. |
|
| OrderHoldType | string |
Required Max length: 10 |
|
| CanBeSetByClient | boolean |
None. |
|
| CanBeSetByCustSvc | boolean |
None. |
|
| Description | string |
Max length: 100 |
|
| IsActive | boolean |
None. |
|
| CreatedBy | integer |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | integer |
None. |
|
| UpdatedDate | date |
None. |
|
| results | Collection of ValidationResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"results": null,
"OrderHoldID": 1,
"OrderHoldType": "sample string 2",
"CanBeSetByClient": true,
"CanBeSetByCustSvc": true,
"Description": "sample string 5",
"IsActive": true,
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:42:10.7857385+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:42:10.7857385+00:00"
}
application/xml, text/xml
Sample:
<cfgOrderHoldDb 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" />
<CanBeSetByClient>true</CanBeSetByClient>
<CanBeSetByCustSvc>true</CanBeSetByCustSvc>
<CreatedBy>7</CreatedBy>
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:42:10.7857385Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<Description>sample string 5</Description>
<IsActive>true</IsActive>
<OrderHoldID>1</OrderHoldID>
<OrderHoldType>sample string 2</OrderHoldType>
<UpdatedBy>9</UpdatedBy>
<UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-06T23:42:10.7857385Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
</cfgOrderHoldDb>