Request Information

URI Parameters

None.

Body Parameters

RecordLockOwnerKeysRequest

RecordLockOwnerKeysRequest
NameDescriptionTypeAdditional information
LockEntity

Entity value for the lock (database value)

integer

Required

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

LockOwnerKeys

Lock owner keys

string

Required

OnMultiple

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "LockEntity": 1,
  "LockOwnerKeys": "sample string 2",
  "OnMultiple": true
}

application/xml, text/xml

Sample:
<RecordLockOwnerKeysRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Lock">
  <LockEntity>1</LockEntity>
  <LockOwnerKeys>sample string 2</LockOwnerKeys>
  <OnMultiple>true</OnMultiple>
</RecordLockOwnerKeysRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RecordLockOwnerKeysResponse

RecordLockOwnerKeysResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

RecordLockOwnerKeysResponseBody

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

RecordLockOwnerKeysResponseBody
NameDescriptionTypeAdditional information
LockOwnerKeysRecorded

Flag to show if lock owner keys successfully saved

boolean

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<RecordLockOwnerKeysResponse 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:LockOwnerKeysRecorded>true</d2p1:LockOwnerKeysRecorded>
  </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>
</RecordLockOwnerKeysResponse>

© 2025 Sargent and Greenleaf