| Purpose | Request for manual menu update |
| Request type | Asynchronous |
{
"taskType": "UpdateMenu",
"params": {
"async": {
"objectId": 0,
"timeout": 0
}
}
}Description of parameters
Parameter | Type | Mandatory | Description |
|---|
| taskType |
|
| Task type |
| async |
|
| Asynchronous method |
| timeout | int | - | Agent response timeout in seconds, default is 120 seconds |
| objectId | int | + | Restaurant code in the licensing system |
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"UpdateMenu",
"objectId":"int"
},
"error":{
"wsError":{
"code":"string",
"extCode":"string",
"desc":"string"
}
}
}
Parameter | Type | Description |
|---|
| taskGuid | guid | The unique code of this task is used when receiving the task through the queue. |
| taskType | string enum | Task type |
| objectId | int | Restaurant code in the licensing system |
| error |
| Error container, with the detailing on related systems inside |
| - wsError |
| Errors received from the WhiteServer service |
| – code | string | Error code |
| – extCode | string | Extended error code |
| – desc | string | Error description |
{
"taskResponse": {
"status": "string"
},
"responseCommon": {
"taskGuid": "string",
"taskType": "UpdateMenu",
"objectId": 0
}
}{
"responseCommon": {
"taskGuid": "string",
"taskType": "UpdateMenu",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"extCode": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}Description of parameters
Parameter | Parameter type | Mandatory | Description |
|---|
| taskGuid | uuid | + | Request ID |
| status | string |
| It can only be Updated, otherwise an error will be returned. |
| error | string enum |
| Error container with the detailing on related systems inside |
| - wsError | string enum |
| Whiteserver Error |
| – code | string |
| Error code |
| – extCode | string |
| Extended error code |
| – desc | string |
| Error description |
| - agentError | string enum |
| Agent Error |
| – code | string |
| Error code |
| – desc | string |
| Error description |
{
"taskType": "UpdateMenu",
"params": {
"async": {
"objectId": 199990106,
"timeout": 60
}
}
}{
"responseCommon": {
"taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
"taskType": "UpdateMenu",
"objectId": 199990106
},
"responseSync": "QueuedSuccess"
}{
"taskResponse": {
"status": "updated"
},
"responseCommon": {
"taskGuid": "fe5633c8-ee7d-4ef5-ab98-8ff9e98adbdc",
"taskType": "UpdateMenu",
"objectId": 199990106
}
}{
"responseCommon": {
"taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
"taskType": "UpdateMenu",
"objectId": 199990106
},
"error": {
"agentError": {
"code": 82,
"desc": "No access to main system (Rk7)"
}
}
}