PushDishSettings

Purpose	Request to edit dish parameters
Request type	Asynchronous/synchronous
Supported agent version	v1
PluggetSystemType	RKRef

Request format

JSON

{
  "taskType": "PushDishSettings",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "identity": number,
    "extProperties": [
      {
       "name": "string",
       "value": "string"
      }
    ]
  }
}

Parameter	Type	Mandatory	Description	Default value
taskType	string	yes	Task type
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--objectId	int	yes	Restaurant code in the licensing system
--timeout	int	no	Response timeout in seconds	120 sec
-identity	int	yes	Dish ID
-extProperties		yes	Set of additional properties for menu item in r_keeper
--name	string	yes	Property name
--value	string	yes	Property value

Extended property of the dish	Description
PhotoForDelivery	Link to dish image, extended dish property
DescriptionForDelivery	Product Description
DefaultModifierForDelivery	Default modifiers. The identifiers of the modifiers are specified, with more than one possible, separated by a semicolon.
NameForDelivery	Name of the dish for delivery

Synchronous Response Format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"PushDishSettings",
      "objectId":number
   },
   "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	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

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "PushDishSettings",
    "objectId": 0
  }
}

Response with error

JSON

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

Parameter	Parameter type	Mandatory	Description
taskGuid	guid	yes	Request ID
-taskType	string		Task type
-objectId	int		Restaurant code in the licensing system
error			Error container, for more details see the article Error Description

Example request

JSON

{
  "taskType": "PushDishSettings",
  "params": {
    "async": {
      "objectId": 199990000,
      "timeout": 20
    },
    "identity": 1122,
    "extProperties": [
      {
       "name": "NameForDelivery",
       "value": "A dish"
      }
    ]
  }
}