This function will close an active operation code. INPUTS==> OPERATION CODE ENTITY, LOCK ID, RESULT CODE, DURATION, TIME. RETURN==> (result)
None.
CloseOperationCodeRequest
CloseOperationCodeRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OpCodeEntity |
Entity value for the operation code (database value) |
integer |
Required |
| ResultCode |
Result Code |
string |
Required |
| LockId |
Lock ID |
string |
None. |
| Duration |
Duration |
integer |
None. |
| EventTime |
Session / Event Time |
date |
None. |
{
"OpCodeEntity": 1,
"ResultCode": "sample string 2",
"LockId": "sample string 3",
"Duration": 1,
"EventTime": "2025-11-08T03:21:55.2300861-05:00"
}
<CloseOperationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.OperationCodesQuery"> <Duration>1</Duration> <EventTime>2025-11-08T03:21:55.2300861-05:00</EventTime> <LockId>sample string 3</LockId> <OpCodeEntity>1</OpCodeEntity> <ResultCode>sample string 2</ResultCode> </CloseOperationCodeRequest>
Sample not available.
CloseOperationCodeResponse
CloseOperationCodeResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | CloseOperationCodeResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| OpCodeClosed |
Flag to show if operation code was successfully closed |
boolean |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"OpCodeClosed": true
}
}
<CloseOperationCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
<Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:OpCodeClosed>true</d2p1:OpCodeClosed>
</Body>
<Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<ErrorId>sample string 3</ErrorId>
<Message>sample string 1</Message>
<Status>sample string 2</Status>
<StatusCode>Ok</StatusCode>
</Header>
</CloseOperationCodeResponse>