API CityPoint
Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос на создание новой команды.

Возможно создавать команды из уже команд имеющихся в протоколе устройства данной ТС.

Команды будет создана для всех ТС с тем же протоколом БУ что и на указанной в запросе.

Создание команд используется для предустановки различных параметров команд протокола.

Запрос:

URL:

PUSH https://api.url/v2.1/user/<user_id>/cars/<car_id>/commands/allowed

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

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

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

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


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

Список атрибутов команды:

ПолеТипNullОписание
NametextнетНазвание команды
DescriptiontextдаОписание команды

ParametersValues

objectда

Установленные параметры команды

Атрибут Parameters всегда берётся сервером из родительской команды.


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

ПолеТипNullОписание
Creatorobject<user>да

Кто создал команду

Игнорируется. Проставляется сервером автоматически

ParentCommandIdobject<commandDescripion>нетИз какой команды создана данная


Пример:

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

{
	    "data": {
        "type": "commandDescription",
        "attributes": {
            "Name": "make noise",
            "Description": "Turn Alarm ON for 5 seconds",
            "ParametersValues": {
                "Duration": "5"
            }
        },
        "relationships": {
            "ParentCommandId": {
                "data": {
                    "id": "3", "type": "commandDescription"
                }
            }
        }
    }
}


HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://api.url/v2.1/user/1/cars/1/commands/allowed/25"
    },
    "meta": {
        "total_count": 3
    },
    "data": {
        "id": "25",
        "type": "commandDescription",
        "attributes": {
            "Name": "make noise",
            "Description": "Turn Alarm ON for 5 seconds",
            "Parameters": [   
                 {
                     "name": "Duration",
                     "description": "how long alarm should be turned on, in seconds",
                     "type": "int"
                 }
            ],
            "ParametersValues": {
                "Duration": "5"
            }
        },
        "relationships": {
            "ParentCommandId": {
                "data": {
                    "id": "3", "type": "commandDescription"
                }
            }
        },
        {
            "Creator": {
               "data": { "type": "user", "id": "1" }
            }
        }
    }
}
  • No labels