GetRestaurantInfo

Purpose	Get information about the restaurant
Request type	Asynchronous/synchronous
Supported agent version	v2
PluggetSystemType	RKMid

Request format

JSON

{
  "taskType": "GetRestaurantInfo",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
  }
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--timeout	int	no	Agent response timeout in seconds, default is 120 seconds
--objectId	int	yes	Restaurant code in the licensing system

Synchronous response format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"GetRestaurantInfo",
      "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": {
        "restaurant": {
            "guid": "guid",
            "name": "string",
            "halls": [
                {
                    "guid": "guid",
                    "name": "string",
                    "tables":[
                        "guid": "guid",
                        "code": 0,
                        "name": "string",
                        "seatsCount": 0
                    ]
                }
            ]
        }
    },
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "GetRestaurantInfo",
        "objectId": 0
    }
}

Response with error

JSON

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

Parameter	Type	Description
-restaurant		Restaurant Description
--guid	guid	Restaurant UUID
--name	string	Name of the restaurant
--halls		List of halls
---guid	guid	Hall UUID
---name	string	Name of the hall
---tables		List of tables
----guid	guid	Table UUID
----code	int	Table code
----name	string	Table name
----seatsCount	int	Number of seats at the table
error	string enum	Error container, for more details see the article Error Description