Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на создание ТС.

Запрос:

URL:

      POST https://api.url/v2.1/user/<user_id>/cars

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

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

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

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


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

 Список атрибутов ТС:

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

Инвентарный номер ТС

BrandstringдаМарка ТС
Modelstringда

Модель ТС

RegNumberstringнетРегистрационный номер ТС
VINstringдаVIN номер
IsHiddenboolнетСкрывать ТС
ReleaseDatedateдаДата выпуска ТС (когда тс была собрана)
DescriptionstringдаОписание, необязательное поле.

DateOfCreation

datetimeдаДата создания ТС, должно быть либо null либо вообще отсутствовать.

Список связанных оъектов

ПолеТипNullableОписание
CarTypeObject<carType>нетТип ТС
CarStateObject<carState>даСостояние ТС
FuelType
Object<fuelType>даТип топлива
DeviceObject<device>даБУ

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

201 Created - Сервер обработал запрос. В теле ответа  содержится созданные объект.

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

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

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

Пример

Запрос списка всех ТС:

POST https://api.url/v2.1/user/1/cars HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "car",
        "attributes": {
            "InventoryNumber": "",
            "Brand": null,
            "Model": null,
            "RegNumber": "k 123 at 111",
            "VIN": null,
            "IsHidden": true,
            "ReleaseDate": "2014-01-01",
        },
        "relationships":{
            "СarType": { 
                "data": {"type": "carType", "id": "1"}
            },
            "FuelType": {
                "data": {"type": "fuelType","id": "1"}
            }
        }
    }
}


HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Location: https://api.url/v2.1/user/1/cars/1

{
    "links": {
        "self": "http://api.url/v2.1/user/1/cars/1",
    },
    "data": {
        "type": "car",
        "id": "1",
        "attributes": {
            "InventoryNumber": "",
            "Brand": null,
            "Model": null,
            "RegNumber": "k 123 at 111",
            "VIN": null,
            "IsHidden": true,
            "Description": null,
            "ReleaseDate": "2014-01-01",
            "DateOfCreation": "2018-10-09T16:04:19Z"
        },
        "relationships":{
            "СarType": { 
                "data": {"type": "carType", "id": "1"}
            },
            "СarState": null,
            "FuelType": {
                "data": {"type": "fuelType","id": "1"}
            },
            "OperatedZones": {
                "links": {"self": "http://api.url/v2.1/user/1/cars/1/relationships/OperatedZones"}
            },
            "Device": {
                "data": null
            }
        }
    }
}
  • No labels