Отделы (Sections)

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

Отдел

URL: /{api url}/sections/{sectionId}

Параметры:

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

Получить отдел [GET]

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

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

Изменить отдел [PATCH]

Запрос: (application/json)

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

Ответ: 200 OK

Удалить отдел [DELETE]

Ответ: 200 OK


Коллекция отделов

URL: /{api url}/sections

Получить отделы [GET]

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

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

Создать отдел [POST]

Запрос: (application/json)

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

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

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

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

results matching ""

    No results matching ""