1. Help
  2. POST BROWSE_ATM_OWNER

POST BROWSE_ATM_OWNER

This function will return a list of ATMs in the database that belong to the owner system. INPUTS==> FILTER STRING, FILTER COLUMN, SORT ORDER. RETURN==> list of ATMs (for the owner system)

Request Information

URI Parameters

None.

Body Parameters

BrowseAtmRequest

BrowseAtmRequest
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: 
<BrowseAtmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Atm">
  <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>
</BrowseAtmRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BrowseAtmResponse

BrowseAtmResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

BrowseAtmResponseBody

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

BrowseAtmResponseBody
NameDescriptionTypeAdditional information
ATMs

List of ATMs.

 Collection of AtmViewModel

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": {
    "ATMs": [
      {
        "AtmEntity": 1,
        "PrimaryAtmID": "sample string 2",
        "SecondaryAtmID": "sample string 3",
        "OwnerEntity": 4,
        "OwnerID": "sample string 5",
        "OwnerName": "sample string 6",
        "SiteName": "sample string 7",
        "LockEntity": 8,
        "LockID": "sample string 9",
        "Status": true,
        "StatusDescription": "sample string 11",
        "LocationID": "sample string 12",
        "AtmTimeZone": 13,
        "DaylightSavingsObserved": true,
        "TermSerialNo": "sample string 15",
        "SiteAddress": "sample string 16",
        "PhoneNo": "sample string 17",
        "MfgModel": "sample string 18",
        "ContactName": "sample string 19",
        "TypeService": "sample string 20",
        "UserDefined1": "sample string 21",
        "UserDefined2": "sample string 22",
        "Checked": true,
        "IsAssigned": true
      },
      {
        "AtmEntity": 1,
        "PrimaryAtmID": "sample string 2",
        "SecondaryAtmID": "sample string 3",
        "OwnerEntity": 4,
        "OwnerID": "sample string 5",
        "OwnerName": "sample string 6",
        "SiteName": "sample string 7",
        "LockEntity": 8,
        "LockID": "sample string 9",
        "Status": true,
        "StatusDescription": "sample string 11",
        "LocationID": "sample string 12",
        "AtmTimeZone": 13,
        "DaylightSavingsObserved": true,
        "TermSerialNo": "sample string 15",
        "SiteAddress": "sample string 16",
        "PhoneNo": "sample string 17",
        "MfgModel": "sample string 18",
        "ContactName": "sample string 19",
        "TypeService": "sample string 20",
        "UserDefined1": "sample string 21",
        "UserDefined2": "sample string 22",
        "Checked": true,
        "IsAssigned": true
      }
    ],
    "TotalCount": 1,
    "PageSize": 2,
    "Page": 3,
    "PageCount": 4
  }
}

application/xml, text/xml

Sample: 
<BrowseAtmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Atm">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Atm" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <Page>3</Page>
    <PageCount>4</PageCount>
    <PageSize>2</PageSize>
    <TotalCount>1</TotalCount>
    <d2p1:ATMs xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:AtmViewModel>
        <d3p1:AtmEntity>1</d3p1:AtmEntity>
        <d3p1:AtmTimeZone>13</d3p1:AtmTimeZone>
        <d3p1:Checked>true</d3p1:Checked>
        <d3p1:ContactName>sample string 19</d3p1:ContactName>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:IsAssigned>true</d3p1:IsAssigned>
        <d3p1:LocationID>sample string 12</d3p1:LocationID>
        <d3p1:LockEntity>8</d3p1:LockEntity>
        <d3p1:LockID>sample string 9</d3p1:LockID>
        <d3p1:MfgModel>sample string 18</d3p1:MfgModel>
        <d3p1:OwnerEntity>4</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 5</d3p1:OwnerID>
        <d3p1:OwnerName>sample string 6</d3p1:OwnerName>
        <d3p1:PhoneNo>sample string 17</d3p1:PhoneNo>
        <d3p1:PrimaryAtmID>sample string 2</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>sample string 3</d3p1:SecondaryAtmID>
        <d3p1:SiteAddress>sample string 16</d3p1:SiteAddress>
        <d3p1:SiteName>sample string 7</d3p1:SiteName>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>sample string 11</d3p1:StatusDescription>
        <d3p1:TermSerialNo>sample string 15</d3p1:TermSerialNo>
        <d3p1:TypeService>sample string 20</d3p1:TypeService>
        <d3p1:UserDefined1>sample string 21</d3p1:UserDefined1>
        <d3p1:UserDefined2>sample string 22</d3p1:UserDefined2>
      </d3p1:AtmViewModel>
      <d3p1:AtmViewModel>
        <d3p1:AtmEntity>1</d3p1:AtmEntity>
        <d3p1:AtmTimeZone>13</d3p1:AtmTimeZone>
        <d3p1:Checked>true</d3p1:Checked>
        <d3p1:ContactName>sample string 19</d3p1:ContactName>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:IsAssigned>true</d3p1:IsAssigned>
        <d3p1:LocationID>sample string 12</d3p1:LocationID>
        <d3p1:LockEntity>8</d3p1:LockEntity>
        <d3p1:LockID>sample string 9</d3p1:LockID>
        <d3p1:MfgModel>sample string 18</d3p1:MfgModel>
        <d3p1:OwnerEntity>4</d3p1:OwnerEntity>
        <d3p1:OwnerID>sample string 5</d3p1:OwnerID>
        <d3p1:OwnerName>sample string 6</d3p1:OwnerName>
        <d3p1:PhoneNo>sample string 17</d3p1:PhoneNo>
        <d3p1:PrimaryAtmID>sample string 2</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>sample string 3</d3p1:SecondaryAtmID>
        <d3p1:SiteAddress>sample string 16</d3p1:SiteAddress>
        <d3p1:SiteName>sample string 7</d3p1:SiteName>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>sample string 11</d3p1:StatusDescription>
        <d3p1:TermSerialNo>sample string 15</d3p1:TermSerialNo>
        <d3p1:TypeService>sample string 20</d3p1:TypeService>
        <d3p1:UserDefined1>sample string 21</d3p1:UserDefined1>
        <d3p1:UserDefined2>sample string 22</d3p1:UserDefined2>
      </d3p1:AtmViewModel>
    </d2p1:ATMs>
  </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>
</BrowseAtmResponse>
© 2025 Sargent and Greenleaf