Purpose

Checks the availability of the specified primary system in the restaurant 

Request typeSynchronous only
Supported agent version2.9.2.1 and higher
PluggetSystemTypeRKRef, RKMid, StoreHouse, Sql

Request format

{
  "taskType": "IsMainSystemAvailable",
  "params": {
    "systemType": "RKRef",
    "sync": {
      "objectId": 199996011
    }
  }
}
CODE

Parameter

Type

Mandatory

Description

taskTypestring+Task type, for this method the value is "IsMainSystemAvailable"
params
+Request parameters
   systemType
+System type (RKRef, RKMid, StoreHouse, Sql)
   sync
+Synchronous method
       objectIdint+Restaurant code in the licensing system

Response format

{
    "taskResponse": {
        "isAvailable": true
    },
    "responseCommon": {
        "taskGuid": "9e397e88-2830-4946-95e3-0fe8555ad1e1",
        "taskType": "IsMainSystemAvailable",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}
CODE

Parameter

Type

Description

taskGuidguidThe unique code of this task is used when receiving the task through the queue.
taskTypestring enumTask type
objectIdintRestaurant code in the licensing system
taskResponsearrayArray of available logs
    isAvailablebooltrue if the system is available, otherwise false
error
Error container, see Error Description