Page tree

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

Skip to end of metadata
Go to start of metadata

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

Запрос:

URL:

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

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

Запрос по id:

GET https://api.url/v2.1/user/<user_id>/drivers/keys/<key_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Количество объектов в выводе
fields[driverKey]string

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

filter[driverKey]string
Фильтрация объектов
sortstring
Сортировка объектов
includestring

Позволяет добавить в текущий запрос связанные с объекты.

Ответ:

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

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

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

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

Если всех водителей не удалось поместить в одном ответе то также будет содержаться

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

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

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

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


metaСодержит total_count - количество ключей у пользователя
data

Содержит массив объектов в формате JSON API.

Каждый объект водитель содержит

ПолеТипОписание
idintИдентификатор (передаётся как строка для соответствия JSON API)
typestringТип ресурса (всегда "driverKey")
attributesobjectАтрибуты
relationshipsobject

Ссылки на связанные объекты


included

Необязательное поле. Появляется, если в запросе задан параметр include.

Содержит массив объектов.

Описание атрибутов:

ПолеТипNullableФильтрацияОписание
KeyNumberstringнетдаНомер ключа водителя.
Statusstringнетда

Статус ключа

new - новый, ещё не использовался

not_used - сейчас не используется

linked - закреплён за подителем

lost - потерян (В Driver будет кто утерял).

KeyTypestringнетда

Тип ключа,

  • dallas

  • usb

  • tachograph
DateOfCreationdatetimeнетдаДата создания
UpdateDatedatetimeнетдаДата изменения
Связанные объекты
ПолеТипNullableФильтрацияIncludeОписание
DriverdriverдададаК какому водителю привязан ключ
OwneruserнетданетК какому пользователю привязан ключ

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

200 ОК - Сервер обработал запрос. В теле ответа  содержится список водителей. Также будет передан заголовок Last-Modified.

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

401 Unauthorized - не передан заголовок Authorization, либо токен невалидный или окончилась валидация.

403 Forbidden - нет прав на просмотр (id пользователя не соответствует токену или водитель находится в "чужой учетной записи").

404 Not Found - Водитель не найден.

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


Пример

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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://cur.api.citypoint.ru/user/1/drivers/keys
    },
    "meta": {
        "total_count": 365
    },
    "data": [
        {
            "id": "173",
            "type": "driverKey",
            "attributes": {
                "KeyNumber": "1771",
                "Status": "linked",
                "KeyType": "dallas",
                "DateOfCreation": "2014-03-11T04:02:19Z",
                "UpdateDate": "2020-12-28T14:38:14Z"
            },
            "relationships": {
                "Owner": {
                    "data": {
                        "id": "1",
                        "type": "user"
                    }
                },
                "Driver": {
                    "data": {
                        "id": "2",
                        "type": "driver"
                    }
                }
            }
        },
        {
            "id": "461",
            "type": "driverKey",
            "attributes": {
                "Owner": "1",
                "Status": "not_used",
                "KeyType": "dallas",
                "DateOfCreation": "2015-03-13T04:14:01Z",
                "UpdateDate": "2017-08-30T10:51:18Z"
            },
            "relationships": {
                "Account": {
                    "data": {
                        "id": "478",
                        "type": "user"
                    }
                },
                "Driver": {
                    "data": null
                }
            }
        },
        {
            "id": "489",
            "type": "driverKey",
            "attributes": {
                "KeyNumber": "5039",
                "Status": "not_used",
                "KeyType": "dallas",
                "DateOfCreation": "2015-03-26T04:34:53Z",
                "UpdateDate": "2017-08-30T10:51:18Z"
            },
            "relationships": {
                "Owner": {
                    "data": {
                        "id": "1",
                        "type": "user"
                    }
                },
                "Driver": {
                    "data": null
                }
            }
        },
        ...
     ]
}


  • No labels