Инструменты пользователя

Инструменты сайта


ru:airlay:api:air-lay-v4

Это старая версия документа!


Air Lay API v4

Описание

Раздел в процессе разработки

Структура запроса

    /**
     * POST - тип метода Action'а
     * Desctiprion - описание Action
     * request([
     *     "method" => "тип метода",
     *     "url" => "api/v4/controllerName/actionName", - адрес запроса
     *     (полный путь "api/v4/controllerNameComtroller/actionNameAction")
           'file' => 'описание содержимого файла в случае передачи файлом' 
     *     'params' => [
     *         [
     *             'name' => 'Имя параметра',
     *             'type' => 'Тип параметра',
     *             'description' => 'Описание параметра',
     *             'required' => 'Флаг обязателен параметр или нет'
     *         ],
     *         ...
     *     ] - Параметры в случае передачи через параметры
     * ]) - Передаваемые в Action значения 
     * response([  
     *     "status" => 'Статус код ответа', 
     *     "message" => 'Сообщение ответа', 
     *     "code" => 'код ответа' 
     * ]) - Возвращаемое значение после выполнения Action
     * @throws - ошибки которые могут возникать в ходе работы
     *
     * @Authorization - флаг необходимости авторизации
     */

Контроллеры

Milestone

    /**
     * POST
     * 
     * Action for edit dataSet objects.
     * 
     * @param ObjectId $dataSetId DataSet Id
     * @param string json $commit Commit in edit format
     * @return 200 Ok json/kml/dxf/gml file
     */
    /api/v3/dataSet/editor
    /**
     * POST
     * 
     * Action for clean dataSet object
     * 
     * @param ObjectId $dataSetId DataSet Id
     * @return 200 OK
     */
    /api/v3/dataSet/cleaning
ru/airlay/api/air-lay-v4.1621487919.txt.gz · Последнее изменение: 2021/05/20 12:18 — Лев