Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Entity value for the ATM (database value)

integer

Required

Body Parameters

AssignLockToAtmRequest

AssignLockToAtmRequest
NameDescriptionTypeAdditional information
LockEntity

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "LockEntity": 1
}

application/xml, text/xml

Sample:
<AssignLockToAtmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Atm">
  <LockEntity>1</LockEntity>
</AssignLockToAtmRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AssignLockToAtmResponse

AssignLockToAtmResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

AssignLockToAtmResponseBody

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

AssignLockToAtmResponseBody
NameDescriptionTypeAdditional information
LockAssigned

Flag to show if lock was successfully assigned

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "LockAssigned": true
  }
}

application/xml, text/xml

Sample:
<AssignLockToAtmResponse 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:LockAssigned>true</d2p1:LockAssigned>
  </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>
</AssignLockToAtmResponse>

© 2025 Sargent and Greenleaf