This function will return the position on the touch key for the specified command and dispatcher. INPUTS==> DISPATCHER ENTITY, TOUCH KEY ID, COMMAND ID. RETURN==> COMMAND POSITION
None.
ReturnDispTkCmdPosRequest
ReturnDispTkCmdPosRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DispEntity |
Entity value for the dispatcher (database value) |
integer |
Required |
| TouchKeyId |
Touch Key ID of the technician |
string |
Required |
| CmdId |
Command ID of the command |
integer |
Required |
{
"DispEntity": 1,
"TouchKeyId": "sample string 2",
"CmdId": 3
}
<ReturnDispTkCmdPosRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Dispatcher"> <CmdId>3</CmdId> <DispEntity>1</DispEntity> <TouchKeyId>sample string 2</TouchKeyId> </ReturnDispTkCmdPosRequest>
Sample not available.
ReturnDispTkCmdPosResponse
ReturnDispTkCmdPosResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
Dispatcher TouchKEy Cmd Position response message header. |
ResponseHeader |
None. |
| Body |
Dispatcher TouchKEy Cmd Position response message body. |
ReturnDispTkCmdPosResponseBody |
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 |
|---|---|---|---|
| DispatcherTouchKeyPos |
Touch Key position for the command / dispatcher |
integer |
None. |
{
"Header": {
"Message": "sample string 1",
"StatusCode": 0,
"Status": "sample string 2",
"ErrorId": "sample string 3"
},
"Body": {
"DispatcherTouchKeyPos": 1
}
}
<ReturnDispTkCmdPosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Dispatcher">
<Body>
<DispatcherTouchKeyPos>1</DispatcherTouchKeyPos>
</Body>
<Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:ErrorId>sample string 3</d2p1:ErrorId>
<d2p1:Message>sample string 1</d2p1:Message>
<d2p1:Status>sample string 2</d2p1:Status>
<d2p1:StatusCode>Ok</d2p1:StatusCode>
</Header>
</ReturnDispTkCmdPosResponse>