Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

BrowseTouchKeyPosRequest

string

Required

Body Parameters

None.

Response Information

Resource Description

BrowseTouchKeyPosResponse

BrowseTouchKeyPosResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

BrowseTouchKeyPosResponseBody

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

BrowseTouchKeyPosResponseBody
NameDescriptionTypeAdditional information
TouchKeyPositions

List of touchkey positions.

Collection of TouchKeyPosViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "TouchKeyPositions": [
      {
        "TouchKeyId": "sample string 1",
        "PositionNo": 1,
        "DispEntity": 1,
        "DispName": "sample string 2",
        "CmdId0": 1,
        "Cmd1Description": "sample string 3",
        "CmdId1": 1,
        "Cmd2Description": "sample string 4",
        "CmdId2": 1,
        "Cmd3Description": "sample string 5",
        "CmdId3": 1,
        "Cmd4Description": "sample string 6"
      },
      {
        "TouchKeyId": "sample string 1",
        "PositionNo": 1,
        "DispEntity": 1,
        "DispName": "sample string 2",
        "CmdId0": 1,
        "Cmd1Description": "sample string 3",
        "CmdId1": 1,
        "Cmd2Description": "sample string 4",
        "CmdId2": 1,
        "Cmd3Description": "sample string 5",
        "CmdId3": 1,
        "Cmd4Description": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<BrowseTouchKeyPosResponse 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:TouchKeyPositions xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
      <d3p1:TouchKeyPosViewModel>
        <d3p1:Cmd1Description>sample string 3</d3p1:Cmd1Description>
        <d3p1:Cmd2Description>sample string 4</d3p1:Cmd2Description>
        <d3p1:Cmd3Description>sample string 5</d3p1:Cmd3Description>
        <d3p1:Cmd4Description>sample string 6</d3p1:Cmd4Description>
        <d3p1:CmdId0>1</d3p1:CmdId0>
        <d3p1:CmdId1>1</d3p1:CmdId1>
        <d3p1:CmdId2>1</d3p1:CmdId2>
        <d3p1:CmdId3>1</d3p1:CmdId3>
        <d3p1:DispEntity>1</d3p1:DispEntity>
        <d3p1:DispName>sample string 2</d3p1:DispName>
        <d3p1:PositionNo>1</d3p1:PositionNo>
        <d3p1:TouchKeyId>sample string 1</d3p1:TouchKeyId>
      </d3p1:TouchKeyPosViewModel>
      <d3p1:TouchKeyPosViewModel>
        <d3p1:Cmd1Description>sample string 3</d3p1:Cmd1Description>
        <d3p1:Cmd2Description>sample string 4</d3p1:Cmd2Description>
        <d3p1:Cmd3Description>sample string 5</d3p1:Cmd3Description>
        <d3p1:Cmd4Description>sample string 6</d3p1:Cmd4Description>
        <d3p1:CmdId0>1</d3p1:CmdId0>
        <d3p1:CmdId1>1</d3p1:CmdId1>
        <d3p1:CmdId2>1</d3p1:CmdId2>
        <d3p1:CmdId3>1</d3p1:CmdId3>
        <d3p1:DispEntity>1</d3p1:DispEntity>
        <d3p1:DispName>sample string 2</d3p1:DispName>
        <d3p1:PositionNo>1</d3p1:PositionNo>
        <d3p1:TouchKeyId>sample string 1</d3p1:TouchKeyId>
      </d3p1:TouchKeyPosViewModel>
    </d2p1:TouchKeyPositions>
  </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>
</BrowseTouchKeyPosResponse>

© 2025 Sargent and Greenleaf