A Series One Time Code (OTC)
  1. Help
  2. POST RESET_USER_KEY_NOW

POST RESET_USER_KEY_NOW

Generate an operation code that can be used to reset a touch key, using the current date/time for the start date/time of the operation code. INPUTS==> TECHNICIAN ID, ATM ID, USER ID. RETURN==> OPERATION CODE (reset user key)

Request Information

URI Parameters

None.

Body Parameters

ResetUserKeyNowRequest

ResetUserKeyNowRequest
NameDescriptionTypeAdditional information
TechnicianId

Technician Id

 integer

Required
LockId

Lock Id

 string

Required
Pin

PIN

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "TechnicianId": 1,
  "LockId": "12345678",
  "Pin": null
}

application/xml, text/xml

Sample: 
<ResetUserKeyNowRequest 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>
  <Pin i:nil="true" />
  <TechnicianId>1</TechnicianId>
</ResetUserKeyNowRequest>

application/x-www-form-urlencoded

Sample: 
TechnicianId=1&LockId=12345678

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

 string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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