1. Help
  2. POST GENERATE_MGMT_CODE

POST GENERATE_MGMT_CODE

This function generates a management operation code to open the lock using the inputs ATM, USER, TOUCH KEY, TIME, DATE, TIME BLOCK and LOCK STATUS. INPUTS==> ATM ENTITY, DISPATCHER ENTITY, ACCESSOR ID, TOUCH KEY ID, POSITION, LOCK STATUS, COMMAND, DATE, HOUR, TIME BLOCK, PARAMETERS. RETURN==> OPERATION CODE

Request Information

URI Parameters

None.

Body Parameters

OpenLockARequest

ManagementGenOpCodeRequest
NameDescriptionTypeAdditional information
AtmEntity

Entity value for the ATM (database value)

 integer

Required
DispEntity

Entity value for the dispatcher (database value)

 integer

Required
AccessorID

User ID of the technician performing the management command

 integer

Required
TouchKeyID

Touch Key ID for the touch key performing the management command

 string

Required
Position

Position the command is found on the touch key

 integer

Required
LockStatus

Lock status (0 = normal status)

 integer

Required

Range: inclusive between 0 and 17
CommandID

Command ID

 integer

Required
Date

Operation date. Valid formats ("dd/MM/yyyy", "dd-MM-yyyy", "ddMMyyyy")

 string

Required
Hour

Operation hour

 integer

Required

Range: inclusive between 0 and 23
TimeBlock

Time block. Valid values (4, 8, 12, 24)

 integer

Required
Parm

Parameters required for the management command

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "AtmEntity": 1,
  "DispEntity": 2,
  "AccessorID": 3,
  "TouchKeyID": "sample string 4",
  "Position": 5,
  "LockStatus": 6,
  "CommandID": 7,
  "Date": "sample string 8",
  "Hour": 9,
  "TimeBlock": 10,
  "Parm": "sample string 11"
}

application/xml, text/xml

Sample: 
<ManagementGenOpCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.ManagementGenOpCode">
  <AccessorID>3</AccessorID>
  <AtmEntity>1</AtmEntity>
  <CommandID>7</CommandID>
  <Date>sample string 8</Date>
  <DispEntity>2</DispEntity>
  <Hour>9</Hour>
  <LockStatus>6</LockStatus>
  <Parm>sample string 11</Parm>
  <Position>5</Position>
  <TimeBlock>10</TimeBlock>
  <TouchKeyID>sample string 4</TouchKeyID>
</ManagementGenOpCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationCodeResponse

OperationCodeResponse
NameDescriptionTypeAdditional information
Header

Operation code response message header.

 ResponseHeader

None.
Body

Operation code response message body.

 OperationCodeResponseBody

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

OperationCodeResponseBody
NameDescriptionTypeAdditional information
OperationCode

Operation code

 integer

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<OperationCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
  <Body>
    <OperationCode>1</OperationCode>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId>sample string 3</d2p1:ErrorId>
    <d2p1:Message>sample string 1</d2p1:Message>
    <d2p1:Status>sample string 2</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</OperationCodeResponse>
© 2025 Sargent and Greenleaf