Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Метод для получения списка типов ролей пользователей.

Типы Ролей служат для назначения указанной роли доп. возможностей. (Прим только диспетчеров с типом роли "Механик" (id=10) можно указывать в поле Employee при создании или редактировании ТО).

Идентификаторы типов ролей пользователей никогда не изменяются, но сами типы могут как добавляться так и исчезать, в зависимости от доступных пользователю продуктов citypoint

Запрос:

URL:

Полный список:

GET https://api.url/v2.1/user/<user_id>/roleTypes

Запрос по id:

GET https://api.url/v2.1/user/<user_id>/roleTypes/<roleType_id>

Доп. Заголовки:

If-Modified-Since - Если ранее уже запрашивался полный список объектов, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

Accept - для указания формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

ПолеТипЗначение по умолчаниюОписание
page[offset]int0Пропустить несколько первых записей
page[limit]int2000Количество объектов в выводе
fieldsstring

Фильтрация отображаемых полей.

filterstring

Фильтрация объектов

sortstring
Сортировка объектов.
includestring
Включить в вывод данные связанных объектов

Ответ:

       Ответ присылается в формате JSON API.

ПолеОписание
links

Поле links содержит ссылки на связанные ресурсы

Минимально он должен содержать ссылку на текущий ресурс (self).

Если все объекты не удалось поместить в одном ответе, то также будет содержаться:

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами


metaСодержит total_count - количество объектов у пользователя (с учетом фильтра)
data

Содержит данные в формате JSON API.

ПолеТипОписание
typestringТип ресурса - roleType
attributesobjectДанные объекта

Атрибуты:

ПолеТипNullableФильтрацияОписание
NamestringнетдаНазвание типа роли (уникальное поле).
DescriptionstringдадаОписание типа роли
UpdateDatedatetimeнетдаДата обновления
DateOfCreationdatetimeнетдаДата создания

Коды ответов:

200 OK - Сервер обработал. Данные переданы в теле ответа.

403 Forbidden - нет прав получение диспетчеров.

400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).

Также возможны другие ошибки.

Пример:

GET https://api.url/api/v2.1/user/1/roleTypes HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>


HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
    "links": {
        "self": "https://api.url/api/v2.1/user/1/roleTypes"
    },
    "meta": {
        "total_count": 4
    },
    "data": [
        {
            "id": "5",
            "type": "roleType",
            "attributes": {
                "Name": "Logist",
                "Description": "Логист",
                "UpdateDate": "2018-04-20T18:11:11Z",
                "DateOfCreation": "2018-04-20T18:11:11Z"
            }
        },
        {
            "id": "7",
            "type": "roleType",
            "attributes": {
                "Name": "Contractor",
                "Description": "Подрядчик",
                "UpdateDate": "2018-04-20T18:11:11Z",
                "DateOfCreation": "2018-04-20T18:11:11Z"
            }
        },
        {
            "id": "8",
            "type": "roleType",
            "attributes": {
                "Name": "Customer",
                "Description": "Заказчик (логистика)",
                "UpdateDate": "2018-07-17T12:36:38Z",
                "DateOfCreation": "2018-07-17T12:36:38Z"
            }
        },
        {
            "id": "10",
            "type": "roleType",
            "attributes": {
                "Name": "Mechanic",
                "Description": "Механик",
                "UpdateDate": "2022-03-03T18:11:55Z",
                "DateOfCreation": "2022-03-03T18:11:55Z"
            }
        }
    ]
}


  • No labels