ServiceAgentBenchmark

Purpose	Sends a test request to the agent to check the aggregator-agent-server throughput. Access to the method is limited
Request type	Asynchronous/synchronous
Supported agent version	v2
PluggetSystemType	AgentInternal

Request format

JSON

{
  "taskType": "ServiceAgentBenchmark",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "numberOfCharacters":0
  }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type. For this method, the value is ServiceAgentBenchmark
-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
-numberOfCharacters	int	yes	The number of randomly generated characters that the agent should return in the response.

Synchronous response format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"ServiceAgentBenchmark",
      "objectId": 0
   },
   "error":{
      "wsError":{
         "code":"string",
         "desc":"string"
      }
   }
}

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

Successful response

JSON

{
  "taskResponse":{
     "text": ""
      },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ServiceAgentBenchmark",
    "objectId": 0
  }
}

Parameter	Parameter type	Mandatory	Description
taskResponse	object	yes
-text	string	yes	Randomly generated characters in the amount specified in the request

Response with error

JSON

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ServiceAgentBenchmark",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

Parameter	Parameter type	Mandatory	Description
error	string enum		Error container, for more details see the article Error Description