DELETE api/cfgOrderHold/{id}
Delete a single record from the OrderHolds table.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | byte |
Required |
Body Parameters
None.
Response Information
Resource Description
UpsertRetOfcfgOrderHoldDb| Name | Description | Type | Additional information |
|---|---|---|---|
| returnID | integer |
None. |
|
| results | Collection of ValidationResult |
None. |
|
| returnItem | cfgOrderHoldDb |
None. |
|
| displayMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"returnID": 1,
"results": null,
"returnItem": {
"results": null,
"OrderHoldID": 1,
"OrderHoldType": "sample string 2",
"CanBeSetByClient": true,
"CanBeSetByCustSvc": true,
"Description": "sample string 5",
"IsActive": true,
"CreatedBy": 7,
"CreatedDate": "2025-12-06T23:43:38.9331578+00:00",
"UpdatedBy": 9,
"UpdatedDate": "2025-12-06T23:43:38.9331578+00:00"
},
"displayMessage": "sample string 1"
}
application/xml, text/xml
Sample:
<UpsertRetOfcfgOrderHoldDb66KPc_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:CanBeSetByClient>true</d2p1:CanBeSetByClient>
<d2p1:CanBeSetByCustSvc>true</d2p1:CanBeSetByCustSvc>
<d2p1:CreatedBy>7</d2p1:CreatedBy>
<d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-06T23:43:38.9331578Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</d2p1:CreatedDate>
<d2p1:Description>sample string 5</d2p1:Description>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:OrderHoldID>1</d2p1:OrderHoldID>
<d2p1:OrderHoldType>sample string 2</d2p1:OrderHoldType>
<d2p1:UpdatedBy>9</d2p1:UpdatedBy>
<d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-06T23:43:38.9331578Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</d2p1:UpdatedDate>
</returnItem>
</UpsertRetOfcfgOrderHoldDb66KPc_SrH>