Request Information

URI Parameters

NameDescriptionTypeAdditional information
dispEntity

Entity value for the dispatcher key (database value)

integer

Required

Body Parameters

None.

Response Information

Resource Description

CheckTouchKeyPosResponse

CheckTouchKeyPosAssignedResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

CheckTouchKeyPosAssignedResponseBody

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

CheckTouchKeyPosAssignedResponseBody
NameDescriptionTypeAdditional information
TouchKeyPosAssigned

Flag to show if touch key position is assigned

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "TouchKeyPosAssigned": true
  }
}

application/xml, text/xml

Sample:
<CheckTouchKeyPosAssignedResponse 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:TouchKeyPosAssigned>true</d2p1:TouchKeyPosAssigned>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</CheckTouchKeyPosAssignedResponse>

© 2025 Sargent and Greenleaf