Request Information

URI Parameters

None.

Body Parameters

AddTouchKeyPosRequest

AddTouchKeyPosRequest
NameDescriptionTypeAdditional information
TouchKeyId

Touch Key ID

string

Required

PositionNo

Position number

integer

Required

DispatcherEntity

Dispatcher

integer

None.

CmdId0

Command ID in position 0

integer

None.

CmdId1

Command ID in position 1

integer

None.

CmdId2

Command ID in position 2

integer

None.

CmdId3

Command ID in position 3

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TouchKeyId": "sample string 1",
  "PositionNo": 2,
  "DispatcherEntity": 3,
  "CmdId0": 4,
  "CmdId1": 5,
  "CmdId2": 6,
  "CmdId3": 7
}

application/xml, text/xml

Sample:
<AddTouchKeyPosRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.TouchKey">
  <CmdId0>4</CmdId0>
  <CmdId1>5</CmdId1>
  <CmdId2>6</CmdId2>
  <CmdId3>7</CmdId3>
  <DispatcherEntity>3</DispatcherEntity>
  <PositionNo>2</PositionNo>
  <TouchKeyId>sample string 1</TouchKeyId>
</AddTouchKeyPosRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddTouchKeyResponse

AddTouchKeyPosResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

AddTouchKeyPosResponseBody

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

AddTouchKeyPosResponseBody
NameDescriptionTypeAdditional information
TouchKeyPosSaved

Flag to show if touch key position successfully added

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": {
    "TouchKeyPosSaved": true
  }
}

application/xml, text/xml

Sample:
<AddTouchKeyPosResponse 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:TouchKeyPosSaved>true</d2p1:TouchKeyPosSaved>
  </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>
</AddTouchKeyPosResponse>

© 2025 Sargent and Greenleaf