Request Information

URI Parameters

None.

Body Parameters

CreateLockOwnerKeysRequest

CreateLockOwnerKeysRequest
NameDescriptionTypeAdditional information
OwnerEntity

Entity value for the owner (database value)

integer

Required

Matching regular expression pattern: ([0-9]+)

LockId

Lock ID

string

Required

Matching regular expression pattern: ([0-9]+)

Max length: 12

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LockOwnerKeyResponse

LockOwnerKeyResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

LockOwnerKeyResponseBody

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

LockOwnerKeyResponseBody
NameDescriptionTypeAdditional information
LockOwnerKey

Lock owner keys

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "LockOwnerKey": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<LockOwnerKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Lock">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Lock" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:LockOwnerKey>sample string 1</d2p1:LockOwnerKey>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</LockOwnerKeyResponse>

© 2025 Sargent and Greenleaf