A Series One Time Code (OTC)
Close an active operation code. INPUTS==> TECHNICIAN ID, LOCK ID, OPERATION CODE, RESULT (0, F, Z). RETURN==> no returned value
None.
CloseCodeViaLockIdRequest
CloseCodeViaLockIdRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TechnicianId |
Technician Id |
integer |
Required |
| LockId |
Lock ID to be used to close an operation code |
string |
Required |
| OperationCode |
Operation code |
integer |
Required |
| OperationResult |
Operation result |
string |
None. |
{
"TechnicianId": 1,
"LockId": "12345678",
"OperationCode": 43232333,
"OperationResult": "1"
}
<CloseCodeViaLockIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests.GenerateOperationCodes"> <LockId>12345678</LockId> <OperationCode>43232333</OperationCode> <OperationResult>1</OperationResult> <TechnicianId>1</TechnicianId> </CloseCodeViaLockIdRequest>
TechnicianId=1&LockId=12345678&OperationCode=43232333,OperationResult=1
CloseCodeResponse
CloseCodeResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Close code response message header. |
ResponseHeader |
None. |
| Body |
Close code response message body. |
CloseCodeResponseBody |
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 |
|---|---|---|---|
| CodeClosed |
Determines if the code was successfully closed. |
boolean |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"CodeClosed": true
}
}
<CloseCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
<Body>
<CodeClosed>true</CodeClosed>
</Body>
<Header>
<ErrorId i:nil="true" />
<Message></Message>
<Status>Ok</Status>
<StatusCode>Ok</StatusCode>
</Header>
</CloseCodeResponse>