A Series One Time Code (OTC)
  1. Help
  2. POST BROWSE_ATM

POST BROWSE_ATM

This function will return a list of all available ATMs in the database.

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": "primaryatmid",
  "FilterString": "ATM001",
  "SortOrder": 0,
  "SortColumn": "primaryatmid",
  "Page": 1,
  "PageSize": 15
}

application/xml, text/xml

Sample: 
<BrowseAtmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests.Atm">
  <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">1</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">15</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">primaryatmid</SortColumn>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">Ascending</SortOrder>
  <FilterColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">primaryatmid</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">ATM001</FilterString>
</BrowseAtmRequest>

application/x-www-form-urlencoded

Sample: 
Page=1&PageSize=15&FilterColumn=primaryatmid&FilterString=ATM001&SortColumn=primaryatmid&SortOrder=Ascending

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": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "ATMs": [
      {
        "AtmEntity": 1,
        "PrimaryAtmID": "ATM001",
        "SecondaryAtmID": "ATM002",
        "OwnerEntity": 1,
        "OwnerID": "11B9C9F5B06E",
        "OwnerName": "GroLocks R Us",
        "SiteName": "local",
        "LockEntity": 1,
        "LockID": "020000000000",
        "Status": true,
        "StatusDescription": "Active Combo",
        "LocationID": "999999",
        "AtmTimeZone": 8,
        "DaylightSavingsObserved": true,
        "TermSerialNo": "AAZ",
        "SiteAddress": "http://localhost:85",
        "PhoneNo": "885-9411",
        "MfgModel": "1234",
        "ContactName": "John Smith",
        "TypeService": "Full",
        "UserDefined1": "Atms",
        "UserDefined2": "Atms1"
      },
      {
        "AtmEntity": 2,
        "PrimaryAtmID": "ATM004",
        "SecondaryAtmID": "ATM006",
        "OwnerEntity": 1,
        "OwnerID": "11B9C9F5B06E",
        "OwnerName": "GroLocks R Us",
        "SiteName": "local",
        "LockEntity": 1,
        "LockID": "020000000000",
        "Status": true,
        "StatusDescription": "Active Combo",
        "LocationID": "999999",
        "AtmTimeZone": 6,
        "DaylightSavingsObserved": true,
        "TermSerialNo": "AAZ",
        "SiteAddress": "http://localhost:86",
        "PhoneNo": "885-9416",
        "MfgModel": "1234",
        "ContactName": "John Smith",
        "TypeService": "Full",
        "UserDefined1": "Atms",
        "UserDefined2": "Atms1"
      },
      {
        "AtmEntity": 3,
        "PrimaryAtmID": "ATM006",
        "SecondaryAtmID": "ATM008",
        "OwnerEntity": 1,
        "OwnerID": "11B9C9F5B06E",
        "OwnerName": "GroLocks R Us",
        "SiteName": "local",
        "LockEntity": 1,
        "LockID": "020000000000",
        "Status": true,
        "StatusDescription": "Active Combo",
        "LocationID": "999999",
        "AtmTimeZone": 4,
        "DaylightSavingsObserved": false,
        "TermSerialNo": "AAZ",
        "SiteAddress": "http://localhost:87",
        "PhoneNo": "885-9421",
        "MfgModel": "1234",
        "ContactName": "John Smith",
        "TypeService": "Full",
        "UserDefined1": "Atms",
        "UserDefined2": "Atms1"
      }
    ],
    "TotalCount": 82,
    "PageSize": 15,
    "Page": 1,
    "PageCount": 6
  }
}

application/xml, text/xml

Sample: 
<BrowseAtmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses.Atm">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses.Atm" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
    <Page>1</Page>
    <PageCount>6</PageCount>
    <PageSize>15</PageSize>
    <TotalCount>82</TotalCount>
    <d2p1:ATMs xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models">
      <d3p1:AtmViewModel>
        <d3p1:AtmEntity>1</d3p1:AtmEntity>
        <d3p1:AtmTimeZone>8</d3p1:AtmTimeZone>
        <d3p1:ContactName>John Smith</d3p1:ContactName>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:LocationID>999999</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>020000000000</d3p1:LockID>
        <d3p1:MfgModel>1234</d3p1:MfgModel>
        <d3p1:OwnerEntity>1</d3p1:OwnerEntity>
        <d3p1:OwnerID>11B9C9F5B06E</d3p1:OwnerID>
        <d3p1:OwnerName>GroLocks R Us</d3p1:OwnerName>
        <d3p1:PhoneNo>885-9411</d3p1:PhoneNo>
        <d3p1:PrimaryAtmID>ATM001</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>ATM002</d3p1:SecondaryAtmID>
        <d3p1:SiteAddress>http://localhost:85</d3p1:SiteAddress>
        <d3p1:SiteName>local</d3p1:SiteName>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>Active Combo</d3p1:StatusDescription>
        <d3p1:TermSerialNo>AAZ</d3p1:TermSerialNo>
        <d3p1:TypeService>Full</d3p1:TypeService>
        <d3p1:UserDefined1>Atms</d3p1:UserDefined1>
        <d3p1:UserDefined2>Atms1</d3p1:UserDefined2>
      </d3p1:AtmViewModel>
      <d3p1:AtmViewModel>
        <d3p1:AtmEntity>2</d3p1:AtmEntity>
        <d3p1:AtmTimeZone>6</d3p1:AtmTimeZone>
        <d3p1:ContactName>John Smith</d3p1:ContactName>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:LocationID>999999</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>020000000000</d3p1:LockID>
        <d3p1:MfgModel>1234</d3p1:MfgModel>
        <d3p1:OwnerEntity>1</d3p1:OwnerEntity>
        <d3p1:OwnerID>11B9C9F5B06E</d3p1:OwnerID>
        <d3p1:OwnerName>GroLocks R Us</d3p1:OwnerName>
        <d3p1:PhoneNo>885-9416</d3p1:PhoneNo>
        <d3p1:PrimaryAtmID>ATM004</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>ATM006</d3p1:SecondaryAtmID>
        <d3p1:SiteAddress>http://localhost:86</d3p1:SiteAddress>
        <d3p1:SiteName>local</d3p1:SiteName>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>Active Combo</d3p1:StatusDescription>
        <d3p1:TermSerialNo>AAZ</d3p1:TermSerialNo>
        <d3p1:TypeService>Full</d3p1:TypeService>
        <d3p1:UserDefined1>Atms</d3p1:UserDefined1>
        <d3p1:UserDefined2>Atms1</d3p1:UserDefined2>
      </d3p1:AtmViewModel>
      <d3p1:AtmViewModel>
        <d3p1:AtmEntity>3</d3p1:AtmEntity>
        <d3p1:AtmTimeZone>4</d3p1:AtmTimeZone>
        <d3p1:ContactName>John Smith</d3p1:ContactName>
        <d3p1:DaylightSavingsObserved>false</d3p1:DaylightSavingsObserved>
        <d3p1:LocationID>999999</d3p1:LocationID>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockID>020000000000</d3p1:LockID>
        <d3p1:MfgModel>1234</d3p1:MfgModel>
        <d3p1:OwnerEntity>1</d3p1:OwnerEntity>
        <d3p1:OwnerID>11B9C9F5B06E</d3p1:OwnerID>
        <d3p1:OwnerName>GroLocks R Us</d3p1:OwnerName>
        <d3p1:PhoneNo>885-9421</d3p1:PhoneNo>
        <d3p1:PrimaryAtmID>ATM006</d3p1:PrimaryAtmID>
        <d3p1:SecondaryAtmID>ATM008</d3p1:SecondaryAtmID>
        <d3p1:SiteAddress>http://localhost:87</d3p1:SiteAddress>
        <d3p1:SiteName>local</d3p1:SiteName>
        <d3p1:Status>true</d3p1:Status>
        <d3p1:StatusDescription>Active Combo</d3p1:StatusDescription>
        <d3p1:TermSerialNo>AAZ</d3p1:TermSerialNo>
        <d3p1:TypeService>Full</d3p1:TypeService>
        <d3p1:UserDefined1>Atms</d3p1:UserDefined1>
        <d3p1:UserDefined2>Atms1</d3p1:UserDefined2>
      </d3p1:AtmViewModel>
    </d2p1:ATMs>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</BrowseAtmResponse>
© 2025 Sargent and Greenleaf