Отделы (Sections)
Ресурс Section — отдел с каталогами.

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

Запрос
Ответ
1
URL: {domain}/api/v1/sections
Copied!
Метод: GET
Ответ: 200 OK (application/json)
1
[{
2
"id": "1",
3
"icon": "icon1",
4
"name": "My section"
5
},
6
{
7
"id": "2",
8
"icon": "icon2",
9
"name": "Another section"
10
}]
Copied!

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

Запрос
Ответ
1
URL: {domain}/api/v1/sections/{sectionId}
Copied!
Метод: GET
Параметры:
  • sectionId (number) — идентификатор отдела
Ответ: 200 OK (application/json)
1
[{
2
"id": "1",
3
"icon": "icon1",
4
"name": "My section",
5
"privilegeCode": "admin" // право на отдел
6
}]
Copied!

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

Запрос
Ответ
1
URL: {domain}/api/v1/sections
Copied!
Метод: POST Запрос: (application/json)
1
{
2
"name": "New section",
3
"icon": "new-icon"
4
}
Copied!
Возможные значения для icon описаны в документации.
Ответ: 200 OK (application/json)
1
{
2
"id": "2" // идентификатор созданного отдела
3
}
Copied!

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

Запрос
Ответ
1
URL: {domain}/api/v1/sections/{sectionId}
Copied!
Метод: PATCH
Параметры:
  • sectionId (number) — идентификатор отдела
Ответ: 200 OK (application/json)
1
{
2
"name": "My section1",
3
"catalogsPriorities": ["5", "3", "7"] // очередность каталогов в отделе
4
}
Copied!

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

Запрос
Ответ
1
URL: {domain}/api/v1/sections/{sectionId}
Copied!
Метод: DELETE
Параметры:
  • sectionId (number) — идентификатор отдела
Ответ: 200 OK
Last modified 1yr ago