Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос:

URL:

PATCH https://api.url/v2.1/user/<user_id>/drivers/<driver_id>/addresses/<address_id>

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

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

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

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

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

Данные запроса:

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

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

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

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

ПолеТипОписание
typestringтип ресурса (всегда "address")
attributesobjectДанные водителя (описание атрибутов ниже)
relationshipsobjectСвязанные объекты

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

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

тип адреса

0 - Юридический адрес

1 - Фактический адрес

2 - Адрес доставки

Address

stringнетСтрока адреса

Описание связанных объектов:

ПолеТипNullableОписание
Driverobject<driver>нет

Водитель к которому привязан адрес

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

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

403 Forbidden - нет прав на создание.

404 Not Found - Водитель не найден.

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

Пример

PATCH https://api.url/v2.1/user/1/drivers/1/addresses/1 HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
{
    "data": {
        "id": "1",
        "type": "address",
        "attributes": {
            "Type": 1,
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Location: https://api-test01.citypoint.ru/v2.1/user/1/drivers/1/addresses/1

{
    "links": {
        "self": "https://api-test01.citypoint.ru/v2.1/user/1/drivers/1/addresses/1"
    },
    "data": {
        "id": "1",
        "type": "address",
        "attributes": {
            "Type": 1,
            "Address": "Марксистская 34 к.8"
        },
        "relationships": {
            "Driver": {
                "data": {
                    "id": "1",
                    "type": "driver"
                }
            }
        }
    }
}
}
  • No labels