Page tree

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

Skip to end of metadata
Go to start of metadata

Получение списка телефонов заданного водителя.

Запрос:

URL:

Все телефоны водителя:

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

Запрос телефона водителя по id:

GET https://api.url/v2.1/user/<user_id>/drivers/<driver_id>/phones/<phone_id>

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

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

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

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

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

Параметры sort, filter, page и include (определённые в стандарте JSON API) в текущей версии api не поддерживаются. В случае их получения сервер будет возвращать ошибку 400.

Ответ:

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

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

Содержит ссылку на текущий ресурс (self)

metaСодержит total_count - количество телефонов у водителя
data

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

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

ПолеТипОписание
idintИдентификатор телефона
typestringтип ресурса (всегда "phone")
attributesobjectДанные телеофна

Описание атрибутов телефонов водителей.

ПолеТипNullableОписание
Typeintнет

тип телефона

Phonestringнетномер телефона (только цифры)
IsPrimaryboolнетОсновной телефон
SpammableboolнетМожно ли делать рассылки на данный телефон
DateOfCreationdatetimeнетДата создания
UpdateDatedatetimeнетДата удаления
Типы телефонов:
ТипОписание
0домашний
1рабочий
2мобильный

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

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/1/phones 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://api.url/v2.1/user/1/drivers/1/phones",
    },
    "meta": {
        "total_count": 2
    },
    "data": [
        {
            "id": "1",
            "type": "phone",
            "attributes": {
                "Type": 2,
                "Phone": "12025550168",
                "IsPrimary": true,
                "Spamable": true,
                "DateOfCreation": "2018-03-25T15:56:46Z",
                "UpdateDate": "2017-07-11T14:05:55Z"
            }
        },
        {
            "id": "2",
            "type": "phone",
            "attributes": {
                "Type": 2,
                "Phone": "71234567890",
                "IsPrimary": true,
                "Spamable": true,
                "DateOfCreation": "2022-03-09T10:23:45Z",
                "UpdateDate": "2022-03-09T10:23:45Z"
            }
        }
    ]
}


  • No labels