Purpose

Request to delete employee data

Request typeAsynchronous, synchronous
Supported agent versionv2
PluggetSystemTypeRKRef

Request format


JSON

{
  "taskType": "RemoveEmployee",
  "params": {
    "EmployeeId": 0,
    "sync": {
      "objectId": 0,
      "timeout": 0
    }
  }
}

Parameter

Type

Mandatory

Description

taskType

Task type
-employeeIdintyesID of the employee data to be deleted
-sync

Synchronous method
--timeoutintnoAgent response timeout in seconds, default is 120 seconds
--objectIdintyesRestaurant code in the licensing system

Synchronous response format


JSON

{
 "responseCommon": {
   "employeeId": 0,
   "taskGuid": "string",
   "taskType": "RemoveEmployee",
   "objectId": 0
 },
 "taskResponse": {}
 
}

Parameter

Type

Description

-taskGuidguidUnique code for this task. Used when receiving a task via the queue
-taskTypestring enumTask type
-objectIdintRestaurant code in the licensing system
error
Error container, for more details see the article Error Description

Example request


JSON

{
  "taskType": "RemoveEmployee",
  "params": {
    "sync": {
      "objectId": 199990106,
      "timeout": 60
    }
  }
}