Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на изменение пользовательского параметра

Запрос:

URL:

PATCH https://api.url/v2.1/user/<user_id>/objectParams/<param_id>

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

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

Content-Type - "application/vnd.api+json".

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

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

Атрибуты:
ПолеТипNullableОписание
ObjectTypeNamestringнет

название типа объекта к которому относится параметр

Возможные значения:

В будущем возможно добавление большего числа типов.

Редактирование доступно только если параметр не задан ни на одном объекте.

Codestringнет

Код параметра.

DescriptionstringнетОписание параметра для чего он нужен (значение в этом поле не зависит от локализации, оно нужно только для того чтобы разработчики могли узнать для чего используется параметр).
ParameterTypestringнет

Тип значения которое хранится в параметре.

ТипОписание
stringстрока, максимум 255 символов
month_day

Календарная дата - дата без года, только месяц и день. В формате iso ISO8601:2000

Приме: "--04-12" - месяц 4, день 12 (https://en.wikipedia.org/wiki/ISO_8601#Calendar_dates)

colorhex строка цвета в формате RRGGBB
numeric

Число, может быть дробным

datetimeДата и время ISO8601
dateДата без времени ISO8601
boolБулевый тип - 0/1

Сами значения всегда передаются в строковом виде.

Редактирование доступно только если параметр не задан ни на одном объекте.

DefaultValuestringда

Значение по умолчанию которое должно использоваться если данный параметр у конкретного объекта - null.

ValueListobjectда

Содержит объект со списком значений допустимых для этого параметра. В качестве key идёт значение параметра, в качестве value идёт локализованное название значения параметра.

Возвращаемые значения зависят от запрошенной локализации (заголовок Accept-Language).

Прим: для параметра CAR_TRANSMISSION (numeric параметр обозначающий тип трансмиссии ТС), передаётся:

{
"1": "автомат",
"2": "механика"
}

Можно только изменять value.

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

ПолеТипNullableОписание
Ownerobject<user>да

Пользователь (владелец) которому доступен данный параметр.

Нельзя изменить, игнорируется сервером.

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

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

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

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

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

Пример

GET https://api.url/api/v2.1/user/1/objectParams HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
{
    "data": {
        "type": "parameter",
        "attributes": {
            "DefaultValue": "621"
        }
    }
}
 

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
                     
{
    "data": {
        "id": "48",
        "type": "parameter",
        "attributes": {
            "ObjectTypeName": "car",
            "Code": "Наружный диаметр колеса",
            "Description": "Наружный диаметр колеса",
            "ParameterType": "numeric",
            "DefaultValue": "621",
            "IsUnique": true,
            "ValueList": null
        },
        "relationships": {
            "Owner": { "data": { "type": "user", "id": "1" } }
        }
    }
}

  • No labels