Request Information

URI Parameters

None.

Body Parameters

GetAvailableTouchkeysRequest

BrowseAvailableTouchkeysRequest
NameDescriptionTypeAdditional information
TypeKey

Touch Key type

string

Required

Request Formats

application/json, text/json

Sample:
{
  "TypeKey": "sample string 1"
}

application/xml, text/xml

Sample:
<BrowseAvailableTouchkeysRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.TouchKey">
  <TypeKey>sample string 1</TypeKey>
</BrowseAvailableTouchkeysRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAvailableTouchkeysResponse

BrowseAvailableTouchkeysResponse
NameDescriptionTypeAdditional information
Header

Browse Available Touchkeys Response message header.

ResponseHeader

None.

Body

Browse Available Touchkeys Response message body.

BrowseAvailableTouchkeysResponseBody

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

BrowseAvailableTouchkeysResponseBody
NameDescriptionTypeAdditional information
AvailableTouchKeys

List of available touch keys

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": {
    "AvailableTouchKeys": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

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

© 2025 Sargent and Greenleaf