GET GET_LOCK/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Entity value for the lock (database value)	integer	Required

Body Parameters

None.

Response Information

Resource Description

GetLockResponse

Name	Description	Type	Additional information
Header		ResponseHeader	None.
Body		GetLockResponseBody	None.

Response Header Description

ResponseHeader

Name	Description	Type	Additional information
Message	Message	string	None.
StatusCode	Status code	ResponseStatus	None.
Status	Status	string	None.
ErrorId	Error id	string	None.

Response Body Description

GetLockResponseBody

Name	Description	Type	Additional information
Lock	Entity value for the lock (database value)	LockModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "Lock": {
      "LockEntity": 1,
      "OwnerEntity": 2,
      "LockId": "sample string 3",
      "KeyLockOwner0": "sample string 4",
      "KeyLockOwner1": "sample string 5",
      "BankModeStatus": "sample string 6",
      "BankModeStart": "2025-11-08T03:23:01.9943957-05:00",
      "BankModeEnd": "2025-11-08T03:23:01.9943957-05:00",
      "TampResetStatus": "sample string 7",
      "AuditStatus": "sample string 8",
      "LockInitialize": true,
      "PCcode": 1,
      "OCcode": 1,
      "ErasePcoc": true,
      "PendBankModeStatus": "sample string 11",
      "PendBankModeStart": "2025-11-08T03:23:01.9943957-05:00",
      "PendBankModeEnd": "2025-11-08T03:23:01.9943957-05:00",
      "PendTampResetStatus": "sample string 12",
      "PendAuditStatus": "sample string 13",
      "PendLockInitialize": true,
      "PendLockUnInstall": true,
      "PendPCcode": 1,
      "PendOCcode": 1,
      "PendErasePcoc": true,
      "ChangeStatus": true,
      "SetClockCalSeqNo": 1,
      "LocationId": "sample string 18"
    }
  }
}

application/xml, text/xml

Sample:

<GetLockResponse 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:Lock xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:AuditStatus>sample string 8</d3p1:AuditStatus>
      <d3p1:BankModeEnd>2025-11-08T03:23:01.9943957-05:00</d3p1:BankModeEnd>
      <d3p1:BankModeStart>2025-11-08T03:23:01.9943957-05:00</d3p1:BankModeStart>
      <d3p1:BankModeStatus>sample string 6</d3p1:BankModeStatus>
      <d3p1:ChangeStatus>true</d3p1:ChangeStatus>
      <d3p1:ErasePcoc>true</d3p1:ErasePcoc>
      <d3p1:KeyLockOwner0>sample string 4</d3p1:KeyLockOwner0>
      <d3p1:KeyLockOwner1>sample string 5</d3p1:KeyLockOwner1>
      <d3p1:LocationId>sample string 18</d3p1:LocationId>
      <d3p1:LockEntity>1</d3p1:LockEntity>
      <d3p1:LockId>sample string 3</d3p1:LockId>
      <d3p1:LockInitialize>true</d3p1:LockInitialize>
      <d3p1:OCcode>1</d3p1:OCcode>
      <d3p1:OwnerEntity>2</d3p1:OwnerEntity>
      <d3p1:PCcode>1</d3p1:PCcode>
      <d3p1:PendAuditStatus>sample string 13</d3p1:PendAuditStatus>
      <d3p1:PendBankModeEnd>2025-11-08T03:23:01.9943957-05:00</d3p1:PendBankModeEnd>
      <d3p1:PendBankModeStart>2025-11-08T03:23:01.9943957-05:00</d3p1:PendBankModeStart>
      <d3p1:PendBankModeStatus>sample string 11</d3p1:PendBankModeStatus>
      <d3p1:PendErasePcoc>true</d3p1:PendErasePcoc>
      <d3p1:PendLockInitialize>true</d3p1:PendLockInitialize>
      <d3p1:PendLockUnInstall>true</d3p1:PendLockUnInstall>
      <d3p1:PendOCcode>1</d3p1:PendOCcode>
      <d3p1:PendPCcode>1</d3p1:PendPCcode>
      <d3p1:PendTampResetStatus>sample string 12</d3p1:PendTampResetStatus>
      <d3p1:SetClockCalSeqNo>1</d3p1:SetClockCalSeqNo>
      <d3p1:TampResetStatus>sample string 7</d3p1:TampResetStatus>
    </d2p1:Lock>
  </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>
</GetLockResponse>