Request Information

URI Parameters

None.

Body Parameters

EditTouchKeyRequest

EditTouchKeyRequest
NameDescriptionTypeAdditional information
TouchKeyId

Touch Key ID

string

Required

LocationId

Location ID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TouchKeyId": "sample string 1",
  "LocationId": "sample string 2"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EditTouchKeyResponse

EditTouchKeyResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

EditTouchKeyResponseBody

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

EditTouchKeyResponseBody
NameDescriptionTypeAdditional information
TouchKeyModified

Flag to show if touch key successfully modified

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "TouchKeyModified": true
  }
}

application/xml, text/xml

Sample:
<EditTouchKeyResponse 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:TouchKeyModified>true</d2p1:TouchKeyModified>
  </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>
</EditTouchKeyResponse>

© 2025 Sargent and Greenleaf