Request Information

URI Parameters

None.

Body Parameters

UpdateAddTkParmClockSeqRequest

UpdateAddTkParmClockSeqRequest
NameDescriptionTypeAdditional information
DispEntity

Entity value for the dispatcher (database value)

integer

Required

TouchKeyId

Touch Key ID

string

Required

CmdId

Command ID.

integer

Required

TimeStartSetClockDate

Parameter Data - Start Date - valid format ("dd/MM/yyyy")

string

Required

TimeStartSetClockTime

Parameter Data - Start Time - valid format ("HH:mm")

string

Required

SequenceNum

Sequence Number.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "DispEntity": 1,
  "TouchKeyId": "sample string 2",
  "CmdId": 3,
  "TimeStartSetClockDate": "sample string 4",
  "TimeStartSetClockTime": "sample string 5",
  "SequenceNum": 6
}

application/xml, text/xml

Sample:
<UpdateAddTkParmClockSeqRequest 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>
  <SequenceNum>6</SequenceNum>
  <TimeStartSetClockDate>sample string 4</TimeStartSetClockDate>
  <TimeStartSetClockTime>sample string 5</TimeStartSetClockTime>
  <TouchKeyId>sample string 2</TouchKeyId>
</UpdateAddTkParmClockSeqRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpdateAddTkParmClockSeqResponse

UpdateAddTkParmClockSeqResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

UpdateAddTkParmClockSeqResponseBody

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

UpdateAddTkParmClockSeqResponseBody
NameDescriptionTypeAdditional information
TouchKeyParmClockSeqAddModified

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

application/xml, text/xml

Sample:
<UpdateAddTkParmClockSeqResponse 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:TouchKeyParmClockSeqAddModified>true</d2p1:TouchKeyParmClockSeqAddModified>
  </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>
</UpdateAddTkParmClockSeqResponse>

© 2025 Sargent and Greenleaf