Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на получение квоты файлов текущего пользователя.

Запрос:

URL:

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

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

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

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

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

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

ПолеТипЗначение по умолчаниюОписание
fields[parameter]string

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

Ответ:

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

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

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

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

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

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

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

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

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


data

Содержит данные по пользователю в формате JSON API.

ПолеТипОписание
idstringидентификатор параметра
typestringparameter
attributesobjectДанные объекта (см. Описание атрибутов)

Атрибуты:

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

UsedSpace

intнет

Текущий занятый объём. В байтах.

AllowedSpace

intнетРазрешённый объём. В байтах

FreeSpace

intнетСвободный объём. В байтах

FileCount

intнет

Всего файлов на хранении.


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

200 OK - Сервер обработал запрос. В теле ответа содержится список параметров объектов.

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

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

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


Пример

GET https://api.url/api/v2.1/user/1/fileQuota 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/fileQuota"
    },
    "data": {
        "id": "1",
        "type": "fileQuota",
        "attributes": {
            "UsedSpace": 73285213,
            "AllowedSpace": 1048576000,
            "FreeSpace": 975290787,
            "FileCount": 49
        }
    }
}
  • No labels