Purpose	Get a list of systems connected to the restaurant
Request type	Synchronous only
Supported agent version	All
PluggetSystemType	WhiteServer

Request format

JSON

{
  "taskType": "GetRestaurantSystems",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    }
  }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	The task type for this method is GetRestaurantSystems value
params		yes	Request parameters
-sync		yes	Synchronous method
--objectId	int	yes	Restaurant code in the licensing system
--timeout	int	no	Response timeout in seconds. Default is 120, maximum is 180

Response format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"GetRestaurantSystems",
      "objectId":0
   },
   "taskResponse":[
      {
            "name": "string",
            "type": "string"
      }
   ],
   "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
taskResponse	массив	Array of connected systems
--name	string	System name
--type	string	System type PluggetSystemType. PluggetSystemType — supported system types are added to agentGuid. Associate agentGuid, objectId, system type. The connected system type takes the following values: RKRef — rKeeper directory server RKMid — rKeeper cash server WSMon — agent monitor WSClient — systems operating under the ws-client license StoreHouse — StoreHouse Sql — SQL queries Plugin — Plugin requests AgentInternal — requests to internal agent commands Server — requests to the server AllAgentServices — requests to all services supported by the agent
error		Error container, for more details see the article Error Description

If the value in name is specified as *_wsclient, these are legacy roles granted under the wsclient license. They can be ignored. These roles are fixed in the format [System_Type]_wsclient. During a silent installation, they do not appear, but if an agent uses the wsclient license, then these roles are assigned to the agent for compatibility purposes.

It is better not to specify *_wsclient in extended routing. Therefore, it is better to leave null in systemName.

Example request

JSON

{
  "taskType": "GetRestaurantSystems",
  "params": {
    "sync": {
      "objectId": 199990246
    }
  }
}

Example answer

JSON

{
    "taskResponse": [
        {
            "name": "AgentInternal_wsclient",
            "type": "AgentInternal"
        },
        {
            "name": "Plugin_wsclient",
            "type": "Plugin"
        },
        {
            "name": "EMRDPKASS",
            "type": "RKMid"
        },
        {
            "name": "RKMid_wsclient",
            "type": "RKMid"
        },
        {
            "name": "EMRDP",
            "type": "RKRef"
        },
        {
            "name": "RKRef_wsclient",
            "type": "RKRef"
        },
        {
            "name": "199990246: 127.0.0.1&rkAgentTest2",
            "type": "Sql"
        },
        {
            "name": "Sql_wsclient",
            "type": "Sql"
        },
        {
            "name": "StoreHouse_wsclient",
            "type": "StoreHouse"
        }
    ],
    "responseCommon": {
        "taskGuid": "0c5229fe-86ef-4a1f-8c79-6b6ccdd33d84",
        "taskType": "GetRestaurantSystems",
        "objectId": 199990246
    }
}