Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Entity value for ATM (database value)

integer

Required

Body Parameters

EditAtmRequest

EditAtmRequest
NameDescriptionTypeAdditional information
AtmId

ATM ID of the ATM to be modified

string

Required

OwnerEntity

Entity value for owner (database value)

integer

Range: inclusive between 0 and 2147483647

TermSerialNo

Terminal serial number

string

None.

SiteName

Site name.

string

Required

SiteAddress

Site address.

string

None.

SiteNo

Site number.

string

None.

PhoneNo

Phone number.

string

None.

MfgModel

Manufacturing model.

string

None.

ContactName

Contact name.

string

None.

TypeService

Type service.

string

None.

UserDefined1

User defined 1

string

None.

UserDefined2

User defined 2

string

None.

TimeOffset

Time offset

integer

None.

Status

Status.

boolean

None.

LockEntity

Entity value for lock (database value)

integer

Range: inclusive between 0 and 2147483647

DaylightSavingsObserved

Daylight savings time observed.

boolean

None.

PrevAtmId

Previous ATM ID

string

None.

LocationId

Location ID

string

None.

AtmTimeZone

Time Zone for ATM

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AtmId": "ATM001",
  "OwnerEntity": 1,
  "TermSerialNo": "AAZ",
  "SiteName": "Local site",
  "SiteAddress": "http://localhost:85",
  "SiteNo": "12",
  "PhoneNo": "885-9410",
  "MfgModel": "11C",
  "ContactName": "John Smith",
  "TypeService": "Full",
  "UserDefined1": "Atms 2",
  "UserDefined2": "Atm2",
  "TimeOffset": 0,
  "Status": true,
  "LockEntity": 1,
  "DaylightSavingsObserved": true,
  "PrevAtmId": "Atm3",
  "LocationId": "999999",
  "AtmTimeZone": 8
}

application/xml, text/xml

Sample:
<EditAtmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Atm">
  <AtmId>ATM001</AtmId>
  <AtmTimeZone>8</AtmTimeZone>
  <ContactName>John Smith</ContactName>
  <DaylightSavingsObserved>true</DaylightSavingsObserved>
  <LocationId>999999</LocationId>
  <LockEntity>1</LockEntity>
  <MfgModel>11C</MfgModel>
  <OwnerEntity>1</OwnerEntity>
  <PhoneNo>885-9410</PhoneNo>
  <PrevAtmId>Atm3</PrevAtmId>
  <SiteAddress>http://localhost:85</SiteAddress>
  <SiteName>Local site</SiteName>
  <SiteNo>12</SiteNo>
  <Status>true</Status>
  <TermSerialNo>AAZ</TermSerialNo>
  <TimeOffset>0</TimeOffset>
  <TypeService>Full</TypeService>
  <UserDefined1>Atms 2</UserDefined1>
  <UserDefined2>Atm2</UserDefined2>
</EditAtmRequest>

application/x-www-form-urlencoded

Sample:
AtmId=ATM001&OwnerEntity=1&TermSerialNo=AAZ&SiteName=Local site&SiteAddress=http://localhost:85&SiteNo=12&PhoneNo=885-9410&MfgModel=11C&ContactName=John Smith&TypeService=Full&UserDefined1=Atms 2&UserDefined2=Atm2&TimeOffset=0&LockEntity=1&Status=True&DaylightSavingsObserved=True&PrevAtmId=Atm3&LocationId=999999&AtmTimeZone=8

Response Information

Resource Description

EditAtmResponse

EditAtmResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

EditAtmResponseBody

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

EditAtmResponseBody
NameDescriptionTypeAdditional information
AtmSaved

Flag to show if ATM record was saved

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "AtmSaved": true
  }
}

application/xml, text/xml

Sample:
<EditAtmResponse 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:AtmSaved>true</d2p1:AtmSaved>
  </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>
</EditAtmResponse>

© 2025 Sargent and Greenleaf