RunPluginCommand

Purpose	Sending a command to the Agent plugin
Request type	Asynchronous/synchronous
Supported agent version	v2
PluggetSystemType	Plugin

Request format

JSON

{
    "taskType": "RunPluginCommand",
    "params": {
      "async": {
        "objectId": number,
         "timeout": number
      },
      "sync": {
        "objectId": number,
         "timeout": number
      },
        "pluginName": "string",
        "pluginParams": object
    }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type, for this method the value is RunPluginCommand
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--timeout	int	no	Agent response time in seconds. Default is 120 seconds
--objectId	int	yes	Restaurant code in the licensing system
pluginName	string	yes	The name of the plugin the command is addressed to
pluginParams	object	yes	Json object that is passed to the plugin without parsing at the Agent level

Synchronous Response Format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"RunPluginCommand",
      "objectId":number
   },
   "error":{
      "wsError":{
         "code":"string",
         "desc":"string"
      }
   }
}

Parameter	Type	Description
Parameter	Type	Description
-taskGuid	guid	Unique code for this task. Used when receiving a task via the queue
-taskType	string enum	Task type
-objectId	int	Restaurant code in the licensing system
error		Error container, for more details see the article Error Description

Asynchronous response format

JSON

{
    "taskResponse": object,
    "responseCommon": {
        "taskGuid": "guid",
        "taskType": "RunPluginCommand",
        "objectId": "number"
    },
    "error": {
        "wsError": {
            "code": "string",
            "desc": "string"
        },
        "agentError": {
            "code": "string",
            "desc": "string"
        }
    }
}

Parameter	Parameter type	Description
taskResponse	object	Json serialized from the result of processing the command by the plugin
error		Error container, for more details see the article Error Description