Page tree

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

Skip to end of metadata
Go to start of metadata

Метод для получения рассчитанных периодов olap.

Запрос:

URL:

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

GET https://api.url/user/<user_id>/olap/periods

Запрос по id:

GET https://api.url/user/<user_id>/olap/periods/<period_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Тип ресурса - olapPeriod
attributesobjectДанные объекта
relationshipsobjectСсылки на связанные объекты

Атрибуты:

ПолеТипNullableФильтрацияОписание
DateFromdatetimeнетдаНачало периода
DateTodatetimeнетдаОкончание периода
PeriodTypestringнетда

тип периода:

ЗначениеОписание
dayдень
weekнеделя
monthмесяц
quarterквартал
yearгод
DateOfCreationdatetimeнетдаДата когда был создан период

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

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

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

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

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

Пример:

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


HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "meta": {
        "total_count": 5424
    },
    "links": {
        "self": "https://cur.api.citypoint.ru/user/7493/olap/periods"
    },
    "data": [
        {
            "id": "1",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-05T00:00:00Z",
                "DateTo": "2018-01-05T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "2",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-06T00:00:00Z",
                "DateTo": "2018-01-06T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "3",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-07T00:00:00Z",
                "DateTo": "2018-01-07T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "4",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-08T00:00:00Z",
                "DateTo": "2018-01-08T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "5",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-09T00:00:00Z",
                "DateTo": "2018-01-09T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "6",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2018-01-10T00:00:00Z",
                "DateTo": "2018-01-10T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        },
        {
            "id": "7",
            "type": "olapPeriod",
            "attributes": {
                "DateFrom": "2017-01-25T00:00:00Z",
                "DateTo": "2017-01-25T23:59:59Z",
                "DateOfCreation": "2018-01-11T21:04:53Z",
                "PeriodType": "day"
            }
        }, 
        
        ...
    ]
}
  • No labels