Отделы (Sections)

Ресурс Section — отдел с каталогами.

Получить отделы

Запрос
Ответ
Запрос
URL: {domain}/api/v1/sections

Метод: GET

Ответ

Ответ: 200 OK (application/json)

[{
"id": "1",
"icon": "icon1",
"name": "My section"
},
{
"id": "2",
"icon": "icon2",
"name": "Another section"
}]

Получить отдел

Запрос
Ответ
Запрос
URL: {domain}/api/v1/sections/{sectionId}

Метод: GET

Параметры:

  • sectionId (number) — идентификатор отдела

Ответ

Ответ: 200 OK (application/json)

[{
"id": "1",
"icon": "icon1",
"name": "My section",
"privilegeCode": "admin" // право на отдел
}]

Создать отдел

Запрос
Ответ
Запрос
URL: {domain}/api/v1/sections

Метод: POST Запрос: (application/json)

{
"name": "New section",
"icon": "new-icon"
}

Возможные значения для icon описаны в документации.

Ответ

Ответ: 200 OK (application/json)

{
"id": "2" // идентификатор созданного отдела
}

Изменить отдел

Запрос
Ответ
Запрос
URL: {domain}/api/v1/sections/{sectionId}

Метод: PATCH

Параметры:

  • sectionId (number) — идентификатор отдела

Ответ

Ответ: 200 OK (application/json)

{
"name": "My section1",
"catalogsPriorities": ["5", "3", "7"] // очередность каталогов в отделе
}

Удалить отдел

Запрос
Ответ
Запрос
URL: {domain}/api/v1/sections/{sectionId}

Метод: DELETE

Параметры:

  • sectionId (number) — идентификатор отдела

Ответ

Ответ: 200 OK