1. Help
  2. POST BROWSE_ATM_AVAILABLE_LOCK

POST BROWSE_ATM_AVAILABLE_LOCK

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

Request Information

URI Parameters

None.

Body Parameters

AtmAvailableLockRequest

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

application/xml, text/xml

Sample: 
<AtmAvailableLockRequest 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">4</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">5</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 3</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 1</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">sample string 2</FilterString>
</AtmAvailableLockRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AtmAvailableLockResponse

AtmAvailableLockResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

AtmAvailableLockResponseBody

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

AtmAvailableLockResponseBody
NameDescriptionTypeAdditional information
Locks

List of available locks to assign to ATMs

 Collection of AtmAvailableLockModel

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,
        "LockID": "sample string 2",
        "OwnerEntity": 3,
        "OwnerID": "sample string 4",
        "ChangeStatus": true,
        "ChangeStatusDescription": "sample string 5",
        "SystemOwner": true,
        "LockInitialize": true,
        "ATMId": "sample string 8",
        "SiteNo": "sample string 9",
        "LocationID": "sample string 10"
      },
      {
        "LockEntity": 1,
        "LockID": "sample string 2",
        "OwnerEntity": 3,
        "OwnerID": "sample string 4",
        "ChangeStatus": true,
        "ChangeStatusDescription": "sample string 5",
        "SystemOwner": true,
        "LockInitialize": true,
        "ATMId": "sample string 8",
        "SiteNo": "sample string 9",
        "LocationID": "sample string 10"
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample: 
<AtmAvailableLockResponse 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:AtmAvailableLockModel>
        <d3p1:ATMId>sample string 8</d3p1:ATMId>
        <d3p1:ChangeStatus>true</d3p1:ChangeStatus>
        <d3p1:ChangeStatusDescription>sample string 5</d3p1:ChangeStatusDescription>
        <d3p1:LocationID>sample string 10</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 2</d3p1:LockID>
        <d3p1:LockInitialize>true</d3p1:LockInitialize>
        <d3p1:OwnerEntity>3</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 4</d3p1:OwnerID>
        <d3p1:SiteNo>sample string 9</d3p1:SiteNo>
        <d3p1:SystemOwner>true</d3p1:SystemOwner>
      </d3p1:AtmAvailableLockModel>
      <d3p1:AtmAvailableLockModel>
        <d3p1:ATMId>sample string 8</d3p1:ATMId>
        <d3p1:ChangeStatus>true</d3p1:ChangeStatus>
        <d3p1:ChangeStatusDescription>sample string 5</d3p1:ChangeStatusDescription>
        <d3p1:LocationID>sample string 10</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>sample string 2</d3p1:LockID>
        <d3p1:LockInitialize>true</d3p1:LockInitialize>
        <d3p1:OwnerEntity>3</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 4</d3p1:OwnerID>
        <d3p1:SiteNo>sample string 9</d3p1:SiteNo>
        <d3p1:SystemOwner>true</d3p1:SystemOwner>
      </d3p1:AtmAvailableLockModel>
    </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>
</AtmAvailableLockResponse>
© 2025 Sargent and Greenleaf