Request Information

URI Parameters

None.

Body Parameters

OpenLockNow2BRequest

OpenLockNow2BRequest
NameDescriptionTypeAdditional information
LockId

Lock ID of the lock to be opened

string

Required

UserId

User ID of technician who will be opening the lock

string

Required

Request Formats

application/json, text/json

Sample:
{
  "LockId": "233493890000",
  "UserId": "WilsonFG"
}

application/xml, text/xml

Sample:
<OpenLockNow2BRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.BCommands">
  <LockId>233493890000</LockId>
  <UserId>WilsonFG</UserId>
</OpenLockNow2BRequest>

application/x-www-form-urlencoded

Sample:
LockId=233493890000&UserId=WilsonFG

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": 91432057
  }
}

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>91432057</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