This function will return the parameter data for the specified dispatcher and position on the touch key. INPUTS==> DISPATCHER ENTITY, TOUCH KEY ID, COMMAND. RETURN==> parameter data
None.
ReturnTouchKeyParmRequest
ReturnTouchKeyParmRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DispEntity |
Entity value for the dispatcher (database value) |
integer |
Required |
| TouchKeyId |
Touch Key ID |
string |
Required |
| CmdId |
Command ID. |
integer |
Required |
{
"DispEntity": 1,
"TouchKeyId": "sample string 2",
"CmdId": 3
}
<ReturnTouchKeyParmRequest 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> <TouchKeyId>sample string 2</TouchKeyId> </ReturnTouchKeyParmRequest>
Sample not available.
ReturnTouchKeyParmResponse
ReturnTouchKeyParmResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | ReturnTouchKeyParmResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| TouchKeyParms |
Touch Key parameters |
TouchKeyParmModel |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"TouchKeyParms": {
"DispEntity": 1,
"TouchKeyId": "sample string 2",
"CmdId": 3,
"BankModeStatus": "sample string 4",
"AuditStatus": "sample string 5",
"TampResetStatus": "sample string 6",
"TimeStartBankAccess": "2025-11-08T03:19:52.0659341-05:00",
"TimeEndBankAccess": "2025-11-08T03:19:52.0659341-05:00",
"EraseCodes": true,
"NewPcCode": "sample string 8",
"NewOcCode": "sample string 9",
"TimeStartSetClock": "2025-11-08T03:19:52.0659341-05:00",
"SequenceNum": 1,
"AddRevDispEntity": 1
}
}
}
<ReturnTouchKeyParmResponse 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:TouchKeyParms xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.API.Models">
<d3p1:AddRevDispEntity>1</d3p1:AddRevDispEntity>
<d3p1:AuditStatus>sample string 5</d3p1:AuditStatus>
<d3p1:BankModeStatus>sample string 4</d3p1:BankModeStatus>
<d3p1:CmdId>3</d3p1:CmdId>
<d3p1:DispEntity>1</d3p1:DispEntity>
<d3p1:EraseCodes>true</d3p1:EraseCodes>
<d3p1:NewOcCode>sample string 9</d3p1:NewOcCode>
<d3p1:NewPcCode>sample string 8</d3p1:NewPcCode>
<d3p1:SequenceNum>1</d3p1:SequenceNum>
<d3p1:TampResetStatus>sample string 6</d3p1:TampResetStatus>
<d3p1:TimeEndBankAccess>2025-11-08T03:19:52.0659341-05:00</d3p1:TimeEndBankAccess>
<d3p1:TimeStartBankAccess>2025-11-08T03:19:52.0659341-05:00</d3p1:TimeStartBankAccess>
<d3p1:TimeStartSetClock>2025-11-08T03:19:52.0659341-05:00</d3p1:TimeStartSetClock>
<d3p1:TouchKeyId>sample string 2</d3p1:TouchKeyId>
</d2p1:TouchKeyParms>
</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>
</ReturnTouchKeyParmResponse>