Page tree

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

Skip to end of metadata
Go to start of metadata

Получение информации по типам ТС (поле CarType в Car)

Запрос:

URL:

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

GET https://api.url/v2.1/carsTypes

Запрос типа ТС по id:

GET https://api.url/v2.1/carsTypes/<carType_id>

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

               Доп. параметры не допускаются. При получении будет ошибка 400.

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

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

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

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

Ответ:

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

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

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

metaСодержит total_count - количество типов ТС в системе
data

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

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

ПолеТипОписание
idintИдентификатор датчика
typestring

Тип ресурса (всегда "carType")

attributesobjectДанные объекта (см. Описание атрибутов датчика)

Описание атрибутов типа ТС:

НазваниеТипNullableОписание
Descriptionstringнет

Описание типа

Category
intнет

Категория (список категорий приведён ниже)

IconstringнетСсылка на иконку Типа ТС

Категории ТС:

КатегорияОписание
0Прочее
10А - Мотоциклы
20B - Легковые, до 3500 кг., до 8 человек
30C - Грузовые, свыше 3500 кг.
40D - Перевозка пассажиров, более 8 человек

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

200 ОК - Сервер обработал запрос. В теле ответа  содержится список список ТС. Также будет передан заголовок Last-Modified.

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

401 Unauthorized - не передан заголовок Authorization, либо токен невалидный или окончилась валидация.

403 Forbidden - нет прав на просмотр (id пользователя не соответствует токену).

404 Not Found - запрошенный тип не найден .

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

Пример:

GET http://api.url/v2.1/carsTypes HTTP/1.1
Accept: application/vnd.api+json

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": "http://api.url/v2.1/carsTypes",
    },
    "meta": {
        "total_count": 70
    },
    "data": [
        { "id": "1",
          "type": "carType",
          "attributes": {
              "Description": "Тягач",
              "Category": 30,
			  "Icon": "http://icon.server.url/pic/cars/car_1.png"
          }
        },
        { "id": "2",
          "type": "carType",
          "attributes": {
              "Destination": "Грузовая",
              "Category": 30,
			  "Icon": "http://icon.server.url/pic/cars/car_2.png"
          }
        }
        ... остальные типы тс ...
    ]
}


Запрос типа ТС по id:

GET http://api.url/v2.1/carsTypes/1 HTTP/1.1
Accept: application/vnd.api+json

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": "http://api.url/v2.1/carsTypes/1",
    },
    "data": {
        { "id": "1",
          "type": "carType",
          "attributes": {
              "Description": "Тягач",
              "Category": 30,
			  "Icon": "http://icon.server.url/pic/cars/car_1.png"
          }        
    }
}
  • No labels