Generate an operation code that can be used to open a lock. INPUTS==> ATM ID, USER ID, TOUCH KEY ID, START DATE, START TIME, TIME BLOCK, LOCK STATUS. RETURN==> OPERATION CODE (open lock)
None.
OpenLockARequest
OpenLockARequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AtmId |
ATM ID of the ATM to be opened |
string |
Required |
| UserId |
User ID of technician who will be opening the lock |
string |
Required |
| TouchKeyId |
Touch Key ID of the technician who will be opening the lock |
string |
Required |
| Date |
Operation date. Valid formats ("dd/MM/yyyy", "dd-MM-yyyy", "ddMMyyyy") |
string |
Required |
| Hour |
Operation hour |
integer |
Required Range: inclusive between 0 and 23 |
| TimeBlock |
Time block. Valid values (4, 8, 12, 24) |
integer |
Required |
| LockStatus |
Lock status (0 = normal status) |
integer |
Required Range: inclusive between 0 and 9 |
{
"AtmId": "23349389",
"UserId": "WilsonFG",
"TouchKeyId": "C300000018AD830A",
"Date": "05/06/2014",
"Hour": 9,
"TimeBlock": 4,
"LockStatus": 0
}
<OpenLockARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.ACommands"> <AtmId>23349389</AtmId> <Date>05/06/2014</Date> <Hour>9</Hour> <LockStatus>0</LockStatus> <TimeBlock>4</TimeBlock> <TouchKeyId>C300000018AD830A</TouchKeyId> <UserId>WilsonFG</UserId> </OpenLockARequest>
AtmId=23349389&Date=05%2f06%2f2014&Hour=9&LockStatus=0&TimeBlock=4&TouchKeyId=C300000018AD830A&UserId=WilsonFG
OperationCodeResponse
OperationCodeResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Operation code response message header. |
ResponseHeader |
None. |
| Body |
Operation code response message body. |
OperationCodeResponseBody |
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 |
|---|---|---|---|
| OperationCode |
Operation code |
integer |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"OperationCode": 52946783
}
}
<OperationCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
<Body>
<OperationCode>52946783</OperationCode>
</Body>
<Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:ErrorId i:nil="true" />
<d2p1:Message></d2p1:Message>
<d2p1:Status>Ok</d2p1:Status>
<d2p1:StatusCode>Ok</d2p1:StatusCode>
</Header>
</OperationCodeResponse>