Request Information

URI Parameters

None.

Body Parameters

OpenLockNow3BRequest

OpenLockNow3BRequest
NameDescriptionTypeAdditional information
LockId

Lock ID of the lock to be opened

string

Required

TouchkeyId

Touch Key ID of technician who will be opening the lock

string

Required

Request Formats

application/json, text/json

Sample:
{
  "LockId": "sample string 1",
  "TouchkeyId": "sample string 2"
}

application/xml, text/xml

Sample:
<OpenLockNow3BRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.BCommands">
  <LockId>sample string 1</LockId>
  <TouchkeyId>sample string 2</TouchkeyId>
</OpenLockNow3BRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "OperationCode": 1
  }
}

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>1</OperationCode>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId>sample string 3</d2p1:ErrorId>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Status>sample string 2</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</OperationCodeResponse>

© 2025 Sargent and Greenleaf