Робочі місця

Список робочих місць

Отримати список робочих місць

GET /api/workplaces{?active,with,order,filters,ids_list,offset,limit,unprotect_keys}

Параметри

Параметр

Тип

Обов’язковий

Опис

active

string

ні

Якщо параметр дорівнює “true”, то повертаються лише активні записи.

with

string

ні

Список імен повʼязаних ресурсів через кому без пробілів. Звʼязки: outlet

order

string

ні

Список полів сортування через кому без пробілів

ids_list

string

ні

Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу

filters

string

ні

Текстові фільтри у форматі: field_name:: |field_name1::

offset

integer

ні

Повертати дані, починаючи з указаного номера запису

limit

integer

ні

Повертати вказану кількість записів

Відповідь 200 (application/json)

[
  {
    "id_workplace": 2,
    "id_outlet": 1,
    "name_workplace": "This is workplace",
    "control_rest": false,
    "control_bar_code": false,
    "control_showcase": false,
    "allow_free_price": false,
    "control_goods": false,
    "ads_enabled": false,
    "active": true
  }
]

Додати робоче місце

POST /api/workplaces{?active,with,order,filters,ids_list,offset,limit,unprotect_keys}

  • Атрибут id_workplace у JSON-і запиту ігнорується, якщо не вказано параметр unprotect_keys=true.

Параметри

Параметр

Тип

Обов’язковий

Опис

unprotect_keys

string

ні

Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

  • Content-Type: application/json

Тіло запиту:

{
  "id_workplace": 2,
  "id_outlet": 1,
  "name_workplace": "This is workplace",
  "control_rest": false,
  "control_bar_code": false,
  "control_showcase": false,
  "allow_free_price": false,
  "control_goods": false,
  "ads_enabled": false,
  "active": true
}

Відповідь 201 (application/json)

{
  "id_workplace": 2,
  "id_outlet": 1,
  "name_workplace": "This is workplace",
  "control_rest": false,
  "control_bar_code": false,
  "control_showcase": false,
  "allow_free_price": false,
  "control_goods": false,
  "ads_enabled": false,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_workplace": {
      "type": "number"
    },
    "id_outlet": {
      "type": "number"
    },
    "name_workplace": {
      "type": "string"
    },
    "control_rest": {
      "type": "boolean"
    },
    "control_bar_code": {
      "type": "boolean"
    },
    "control_showcase": {
      "type": "boolean"
    },
    "allow_free_price": {
      "type": "boolean"
    },
    "control_goods": {
      "type": "boolean"
    },
    "ads_enabled": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_workplace",
    "id_outlet",
    "name_workplace",
    "control_rest",
    "control_bar_code",
    "control_showcase",
    "allow_free_price",
    "control_goods",
    "ads_enabled",
    "active"
  ]
}

Кількість робочих місць

Отримати кількість робочих місць

GET /api/workplaces/count{?filters,ids_list,active}

Параметри

Параметр

Тип

Обов’язковий

Опис

ids_list

string

ні

Список значень ключового поля записів, які потрібно повернути. Зазначається через кому без пробілу

filters

string

ні

Текстові фільтри у форматі: field_name:: |field_name1::

active

string

ні

Якщо параметр дорівнює “true”, то враховуються лише активні записи.

Відповідь 200 (application/json)

{
  "count": 10
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "number"
    }
  },
  "required": [
    "count"
  ]
}

Робоче місце

Отримати дані про робоче місце

GET /api/workplaces/{id_outlet}/{?unprotect_keys,with}

Параметри

Параметр

Тип

Обов’язковий

Опис

id_outlet

integer

так

Код робочого місця

with

string

ні

Список імен повʼязаних ресурсів через кому без пробілів. Звʼязки: outlet

Відповідь 200 (application/json)

{
  "id_workplace": 2,
  "id_outlet": 1,
  "name_workplace": "This is workplace",
  "control_rest": false,
  "control_bar_code": false,
  "control_showcase": false,
  "allow_free_price": false,
  "control_goods": false,
  "ads_enabled": false,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_workplace": {
      "type": "number"
    },
    "id_outlet": {
      "type": "number"
    },
    "name_workplace": {
      "type": "string"
    },
    "control_rest": {
      "type": "boolean"
    },
    "control_bar_code": {
      "type": "boolean"
    },
    "control_showcase": {
      "type": "boolean"
    },
    "allow_free_price": {
      "type": "boolean"
    },
    "control_goods": {
      "type": "boolean"
    },
    "ads_enabled": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_workplace",
    "id_outlet",
    "name_workplace",
    "control_rest",
    "control_bar_code",
    "control_showcase",
    "allow_free_price",
    "control_goods",
    "ads_enabled",
    "active"
  ]
}

Змінити дані про робоче місце

PUT /api/workplaces/{id_outlet}/{?unprotect_keys,with}

Параметри

Параметр

Тип

Обов’язковий

Опис

id_outlet

integer

так

Код робочого місця

unprotect_keys

string

ні

Якщо параметр існує і дорівнює “true”, в операціях створення/редагування значення ключового поля не ігноруються

Заголовки запиту:

  • Content-Type: application/json

Тіло запиту:

{
  "id_workplace": 2,
  "id_outlet": 1,
  "name_workplace": "This is workplace",
  "control_rest": false,
  "control_bar_code": false,
  "control_showcase": false,
  "allow_free_price": false,
  "control_goods": false,
  "ads_enabled": false,
  "active": true
}

Відповідь 200 (application/json)

{
  "id_workplace": 2,
  "id_outlet": 1,
  "name_workplace": "This is workplace",
  "control_rest": false,
  "control_bar_code": false,
  "control_showcase": false,
  "allow_free_price": false,
  "control_goods": false,
  "ads_enabled": false,
  "active": true
}

Схема:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id_workplace": {
      "type": "number"
    },
    "id_outlet": {
      "type": "number"
    },
    "name_workplace": {
      "type": "string"
    },
    "control_rest": {
      "type": "boolean"
    },
    "control_bar_code": {
      "type": "boolean"
    },
    "control_showcase": {
      "type": "boolean"
    },
    "allow_free_price": {
      "type": "boolean"
    },
    "control_goods": {
      "type": "boolean"
    },
    "ads_enabled": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id_workplace",
    "id_outlet",
    "name_workplace",
    "control_rest",
    "control_bar_code",
    "control_showcase",
    "allow_free_price",
    "control_goods",
    "ads_enabled",
    "active"
  ]
}

Деактивувати дані про робоче місце

DELETE /api/workplaces/{id_outlet}/{?unprotect_keys,with}

Параметри

Параметр

Тип

Обов’язковий

Опис

id_outlet

integer

так

Код робочого місця

Відповідь 204