Request Information

URI Parameters

None.

Body Parameters

UpdateAddTkParmNewPcOcEraseCodeRequest

UpdateAddTkParmNewPcOcEraseCodeRequest
NameDescriptionTypeAdditional information
DispEntity

Entity value for the dispatcher (database value)

integer

Required

TouchKeyId

Touch Key ID

string

Required

CmdId

Command ID.

integer

Required

EraseCodes

Parameter Data - flag to erase codes

boolean

Required

NewPCcode

Parameter Data - New PC Code

string

Required

NewOCcode

Parameter Data - New OC Code

string

Required

Request Formats

application/json, text/json

Sample:
{
  "DispEntity": 1,
  "TouchKeyId": "sample string 2",
  "CmdId": 3,
  "EraseCodes": true,
  "NewPCcode": "sample string 5",
  "NewOCcode": "sample string 6"
}

application/xml, text/xml

Sample:
<UpdateAddTkParmNewPcOcEraseCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.TouchKey">
  <CmdId>3</CmdId>
  <DispEntity>1</DispEntity>
  <EraseCodes>true</EraseCodes>
  <NewOCcode>sample string 6</NewOCcode>
  <NewPCcode>sample string 5</NewPCcode>
  <TouchKeyId>sample string 2</TouchKeyId>
</UpdateAddTkParmNewPcOcEraseCodeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpdateAddTkParmNewPcOcEraseCodeResponse

UpdateAddTkParmNewPcOcEraseCodeResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

UpdateAddTkParmNewPcOcEraseCodeResponseBody

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

UpdateAddTkParmNewPcOcEraseCodeResponseBody
NameDescriptionTypeAdditional information
TouchKeyParmPcOcEraseCodeAddModified

Flag to show if parameter data successfully saved

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

application/xml, text/xml

Sample:
<UpdateAddTkParmNewPcOcEraseCodeResponse 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:TouchKeyParmPcOcEraseCodeAddModified>true</d2p1:TouchKeyParmPcOcEraseCodeAddModified>
  </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>
</UpdateAddTkParmNewPcOcEraseCodeResponse>

© 2025 Sargent and Greenleaf