Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

TouchKey ID

string

Required

Body Parameters

None.

Response Information

Resource Description

GetTouchKeyResponse

GetTouchKeyResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

GetTouchKeyResponseBody

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

GetTouchKeyResponseBody
NameDescriptionTypeAdditional information
TouchKey

Entity value for the touch key (database value)

TouchKeyModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "TouchKey": {
      "TouchKeyId": "sample string 1",
      "AccessorId": 2,
      "TypeKey": "sample string 3",
      "BlockCount": 1,
      "Status": true,
      "LocationId": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:
<GetTouchKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.TouchKey">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.TouchKey" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:TouchKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:AccessorId>2</d3p1:AccessorId>
      <d3p1:BlockCount>1</d3p1:BlockCount>
      <d3p1:LocationId>sample string 5</d3p1:LocationId>
      <d3p1:Status>true</d3p1:Status>
      <d3p1:TouchKeyId>sample string 1</d3p1:TouchKeyId>
      <d3p1:TypeKey>sample string 3</d3p1:TypeKey>
    </d2p1:TouchKey>
  </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>
</GetTouchKeyResponse>

© 2025 Sargent and Greenleaf