...
Все настройки уникальны по Client, Account, Module, Key,ClientVersion.
Запрос:
URL:
Полный список:
GET https://api.url/v2.1/user/<user_id>/settings
...
GET https://api.url/v2.1/user/<user_id>/settings/<setting_id>
Доп. Заголовки:
If-Modified-Since - Если ранее запрос уже отсылался, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified
...
Authorization - для передачи токена. Передается в формате: Bearer <access_token>.
Доп. Параметры запроса:
| Поле | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
| page[offset] | int | 0 | Пропустить несколько первых записей |
| page[limit] | int | 2000 | Количество объектов в выводе |
| fields | string | Список полей отображаемых в объектах. | |
| filter | string | Фильтрация объектов. | |
| sort | string | Сортировка объектов. |
Ответ:
Ответ присылается в формате JSON API.
| Поле | Описание | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| links | Поле links содержит ссылки на доступные ресурсы Минимально он должен содержать ссылку на текущий ресурс (self). Если все объекты не удалось поместить в одном ответе то также будет содержаться next - следующая страница (если есть) prev - предыдущая страница (если есть) first - первая страница с результатами last - последняя страница с результатами | |||||||||||||||
| meta | Содержит total_count - количество объектов у пользователя | |||||||||||||||
| data | Содержит массив объектов в формате JSON API. Каждый объект содержит
| |||||||||||||||
| included | Необязательное поле. Появляется если в запросе задан параметр include. Содержит массив объектов связанных с объектами в ответе. |
Описание атрибутов.
| Поле | Тип | Nullable | Фильтрация | Описание |
|---|---|---|---|---|
| Module | string | нет | да | Тип Объекта / Модуль клиента - служит для группировки настроек |
| Key | string | нет | да | Ключ / Название отдельной настройки |
| Value | json | да | нет | Значение настройки, может быть любым json значением. |
| Version | int | нет | да | Версия настройки. При создании всегда 1. При обновлении всегда Version+1. Может служить для оптимистичной блокировки. |
| ClientVersion | int | нет | да | Версия клиента. Служит для предотвращения конфликтов форматов либо значений одной и той же настройки в разных версиях клиента. |
| UpdateDate | datetime | нет | да | Дата изменения настройки. |
Описание связанных объектов.
| Поле | Тип | Nullable | Фильтрация | Описание |
|---|---|---|---|---|
| Client | client | нет | да | Идентификатор клиента |
| Account | user | да | да | Пользователь который сделал настройку. Если null то это значение по умолчанию для всех пользователей. |
Коды ответов:
200 ОК - Сервер обработал запрос. Данные содержатся в теле ответа.
...
400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).
Пример:
получение настроек модуля "Карта" ("map") для клиента web (client_id=13)
...