1.2.0.8
  1. Help
  2. POST RETURN_ALL_ACTIVE_CODES

POST RETURN_ALL_ACTIVE_CODES

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

OperationCodeListRequest
NameDescriptionTypeAdditional information
Page

PageNumber

 integer

Range: inclusive between 1 and 100000
PageSize

Page Size

 integer

Range: inclusive between 1 and 100000

Request Formats

application/json, text/json

Sample: 
{
  "Page": 1,
  "PageSize": 2
}

application/xml, text/xml

Sample: 
<OperationCodeListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.OperationCodesQuery">
  <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">1</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">2</PageSize>
</OperationCodeListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationCodeListResponse

PagedOperationCodeListResponse
NameDescriptionTypeAdditional information
Header

Paged Operation code list response message header.

 ResponseHeader

None.
Body

Paged Operation code list response message body.

 PagedOperationCodeListResponseBody

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

PagedOperationCodeListResponseBody
NameDescriptionTypeAdditional information
PagedOperationCodes

List of Paged Operation codes

 Collection of OperationCode

None.
TotalCount

Total records count.

 integer

None.
PageSize

Page size.

 integer

None.
Page

Page

 integer

None.
PageCount

Number of pages.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "OperationsCodes": [
      {
        "OpCode": 31298306,
        "AtmID": "ATM001",
        "LockID": "235108754400",
        "UserID": "1234",
        "StartDateTime": "2014-07-23T07:00:00",
        "EndDateTime": "2014-07-23T19:00:00",
        "NoKeyIdentifier": null
      },
      {
        "OpCode": 48633999,
        "AtmID": "23349391",
        "LockID": "233493910000",
        "UserID": "1234",
        "StartDateTime": "2014-07-23T07:00:00",
        "EndDateTime": "2014-07-23T19:00:00",
        "NoKeyIdentifier": null
      },
      {
        "OpCode": 19444367,
        "AtmID": "23349391",
        "LockID": "233493910000",
        "UserID": "WilsonFG",
        "StartDateTime": "2014-07-23T07:00:00",
        "EndDateTime": "2014-07-23T19:00:00",
        "NoKeyIdentifier": null
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<OperationCodeListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
  <Body>
    <OperationsCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:OperationCode>
        <d3p1:AtmID>ATM001</d3p1:AtmID>
        <d3p1:EndDateTime>2014-07-23T19:00:00</d3p1:EndDateTime>
        <d3p1:LockID>235108754400</d3p1:LockID>
        <d3p1:NoKeyIdentifier i:nil="true" />
        <d3p1:OpCode>31298306</d3p1:OpCode>
        <d3p1:StartDateTime>2014-07-23T07:00:00</d3p1:StartDateTime>
        <d3p1:UserID>1234</d3p1:UserID>
      </d3p1:OperationCode>
      <d3p1:OperationCode>
        <d3p1:AtmID>23349391</d3p1:AtmID>
        <d3p1:EndDateTime>2014-07-23T19:00:00</d3p1:EndDateTime>
        <d3p1:LockID>233493910000</d3p1:LockID>
        <d3p1:NoKeyIdentifier i:nil="true" />
        <d3p1:OpCode>48633999</d3p1:OpCode>
        <d3p1:StartDateTime>2014-07-23T07:00:00</d3p1:StartDateTime>
        <d3p1:UserID>1234</d3p1:UserID>
      </d3p1:OperationCode>
      <d3p1:OperationCode>
        <d3p1:AtmID>23349391</d3p1:AtmID>
        <d3p1:EndDateTime>2014-07-23T19:00:00</d3p1:EndDateTime>
        <d3p1:LockID>233493910000</d3p1:LockID>
        <d3p1:NoKeyIdentifier i:nil="true" />
        <d3p1:OpCode>19444367</d3p1:OpCode>
        <d3p1:StartDateTime>2014-07-23T07:00:00</d3p1:StartDateTime>
        <d3p1:UserID>WilsonFG</d3p1:UserID>
      </d3p1:OperationCode>
    </OperationsCodes>
  </Body>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:ErrorId i:nil="true" />
    <d2p1:Message></d2p1:Message>
    <d2p1:Status>Ok</d2p1:Status>
    <d2p1:StatusCode>Ok</d2p1:StatusCode>
  </Header>
</OperationCodeListResponse>
© 2026 Sargent and Greenleaf