1. Help
  2. POST GET_INIT_LOCK_OPERATION_CODES

POST GET_INIT_LOCK_OPERATION_CODES

This function will return a list of active lock initializations. INPUTS==> LOCATION ID, PAGE, PAGE SIZE. RETURN==> list of lock initializations

Request Information

URI Parameters

None.

Body Parameters

InitLockOpCodesRequest

InitLockOpCodesRequest
NameDescriptionTypeAdditional information
LocationId

Location ID

 string

None.
Page

PageNumber

 integer

Range: inclusive between 1 and 100000
PageSize

Page Size

 integer

Range: inclusive between 1 and 100000

Request Formats

application/json, text/json

Sample: 
{
  "LocationId": "sample string 1",
  "Page": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample: 
<InitLockOpCodesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.OperationCodesQuery">
  <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">2</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">3</PageSize>
  <LocationId>sample string 1</LocationId>
</InitLockOpCodesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InitLockOpCodesResponse

InitLockOpCodesResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

InitLockOpCodesResponseBody

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

InitLockOpCodesResponseBody
NameDescriptionTypeAdditional information
InitLockOpCodes

List of lock initialization operation codes

 Collection of LockInitOpCodeViewModel

None.
TotalCount

Total records count.

 integer

None.
PageSize

Page size.

 integer

None.
Page

Page

 integer

None.
PageCount

Number of pages.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "InitLockOpCodes": [
      {
        "LockEntity": 1,
        "LockID": "sample string 2",
        "LocationID": "sample string 3",
        "OpCodeEntity": 4,
        "TouchKeyID": "sample string 5",
        "DateAssigned": "2025-11-08T03:20:44.9091137-05:00",
        "FirstName": "sample string 6",
        "LastName": "sample string 7"
      },
      {
        "LockEntity": 1,
        "LockID": "sample string 2",
        "LocationID": "sample string 3",
        "OpCodeEntity": 4,
        "TouchKeyID": "sample string 5",
        "DateAssigned": "2025-11-08T03:20:44.9091137-05:00",
        "FirstName": "sample string 6",
        "LastName": "sample string 7"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample: 
<InitLockOpCodesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:InitLockOpCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:LockInitOpCodeViewModel>
        <d3p1:DateAssigned>2025-11-08T03:20:44.9091137-05:00</d3p1:DateAssigned>
        <d3p1:FirstName>sample string 6</d3p1:FirstName>
        <d3p1:LastName>sample string 7</d3p1:LastName>
        <d3p1:LocationID>sample string 3</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 2</d3p1:LockID>
        <d3p1:OpCodeEntity>4</d3p1:OpCodeEntity>
        <d3p1:TouchKeyID>sample string 5</d3p1:TouchKeyID>
      </d3p1:LockInitOpCodeViewModel>
      <d3p1:LockInitOpCodeViewModel>
        <d3p1:DateAssigned>2025-11-08T03:20:44.9091137-05:00</d3p1:DateAssigned>
        <d3p1:FirstName>sample string 6</d3p1:FirstName>
        <d3p1:LastName>sample string 7</d3p1:LastName>
        <d3p1:LocationID>sample string 3</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 2</d3p1:LockID>
        <d3p1:OpCodeEntity>4</d3p1:OpCodeEntity>
        <d3p1:TouchKeyID>sample string 5</d3p1:TouchKeyID>
      </d3p1:LockInitOpCodeViewModel>
    </d2p1:InitLockOpCodes>
  </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>
</InitLockOpCodesResponse>
© 2025 Sargent and Greenleaf