Request Information

URI Parameters

None.

Body Parameters

GetAvailableTouchkeysRequest

BrowseTouchKeyMgmtRequest
NameDescriptionTypeAdditional information
AccessorID

Accessor ID to search for the touch key

integer

Required

CmdID

Command ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AccessorID": 1,
  "CmdID": 2
}

application/xml, text/xml

Sample:
<BrowseTouchKeyMgmtRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.TouchKey">
  <AccessorID>1</AccessorID>
  <CmdID>2</CmdID>
</BrowseTouchKeyMgmtRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAvailableTouchkeysResponse

BrowseTouchKeyMgmtResponse
NameDescriptionTypeAdditional information
Header

Browse Management Touchkeys Response message header.

ResponseHeader

None.

Body

Browse Management Touchkeys Response message body.

BrowseTouchKeyMgmtResponseBody

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

BrowseTouchKeyMgmtResponseBody
NameDescriptionTypeAdditional information
MgmtTouchKeys

List of touch keys of type "manager"

Collection of string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<BrowseTouchKeyMgmtResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.TouchKey">
  <Body>
    <MgmtTouchKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MgmtTouchKeys>
  </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>
</BrowseTouchKeyMgmtResponse>

© 2025 Sargent and Greenleaf