Request Information

URI Parameters

None.

Body Parameters

AddLockRequest.

AddLockRequest
NameDescriptionTypeAdditional information
LockId

Lock Id.

string

Required

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

Max length: 12

LocationId

Location Id .

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddLockResponse

AddLockResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

AddLockResponseBody

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

AddLockResponseBody
NameDescriptionTypeAdditional information
LockSaved

Flag to show if lock was successfully added

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": {
    "LockSaved": true
  }
}

application/xml, text/xml

Sample:
<AddLockResponse 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:LockSaved>true</d2p1:LockSaved>
  </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>
</AddLockResponse>

© 2025 Sargent and Greenleaf