Description
| Purpose | Get information on the agent installed in the restaurant |
| Request type | Asynchronous/synchronous |
| Supported agent version | v1, v2 |
| PluggetSystemType | AgentInternal |
{
"taskType": "GetAgentInfo",
"params": {
"async": {
"objectId": 0,
"timeout": 0
},
"sync": {
"objectId": number,
"agentGuid": guid,
"timeout": number
},
}
}Description of parameters
Parameter | Type | Mandatory | Description |
|---|
| taskType |
| + | Task type |
| async |
|
| Asynchronous method call (either synchronous or asynchronous) |
| sync |
|
| Synchronous method call (either synchronous or asynchronous) |
| timeout | int | - | Agent response timeout in seconds, default is 120 seconds |
| objectId | int | - | Restaurant code in the licensing system. If specified, the request goes to the agent with the role rkMid |
| agentGuid | guid | - | Agent Guid. If specified, the request goes to a specific agent |
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetAgentInfo",
"objectId": 0
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
Parameter | Type | Description |
|---|
| taskGuid | guid | The unique code of this task is used when receiving the task through the queue. |
| taskType | string enum | Task type |
| objectId | int | Restaurant code in the licensing system |
| error |
| Error container, see Error Description |
}
,
"error":
,
"agentError":
}
}
|
Parameter | Type | Description |
|---|
| error | string enum | Error container, see Error Description |
| taskResponse | object | The contents of the taskResponse block can be viewed in the article GetAgentInfo Model |