Page tree

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

Skip to end of metadata
Go to start of metadata

Метод для получения времён дня.

Запрос:

URL:

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

GET https://api.url/v2.1/daytimes

Запрос по id:

GET https://api.url/v2.1/daytimes/{daytime_id}

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

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

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

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

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

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

Список полей отображаемых в объектах.

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

Ответ:

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

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

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

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

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

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

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

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

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


metaСодержит total_count - количество объектов
data

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

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

ПолеТипОписание
idintИдентификатор
typestringТип ресурса (всегда "daytime")
attributesobjectОписание атрибутов см. ниже
relationshipsobject

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

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

ПолеТипNullableФильтрацияОписание
CodestringнетдаКод времени дня.
DescriptionstringдадаОписание времени дня.

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

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

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

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

403 Forbidden - нет прав на просмотр выполнение запроса.

404 Not Found - ДТП не найдено.

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


Пример

GET https://api.url/v2.1/daytimes 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/daytimes"
    },
    "meta": {
        "total_count": 4
    },
    "data": [
        {
            "id": "1",
            "type": "daytime",
            "attributes": {
                "Description": "Утренние сумерки",
                "Code": "MORNING"
            }
        },
        {
            "id": "2",
            "type": "daytime",
            "attributes": {
                "Description": "День",
                "Code": "DAY"
            }
        },
        {
            "id": "3",
            "type": "daytime",
            "attributes": {
                "Description": "Вечерние сумерки",
                "Code": "EVENING"
            }
        },
        {
            "id": "4",
            "type": "daytime",
            "attributes": {
                "Description": "Ночь",
                "Code": "NIGHT"
            }
        }
    ]
}



  • No labels