Purpose

Request to update employee data or add data about a new employee

Request typeAsynchronous, synchronous
Supported agent versionv2
PluggetSystemTypeRKRef

Request format


JSON

{
  "taskType": "SetEmployee",
  "params": {
    "Employee": {
    // Employee
    }
    "sync": {
      "objectId": 0,
      "timeout": 0
    }
  }
}

Parameter

Type

Mandatory

Description

taskType

Task type
-EmployeeobjectyesEmployee data being changed or added
-sync

Synchronous method call
--timeoutintnoAgent response time in seconds. Default is 120 seconds
--objectIdintyesRestaurant code in the licensing system

Response format

Successful response


JSON

{
 "responseCommon": {
   "taskGuid": "string",
   "taskType": "SetEmployee",
   "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

Response with error


JSON

{
  "responseCommon": {
    "taskGuid": "fa1bdcbf-1e96-425c-9159-eb57d4accb6f",
    "taskType": "SetEmployee",
    "objectId": 199990106,
   
  },
  "error": {
    "wsError": {
      "code": "WsaOrderError",
      "desc": "something is wrong"
    }
  }
}