Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Touchkey ID

string

Required

Body Parameters

None.

Response Information

Resource Description

GetOpenOpCodesViaTouchkeyResponse

OpenOperationCodesViaTouchkeyResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

OpenOperationCodesViaTouchkeyResponseBody

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

OpenOperationCodesViaTouchkeyResponseBody
NameDescriptionTypeAdditional information
OpenOperationCode

Collection of OpenOperationCodeView

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "OpenOperationCode": [
      {
        "OpCodeEntity": 1,
        "OperationCode": 1,
        "EmployeeID": "sample string 2",
        "Assignment": "sample string 3",
        "Command": "sample string 4",
        "ATMIDPrimary": "sample string 5",
        "ATMIDSecondary": "sample string 6",
        "SiteName": "sample string 7",
        "RouteID": "sample string 8",
        "StartTime": "2025-11-08T03:23:01.9787022-05:00",
        "EndTime": "2025-11-08T03:23:01.9787022-05:00",
        "TouchKeyID": "sample string 9",
        "LockID": "sample string 10",
        "CmdSeqHex": "sample string 11",
        "DaylightSavingsObserved": true,
        "LocationID": "sample string 13"
      },
      {
        "OpCodeEntity": 1,
        "OperationCode": 1,
        "EmployeeID": "sample string 2",
        "Assignment": "sample string 3",
        "Command": "sample string 4",
        "ATMIDPrimary": "sample string 5",
        "ATMIDSecondary": "sample string 6",
        "SiteName": "sample string 7",
        "RouteID": "sample string 8",
        "StartTime": "2025-11-08T03:23:01.9787022-05:00",
        "EndTime": "2025-11-08T03:23:01.9787022-05:00",
        "TouchKeyID": "sample string 9",
        "LockID": "sample string 10",
        "CmdSeqHex": "sample string 11",
        "DaylightSavingsObserved": true,
        "LocationID": "sample string 13"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<OpenOperationCodesViaTouchkeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.OpCode" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:OpenOperationCode xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.Business.Models.Views">
      <d3p1:OpenOperationCodeView>
        <d3p1:ATMIDPrimary>sample string 5</d3p1:ATMIDPrimary>
        <d3p1:ATMIDSecondary>sample string 6</d3p1:ATMIDSecondary>
        <d3p1:Assignment>sample string 3</d3p1:Assignment>
        <d3p1:CmdSeqHex>sample string 11</d3p1:CmdSeqHex>
        <d3p1:Command>sample string 4</d3p1:Command>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:EmployeeID>sample string 2</d3p1:EmployeeID>
        <d3p1:EndTime>2025-11-08T03:23:01.9787022-05:00</d3p1:EndTime>
        <d3p1:LocationID>sample string 13</d3p1:LocationID>
        <d3p1:LockID>sample string 10</d3p1:LockID>
        <d3p1:OpCodeEntity>1</d3p1:OpCodeEntity>
        <d3p1:OperationCode>1</d3p1:OperationCode>
        <d3p1:RouteID>sample string 8</d3p1:RouteID>
        <d3p1:SiteName>sample string 7</d3p1:SiteName>
        <d3p1:StartTime>2025-11-08T03:23:01.9787022-05:00</d3p1:StartTime>
        <d3p1:TouchKeyID>sample string 9</d3p1:TouchKeyID>
      </d3p1:OpenOperationCodeView>
      <d3p1:OpenOperationCodeView>
        <d3p1:ATMIDPrimary>sample string 5</d3p1:ATMIDPrimary>
        <d3p1:ATMIDSecondary>sample string 6</d3p1:ATMIDSecondary>
        <d3p1:Assignment>sample string 3</d3p1:Assignment>
        <d3p1:CmdSeqHex>sample string 11</d3p1:CmdSeqHex>
        <d3p1:Command>sample string 4</d3p1:Command>
        <d3p1:DaylightSavingsObserved>true</d3p1:DaylightSavingsObserved>
        <d3p1:EmployeeID>sample string 2</d3p1:EmployeeID>
        <d3p1:EndTime>2025-11-08T03:23:01.9787022-05:00</d3p1:EndTime>
        <d3p1:LocationID>sample string 13</d3p1:LocationID>
        <d3p1:LockID>sample string 10</d3p1:LockID>
        <d3p1:OpCodeEntity>1</d3p1:OpCodeEntity>
        <d3p1:OperationCode>1</d3p1:OperationCode>
        <d3p1:RouteID>sample string 8</d3p1:RouteID>
        <d3p1:SiteName>sample string 7</d3p1:SiteName>
        <d3p1:StartTime>2025-11-08T03:23:01.9787022-05:00</d3p1:StartTime>
        <d3p1:TouchKeyID>sample string 9</d3p1:TouchKeyID>
      </d3p1:OpenOperationCodeView>
    </d2p1:OpenOperationCode>
  </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>
</OpenOperationCodesViaTouchkeyResponse>

© 2025 Sargent and Greenleaf