1. Help
  2. POST BROWSE_LOCK

POST BROWSE_LOCK

This function will return a list of all available locks in the database. INPUTS==> sort information (FILTER STRING, COLUMN, SORT ORDER). RETURN==> list of locks

Request Information

URI Parameters

None.

Body Parameters

BrowseLockRequest

BrowseLockRequest
NameDescriptionTypeAdditional information
LocationId

Location ID

 string

None.
FilterColumn

string

None.
FilterString

string

None.
SortOrder

SortOrder

None.
SortColumn

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",
  "FilterColumn": "sample string 2",
  "FilterString": "sample string 3",
  "SortOrder": 0,
  "SortColumn": "sample string 4",
  "Page": 5,
  "PageSize": 6
}

application/xml, text/xml

Sample: 
<BrowseLockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Lock">
  <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">5</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">6</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 4</SortColumn>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">Ascending</SortOrder>
  <FilterColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 2</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 3</FilterString>
  <LocationId>sample string 1</LocationId>
</BrowseLockRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BrowseLockResponse

BrowseLockResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

BrowseLockResponseBody

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

BrowseLockResponseBody
NameDescriptionTypeAdditional information
Locks

Locks

 Collection of LockViewModel

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": {
    "Locks": [
      {
        "LockEntity": 1,
        "OwnerEntity": 2,
        "BankModeStatus": "sample string 3",
        "BankModeStart": "2025-11-08T03:19:51.5483679-05:00",
        "BankModeEnd": "2025-11-08T03:19:51.5483679-05:00",
        "TampResetStatus": "sample string 4",
        "AuditStatus": "sample string 5",
        "LockInitialize": true,
        "LockID": "sample string 7",
        "OwnerID": "sample string 8",
        "Status": true,
        "StatusDescription": "sample string 10",
        "PrimaryAtmID": "sample string 11",
        "SecondaryAtmID": "sample string 12",
        "LocationID": "sample string 13"
      },
      {
        "LockEntity": 1,
        "OwnerEntity": 2,
        "BankModeStatus": "sample string 3",
        "BankModeStart": "2025-11-08T03:19:51.5483679-05:00",
        "BankModeEnd": "2025-11-08T03:19:51.5483679-05:00",
        "TampResetStatus": "sample string 4",
        "AuditStatus": "sample string 5",
        "LockInitialize": true,
        "LockID": "sample string 7",
        "OwnerID": "sample string 8",
        "Status": true,
        "StatusDescription": "sample string 10",
        "PrimaryAtmID": "sample string 11",
        "SecondaryAtmID": "sample string 12",
        "LocationID": "sample string 13"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample: 
<BrowseLockResponse 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">
    <Page>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:Locks xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:LockViewModel>
        <d3p1:AuditStatus>sample string 5</d3p1:AuditStatus>
        <d3p1:BankModeEnd>2025-11-08T03:19:51.5483679-05:00</d3p1:BankModeEnd>
        <d3p1:BankModeStart>2025-11-08T03:19:51.5483679-05:00</d3p1:BankModeStart>
        <d3p1:BankModeStatus>sample string 3</d3p1:BankModeStatus>
        <d3p1:LocationID>sample string 13</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 7</d3p1:LockID>
        <d3p1:LockInitialize>true</d3p1:LockInitialize>
        <d3p1:OwnerEntity>2</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 8</d3p1:OwnerID>
        <d3p1:PrimaryAtmID>sample string 11</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>sample string 12</d3p1:SecondaryAtmID>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>sample string 10</d3p1:StatusDescription>
        <d3p1:TampResetStatus>sample string 4</d3p1:TampResetStatus>
      </d3p1:LockViewModel>
      <d3p1:LockViewModel>
        <d3p1:AuditStatus>sample string 5</d3p1:AuditStatus>
        <d3p1:BankModeEnd>2025-11-08T03:19:51.5483679-05:00</d3p1:BankModeEnd>
        <d3p1:BankModeStart>2025-11-08T03:19:51.5483679-05:00</d3p1:BankModeStart>
        <d3p1:BankModeStatus>sample string 3</d3p1:BankModeStatus>
        <d3p1:LocationID>sample string 13</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 7</d3p1:LockID>
        <d3p1:LockInitialize>true</d3p1:LockInitialize>
        <d3p1:OwnerEntity>2</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 8</d3p1:OwnerID>
        <d3p1:PrimaryAtmID>sample string 11</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>sample string 12</d3p1:SecondaryAtmID>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>sample string 10</d3p1:StatusDescription>
        <d3p1:TampResetStatus>sample string 4</d3p1:TampResetStatus>
      </d3p1:LockViewModel>
    </d2p1:Locks>
  </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>
</BrowseLockResponse>
© 2025 Sargent and Greenleaf