Request Information

URI Parameters

None.

Body Parameters

ResetUserKeyCRequest

ResetUserKeyCRequest
NameDescriptionTypeAdditional information
AtmId

ATM ID of the ATM to be used for resetting the key

string

Required

MiddleName

Middle Name / Nickname of technician who will be resetting the key

string

Required

TouchKeyId

Touch Key ID of the technician who will be resetting the key

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

Request Formats

application/json, text/json

Sample:
{
  "AtmId": "23349391",
  "MiddleName": "Smith",
  "TouchKeyId": "5700000004748D0A",
  "Date": "01/08/2014",
  "Hour": 0,
  "TimeBlock": 4,
  "LockStatus": 0
}

application/xml, text/xml

Sample:
<ResetUserKeyCRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.CCommands">
  <AtmId>23349391</AtmId>
  <Date>01/08/2014</Date>
  <Hour>0</Hour>
  <LockStatus>0</LockStatus>
  <MiddleName>Smith</MiddleName>
  <TimeBlock>4</TimeBlock>
  <TouchKeyId>5700000004748D0A</TouchKeyId>
</ResetUserKeyCRequest>

application/x-www-form-urlencoded

Sample:
AtmId=23349391&Date=01%2f08%2f2014&Hour=0&LockStatus=0&TimeBlock=4&TouchKeyId=5700000004748D0A&MiddleName=Smith

Response Information

Resource Description

OperationCodeResponse

OperationCodeResponse
NameDescriptionTypeAdditional information
Header

Operation code response message header.

ResponseHeader

None.

Body

Operation code response message body.

OperationCodeResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

string

None.

StatusCode

Status code

ResponseStatus

None.

Status

Status

string

None.

ErrorId

Error id

string

None.

Response Body Description

OperationCodeResponseBody
NameDescriptionTypeAdditional information
OperationCode

Operation code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "OperationCode": 95015
  }
}

application/xml, text/xml

Sample:
<OperationCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
  <Body>
    <OperationCode>95015</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>

© 2025 Sargent and Greenleaf