Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Entity value for owner (database value)

integer

Required

Body Parameters

None.

Response Information

Resource Description

GetAtmResponse

GetAtmResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

GetAtmResponseBody

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

GetAtmResponseBody
NameDescriptionTypeAdditional information
ATM

ATM entity.

AtmModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "ATM": {
      "AtmEntity": 2,
      "AtmId": "ATM004",
      "OwnerEntity": 1,
      "TermSerialNo": "AAZ",
      "SiteName": "Local",
      "SiteAddress": "http://localhost:85",
      "SiteNo": "12",
      "PhoneNo": "885-9429",
      "MfgModel": "11C",
      "ContactName": "John Smith",
      "TypeService": "Full",
      "UserDefined1": "Atms 2",
      "UserDefined2": "Atm2",
      "TimeOffset": 0,
      "LockEntity": 1,
      "Status": true,
      "DaylightSavingsObserved": true,
      "PrevAtmId": "Atm3",
      "AtmIdChangeDate": "2025-11-08T03:13:30.5222036-05:00",
      "LocationId": "999999",
      "AtmTimeZone": 5,
      "Lock": {
        "LockEntity": 1,
        "OwnerEntity": 1,
        "LockId": "010000000000",
        "KeyLockOwner0": "53FEB5306420CD02",
        "KeyLockOwner1": "53FEB5306420CD02",
        "BankModeStatus": "96",
        "BankModeStart": "2025-11-08T03:13:30.5222036-05:00",
        "BankModeEnd": "2025-11-08T03:13:30.5222036-05:00",
        "TampResetStatus": "96",
        "AuditStatus": "96",
        "LockInitialize": true,
        "PCcode": 0,
        "OCcode": 0,
        "ErasePcoc": false,
        "PendBankModeStatus": "0",
        "PendBankModeStart": "2025-11-08T03:13:30.5222036-05:00",
        "PendBankModeEnd": "2025-11-08T03:13:30.5222036-05:00",
        "PendTampResetStatus": "0",
        "PendAuditStatus": "0",
        "PendLockInitialize": true,
        "PendLockUnInstall": true,
        "PendPCcode": 0,
        "PendOCcode": 0,
        "PendErasePcoc": false,
        "ChangeStatus": true,
        "SetClockCalSeqNo": 1,
        "LocationId": "999999"
      }
    }
  }
}

application/xml, text/xml

Sample:
<GetAtmResponse 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">
    <d2p1:ATM xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:AtmEntity>2</d3p1:AtmEntity>
      <d3p1:AtmId>ATM004</d3p1:AtmId>
      <d3p1:AtmIdChangeDate>2025-11-08T03:13:30.5222036-05:00</d3p1:AtmIdChangeDate>
      <d3p1:AtmTimeZone>5</d3p1:AtmTimeZone>
      <d3p1:ContactName>John Smith</d3p1:ContactName>
      <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
      <d3p1:LocationId>999999</d3p1:LocationId>
      <d3p1:Lock>
        <d3p1:AuditStatus>96</d3p1:AuditStatus>
        <d3p1:BankModeEnd>2025-11-08T03:13:30.5222036-05:00</d3p1:BankModeEnd>
        <d3p1:BankModeStart>2025-11-08T03:13:30.5222036-05:00</d3p1:BankModeStart>
        <d3p1:BankModeStatus>96</d3p1:BankModeStatus>
        <d3p1:ChangeStatus>true</d3p1:ChangeStatus>
        <d3p1:ErasePcoc>false</d3p1:ErasePcoc>
        <d3p1:KeyLockOwner0>53FEB5306420CD02</d3p1:KeyLockOwner0>
        <d3p1:KeyLockOwner1>53FEB5306420CD02</d3p1:KeyLockOwner1>
        <d3p1:LocationId>999999</d3p1:LocationId>
        <d3p1:LockEntity>1</d3p1:LockEntity>
        <d3p1:LockId>010000000000</d3p1:LockId>
        <d3p1:LockInitialize>true</d3p1:LockInitialize>
        <d3p1:OCcode>0</d3p1:OCcode>
        <d3p1:OwnerEntity>1</d3p1:OwnerEntity>
        <d3p1:PCcode>0</d3p1:PCcode>
        <d3p1:PendAuditStatus>0</d3p1:PendAuditStatus>
        <d3p1:PendBankModeEnd>2025-11-08T03:13:30.5222036-05:00</d3p1:PendBankModeEnd>
        <d3p1:PendBankModeStart>2025-11-08T03:13:30.5222036-05:00</d3p1:PendBankModeStart>
        <d3p1:PendBankModeStatus>0</d3p1:PendBankModeStatus>
        <d3p1:PendErasePcoc>false</d3p1:PendErasePcoc>
        <d3p1:PendLockInitialize>true</d3p1:PendLockInitialize>
        <d3p1:PendLockUnInstall>true</d3p1:PendLockUnInstall>
        <d3p1:PendOCcode>0</d3p1:PendOCcode>
        <d3p1:PendPCcode>0</d3p1:PendPCcode>
        <d3p1:PendTampResetStatus>0</d3p1:PendTampResetStatus>
        <d3p1:SetClockCalSeqNo>1</d3p1:SetClockCalSeqNo>
        <d3p1:TampResetStatus>96</d3p1:TampResetStatus>
      </d3p1:Lock>
      <d3p1:LockEntity>1</d3p1:LockEntity>
      <d3p1:MfgModel>11C</d3p1:MfgModel>
      <d3p1:OwnerEntity>1</d3p1:OwnerEntity>
      <d3p1:PhoneNo>885-9429</d3p1:PhoneNo>
      <d3p1:PrevAtmId>Atm3</d3p1:PrevAtmId>
      <d3p1:SiteAddress>http://localhost:85</d3p1:SiteAddress>
      <d3p1:SiteName>Local</d3p1:SiteName>
      <d3p1:SiteNo>12</d3p1:SiteNo>
      <d3p1:Status>true</d3p1:Status>
      <d3p1:TermSerialNo>AAZ</d3p1:TermSerialNo>
      <d3p1:TimeOffset>0</d3p1:TimeOffset>
      <d3p1:TypeService>Full</d3p1:TypeService>
      <d3p1:UserDefined1>Atms 2</d3p1:UserDefined1>
      <d3p1:UserDefined2>Atm2</d3p1:UserDefined2>
    </d2p1:ATM>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</GetAtmResponse>

© 2025 Sargent and Greenleaf