GetEmployees

Назначение	Запрос получения списка сотрудников
PluggetSystemType	RKRef

ФОРМАТ ЗАПРОСА

ФОРМАТ ЗАПРОСА

Запрос

{
  "taskType": "GetEmployees",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    }
  }
}

CODE

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	+	Тип задачи (GetEmployees)
sync			Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")
\|-timeout	int	-	Время ожидания ответа от агента в секундах	120 секунд
\|-objectId	int	+	Код ресторана в системе лицензирования

ФОРМАТ ОТВЕТА

ФОРМАТ ОТВЕТА

Успешный ответ

{
 "responseCommon": {
   "taskGuid": "string",
   "taskType": "GetEmployees",
   "objectId": 0
 },
 "taskResponse": {
   "Employees": [
     // Содержимое блока можно посмотреть здесь: https://docs.rkeeper.ru/ws/employee-83198008.html
  ]
}

CODE

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetEmployees",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр Тип Описание

responseCommon object Информация по задаче

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

Код ресторана в системе лицензирования

taskResponse object Содержимое блока можно посмотреть здесь: Employee

error object Контейнер ошибок, см Описание ошибок

wsError		Ошибка от сервера
agentError		Ошибка от агента

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

Примеры структуры запросов

{
  "taskType": "GetEmployees",
  "params": {
    "sync": {
      "timeout": 120,
      "objectId": "199990377"
    }
  }
}

{
  "taskResponse": {
    "employees": [
      {
        "restaurantRoles": [
          {
            "restaurantId": 1,
            "roleId": 100004,
            "name": "Кассиры"
          }
        ],
        "groups": [],
        "id": 3835,
        "name": "Ismael Mohr",
        "altName": "Kassir test",
        "visualTypeImage": "0",
        "visualTypeBColor": "536870911",
        "visualTypeTextColor": "536870911",
        "visualTypeFlags": "bsPictureTop",
        "cardCode": "",
        "largeImagePath": "",
        "eMail": "Antonio.Blick@hotmail.com",
        "pagerCode": "0",
        "pagerType": "pTone",
        "brigade": "0",
        "defServPosition": "0",
        "defaultRestaurantId": 1,
        "phoneNumber": "+7 561-690-7791",
        "qrSberTips": "787.72"
      },
      {
        "restaurantRoles": [
          {
            "restaurantId": 1,
            "roleId": 100005,
            "name": "Официанты"
          }
        ],
        "groups": [],
        "id": 1000023,
        "name": "Официант 1",
        "altName": "",
        "visualTypeImage": "0",
        "visualTypeBColor": "536870911",
        "visualTypeTextColor": "536870911",
        "visualTypeFlags": "bsPictureTop",
        "cardCode": "",
        "largeImagePath": "",
        "eMail": "",
        "pagerCode": "0",
        "pagerType": "pTone",
        "brigade": "0",
        "defServPosition": "0",
        "defaultRestaurantId": 1,
        "phoneNumber": "",
        "qrSberTips": ""
      }
    ]
  },
  "responseCommon": {
    "taskGuid": "3cfc030f-2997-4dd9-b00f-d47b538435e9",
    "taskType": "GetEmployees",
    "objectId": 199990377,
    "agentGuid": "3bee8cde-d8dd-4609-9de7-bb42c5a722ef"
  }
}

{
  "responseCommon": {
    "taskGuid": "46f146fd-bb2c-41a8-b4aa-6587007bd0b4",
    "taskType": "GetEmployees",
    "objectId": 331760005
  },
  "error": {
    "wsError": {
      "code": "Timeout",
      "desc": "Agent is offline or has been unresponsive"
    }
  }
}