This function will add a new ATM record to the database. INPUTS==> ATM information (ATM ID, OWNER ENTITY, SITE NAME, ...) RETURN==> (result)
None.
AddAtmRequest
AddAtmRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AtmId |
ATM ID of the ATM to be added |
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. |
| LockEntity |
Entity value for lock (database value) |
integer |
Range: inclusive between 0 and 2147483647 |
| Status |
Status. |
boolean |
None. |
| 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. |
{
"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
}
<AddAtmRequest 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> </AddAtmRequest>
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
AddAtmResponse
AddAtmResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | AddAtmResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| AtmEntity |
Entity value for ATM (database value) |
integer |
None. |
| AtmSaved |
Flag to show if ATM record was saved |
boolean |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"AtmEntity": 1,
"AtmSaved": true
}
}
<AddAtmResponse 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:AtmEntity>1</d2p1:AtmEntity>
<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>
</AddAtmResponse>