Различия

Здесь показаны различия между двумя версиями данной страницы.

--- api:test [2018/11/13 07:49]
susanin
+++ api:test [2020/09/24 09:42] (текущий)
@@ Строка 1: / Строка 1: @@
-# Базовые настройки
+======  API ======
+Отправляемые данные могут быть как в **XML** так и в **JSON**. Адреса запросов можно переопределить в настройках приложения: **config/web**:
+  components=>urlManager=>rules
-## База данных
+=====  SITE =====
-**config/db.php**
+==== login ====
-<php>
-<?php
-return [
-    'class' => 'yii\db\Connection',\\
-    'dsn' => 'mysql:host=127.0.0.1;dbname=test',\\
-    'username' => 'root',
-    'password' => 'root',
-    'charset' => 'utf8',
-    'tablePrefix'=>'tst_',
-];
-</php>
-## Первая установка
+Адрес:   ''/api/site/login''
-### Обновление зависимостей
-Для обновления зависимостей необходимо использовать composer https://getcomposer.org/
-`php composer.phar update`
-### Установка миграций
+Метод запрос:   ''POST''
-`./yii migrate/up`
-После установки миграций будет установлен пользователь **admin:admin**
-## Apache/Nginx
-Необходимо настроить файлы правил переадресации запросов на файл index.php
-# API
-Отправляемые данные могут быть как в **XML** так и в **JSON**. Адреса запросов можно переопределить в настройках приложения: **config/web**: `components=>urlManager=>rules`
-#SITE
-### `login`
-Адрес: `/api/site/login`<br>
-Метод запрос: `POST`<br>
 Данные:
-```
+<code>
 [
     'username'=>'admin',
     'password'=>'111111'
 ]
-```
+</code>
 Возвращаемые данные:
-```
+<code>
 [
     'token'=>'0FbEBD-Mo5EzAu9o51684F6hPk7ufCLR',
     'expired'=>'2018-09-22T10:10:11+05:00'
 ]
-```
+</code>
 Полученный токен используется при работе. Отправляется заголовком способом авторизации Bearer
-#### JSON
+===  JSON ===
-```
+<code>
 POST http://susanin.loc/api/request/index
 Accept: application/json
@@ Строка 61: / Строка 33: @@
 Content-Type: application/json; charset=utf-8
 Authorization: Bearer Ciuw2qcWDXbQJIv2tYiB2IeeM9_JEoOc
-```
+</code>
-#### XML
+===  XML ===
-```
+<code>
 POST http://susanin.loc/api/request/index
 Accept: application/xml
@@ Строка 70: / Строка 42: @@
 Content-Type: text/xml; charset=utf-8
 Authorization: Bearer Ciuw2qcWDXbQJIv2tYiB2IeeM9_JEoOc
-```
+</code>
-## REQUEST Заявки
+=====  REQUEST Заявки =====
-### `index`
+==== index ====
-Адрес: `/api/request/index`, `/api/request/`, <br>
+Адрес: ''/api/request/index</code>, <code>/api/request/''>,
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''
 Данные:
 может быть передан массив, будет фильтровать по этим данным.
-```
+<code>
 [
     'contact_name'=>'Николай'
 ]
-```
+</code>
 Возвращаемые данные: список заявок, с отображением услуг
-```
+<code>
 [
     {
@@ Строка 109: / Строка 81: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/request/view?id=1`<br>
+Адрес: ''/api/request/view?id=1''
-Метод запрос: `GET`<br>
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные:
-```
+<code>
 [
     "id": "3",
@@ Строка 139: / Строка 111: @@
     ]
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/request/create`, `/api/request/create?room=1` (при создании от пользователя со стороны клиентов)<br>
+Адрес: ''/api/request/create'', ''/api/request/create?room=1'' (при создании от пользователя со стороны клиентов)
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     'status'=>1,
@@ Строка 153: / Строка 125: @@
     ...
 ]
-```
+</code>
 Возвращаемые данные:
-```
+<code>
 [
     "id": "3",
@@ Строка 173: / Строка 145: @@
     ...
 ]
-```
+</code>
-### `change-status`
+==== change-status ====
-Адрес: `/api/request/change-status`<br>
+Адрес: ''/api/request/change-status''<br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     'status'=>2,
 ]
-```
+</code>
 Возвращаемые данные: новый статус
-```
+<code>
 [
     "status": "2",
 ]
-```
+</code>
-### `delete`
-Адрес: `/api/request/delete?id=3`<br>
+==== delete ====
-Метод запрос: `POST`<br>
+Адрес: ''/api/request/delete?id=3''
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "id": 3
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной записи
-```
+<code>
 "3",
-```
+</code>
-##SERVICE-RESIDENCE Услуга проживание
+===== SERVICE-RESIDENCE Услуга проживание =====
-### `index`
+==== index ====
-Адрес: `/api/service-residence/index?request=1` <br>
+Адрес: ''/api/service-residence/index?request=1'' <br>
-Метод запрос: `GET`<br>
+Метод запрос: ''GET''<br>
 Данные: нет
 Возвращаемые данные: список услуг проживания, с отображением гостей
-```
+<code>
 [
     {
@@ Строка 261: / Строка 234: @@
     },
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/service-residence/view?id=1` <br>
+Адрес: ''/api/service-residence/view?id=1'' <br>
-Метод запрос: `GET`<br>
+Метод запрос: ''GET''<br>
 Данные: нет
 Возвращаемые данные: список услуг проживание, с отображением гостей
-```
+<code>
 [
     "id": 1,
@@ Строка 315: / Строка 288: @@
     ]
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/service-residence/create?request=1` <br>
+Адрес: ''/api/service-residence/create?request=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "placement": 41,
     "status": 2,
 ]
-```
+</code>
 Возвращаемые данные: список всех полей созданной модели без гостей
-```
+<code>
 [
     "request": "1",
@@ Строка 339: / Строка 312: @@
     "id": 124
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/service-residence/update?id=1` <br>
+Адрес: ''/api/service-residence/update?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "placement": 33,
@@ Строка 351: / Строка 324: @@
     "request": 4,
 ]
-```
+</code>
 Возвращаемые данные: все данные текущей модели без гостей
-```
+<code>
 [
     "request": "1",
@@ Строка 365: / Строка 338: @@
     ...
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/service-residence/delete?id=1` <br>
+Адрес: ''/api/service-residence/delete?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "id": 1
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной услуги
-```
+<code>
-```
+</code>
-##SERVICE-TRANSFER Услуга трансфер
+===== SERVICE-TRANSFER Услуга трансфер =====
-### `index`
+==== index ====
-Адрес: `/api/service-transfer/index?request=1` <br>
+Адрес: ''/api/service-transfer/index?request=1'' <br>
-Метод запрос: `GET`<br>
+Метод запрос: ''GET''<br>
 Данные: нет
 Возвращаемые данные: список услуг трансфер
-```
+<code>
 [
     {
@@ Строка 422: / Строка 395: @@
     },
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/service-transfer/view?id=1` <br>
+Адрес: ''/api/service-transfer/view?id=1'' <br>
-Метод запрос: `GET`<br>
+Метод запрос: ''GET''<br>
 Данные: нет
 Возвращаемые данные: всех услуг трансфер
-```
+<code>
 [
      "id": "1",
@@ Строка 461: / Строка 434: @@
       "comments": null
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/service-transfer/create?request=1` <br>
+Адрес: ''/api/service-transfer/create?request=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
  "request": "1",
@@ Строка 478: / Строка 451: @@
   "id": 3
 ]
-```
+</code>
 Возвращаемые данные: список всех полей созданной модели
-```
+<code>
 [
-```
+<code>
-### `update`
+==== update ====
-Адрес: `/api/service-transfer/update?id=1` <br>
+Адрес: ''/api/service-transfer/update?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "delivery_date": 1537524792,
@@ Строка 495: / Строка 468: @@
     "comments": "Попросили позвонить уточнить",
 ]
-```
+</code>
 Возвращаемые данные: все данные текущей модели
-```
+<code>
 [
       "id": 1,
@@ Строка 533: / Строка 506: @@
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/service-residence/delete?id=1` <br>
+Адрес: ''/api/service-residence/delete?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
         "id": 1
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной услуги
-```
+<code>
-```
+</code>
-##SERVICE Услуга (остальные)
+===== SERVICE Услуга (остальные) =====
-### `index`
+==== index ====
-Адрес: `/api/service/index?request=1`, `/api/service/index?request=1&service_type=2` если нужна выборка по типу услуги
+Адрес: ''/api/service/index?request=1'', ''/api/service/index?request=1&service_type=2'' если нужна выборка по типу услуги
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: список всех остальных услуг
-```
+<code>
 [
     {
@@ Строка 584: / Строка 557: @@
     },
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/service/view?id=1`
+Адрес: ''/api/service/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: текущая модель
-```
+<code>
 [
    "id": 1,
@@ Строка 617: / Строка 590: @@
    "comments": null
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/service/create?request=1&service_type=2`
+Адрес: ''/api/service/create?request=1&service_type=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "reserve_price": 12.5,
     "pay_date": "12.10.2019"
 ]
-```
+</code>
 Возвращаемые данные: список всех ненулевых полей созданной модели
-```
+<code>
 [
   "request": 4,
@@ Строка 643: / Строка 616: @@
   "id": 12
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/service/update?id=1`
+Адрес: ''/api/service/update?id=1''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "description_dealer": "Описание 1",
@@ Строка 655: / Строка 628: @@
     "very_nice_vacation":"1"
 ]
-```
+</code>
 Возвращаемые данные: все данные текущей модели
-```
+<code>
 [
     "service": {
@@ Строка 689: / Строка 662: @@
       }
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/service/delete?id=1` <br>
+Адрес: ''/api/service/delete?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
         "id": 1
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной услуги
-```
+<code>
-```
+</code>
-## SERVICE-RESIDENCE-GUEST Гости услуги проживание
+=====  SERVICE-RESIDENCE-GUEST Гости услуги проживание =====
-### `index`
+==== index ====
-Адрес: `/api/service-residence-guest/index?service=1`
+Адрес: ''/api/service-residence-guest/index?service=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: Список гостей определенной услуги
-```
+<code>
 [
     {
@@ Строка 723: / Строка 696: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/service-residence-guest/view?id=1`
+Адрес: ''/api/service-residence-guest/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: текущая модель с заданным ID
-```
+<code>
 [
     "id": 1,
@@ Строка 739: / Строка 712: @@
     "nationality": 3,
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/service-residence-guest/create?request=1&service=1` <br>
+Адрес: ''/api/service-residence-guest/create?request=1&service=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "name": "Василий Иванович",
@@ Строка 751: / Строка 724: @@
     "nationality": 3,
 ]
-```
+</code>
 Возвращаемые данные: модель созданного гостя
-```
+<code>
 [
     "service": 1,
@@ Строка 762: / Строка 735: @@
     "id": 1,
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/service-residence-guest/update?id=1`
+Адрес: ''/api/service-residence-guest/update?id=1''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Иван Иванович",
@@ Строка 774: / Строка 747: @@
     "nationality": 2,
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
     "service": 1,
@@ Строка 785: / Строка 758: @@
     "id": 1,
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/service-residence-guest/delete?id=1` <br>
+Адрес: ''/api/service-residence-guest/delete?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "id": 1
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-## DOCUMENTS Документы
+=====  DOCUMENTS Документы
+ =====
+==== index ====
+Адрес: ''/api/document/index?object_type=40&object_id=1''
-### `index`
+Метод запрос: ''GET''
-Адрес: `/api/document/index?object_type=40&object_id=1`
-Метод запрос: `GET`
 Данные:
-```
+<code>
 /api/document/index?object_type=40object_id=1
 object_type:
@@ Строка 820: / Строка 793: @@
 - 'Услуга проживание',
 - 'Документ',
-```
+<code>
 Возвращаемые данные: Список документов текущего объекта
-```
+<code>
 [
     {
@@ Строка 848: / Строка 821: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/document/view?id=1`
+Адрес: ''/api/document/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 [
     "id": 27,
@@ Строка 867: / Строка 840: @@
     "updated_at": 1537861841
 ]
-```
+</code>
-### `create`
+==== create ====
-Адрес: `/api/document/create?request=1&service=1`
+Адрес: ''/api/document/create?request=1&service=1''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     upload_file: ФАЙЛ (например через form-data)
@@ Строка 879: / Строка 852: @@
     type: Тип файла (указан в  /document-type/index)
 ]
-```
+</code>
 Возвращаемые данные: модель созданного документа
-```
+<code>
 [
     "object_type": "40",
@@ Строка 892: / Строка 865: @@
     "id": 29
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/document/update?id=27` <br>
+Адрес: ''/api/document/update?id=27'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "upload_file": ФАЙЛ,
@@ Строка 904: / Строка 877: @@
     "type": 2,
 ]
-```
+</code>
 Возвращаемые данные: данные с новыми данными
-```
+<code>
 [
     "id": 27,
@@ Строка 918: / Строка 891: @@
     "updated_at": 1537864591
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/document/delete?id=1` <br>
+Адрес: ''/api/document/delete?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "id": 27
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной записи
-```
+<code>
-```
+</code>
-##NOTIFICATION Уведомления
+===== NOTIFICATION Уведомления =====
-### `list`
+==== list ====
-Адрес: `/api/notification/list`
+Адрес: ''/api/notification/list''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: Список доступных уведомлений
-```
+<code>
 {
     "comment": "Комментарии",
     "adding_new_object": "Добавление нового объекта"
 }
-```
+<code>
-### `user`
+==== user ====
-Адрес: `/api/notification/user`, `/api/notification/user?id=1`
+Адрес: ''/api/notification/user'', ''/api/notification/user?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: Список доступных уведомлений для текущего
 пользователя с учетом уведомлений компании. Если ID не указан,
 берется ID текущего залогиненного пользователя
-```
+<code>
 {
     "comment": "1",
     "adding_new_object": "0"
 }
-```
+<code>
-### `index`
+==== index ====
-Адрес: `/api/notification/index`
+Адрес: ''/api/notification/index''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: Список уведомлений
-```
+<code>
 [
     {
@@ Строка 989: / Строка 962: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/notification/view?id=1`
+Адрес: ''/api/notification/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
     "id": 2,
@@ Строка 1005: / Строка 978: @@
     "updated_at": 1538154592
 }
-```
+<code>
-## BANK Банки
+=====  BANK Банки
+ =====
+==== index ====
+Адрес: ''/api/bank/index''
-### `index`
+Метод запрос: ''POST''
-Адрес: `/api/bank/index`
-Метод запрос: `POST`
 Данные:
-```
+<code>
         [
             name: название банка
             bik: БИК банка
         ]
-```
+</code>
 Возвращаемые данные: Список банков текущего объекта удовлетворяющие переданным параметрам - name, bik. Параметры не обязательные. Без указания параметров будет выведен весь список банков.
-```
+<code>
 [
     {
@@ Строка 1038: / Строка 1011: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/bank/view?id=1`
+Адрес: ''/api/bank/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
         "id": 1,
@@ Строка 1056: / Строка 1029: @@
         "updated_at": 1535112844
     }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/bank/create`
+Адрес: ''/api/bank/create''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
         "name": "Название банка" (обязательное поле),
@@ Строка 1072: / Строка 1045: @@
         "updated_at": 1535112844
 ]
-```
+</code>
 Возвращаемые данные: модель созданного документа
-```
+<code>
 [
         "name": "Название банка" (обязательное поле),
@@ Строка 1085: / Строка 1058: @@
         "id":2
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/bank/update?id=2`
+Адрес: ''/api/bank/update?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Другое название",
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
     "id": 2,
@@ Строка 1109: / Строка 1082: @@
     "updated_at": 1538742606
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/bank/delete?id=2`
+Адрес: ''/api/bank/delete?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
    "id": 2
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-## COMPANY Компании
-### `index`
+=====  COMPANY Компании
-Адрес: `/api/company/index`
+ =====
+==== index ====
+Адрес: ''/api/company/index''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
         [
             name: Название компании (осуществляет поиск по всем именам: name, full_name, private_name
@@ Строка 1147: / Строка 1120: @@
         Поставщик:      20
         Канал-менеджер: 30
-```
+<code>
 Возвращаемые данные: Список компаний текущего объекта удовлетворяющие переданным параметрам. Параметры не обязательные.
 Без указания параметров будет выведен весь список компаний.
-```
+<code>
 [
     {
@@ Строка 1173: / Строка 1146: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/company/view?id=1`
+Адрес: ''/api/company/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
     "id": "1",
@@ Строка 1199: / Строка 1172: @@
     "orm_field": null  //ORM поля c префиксом orm_
     }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/company/create`
+Адрес: ''/api/company/create''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name":"Компания компаний",
@@ Строка 1212: / Строка 1185: @@
     "logo": //ORM поле, без указания префикса
 ]
-```
+</code>
 Возвращаемые данные: модель компании и модель автоматически созданной компании-поставщика
-```
+<code>
 [
     "company": {
@@ Строка 1237: / Строка 1210: @@
     }
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/company/update?id=1` <br>
+Адрес: ''/api/company/update?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "name":"Компания компаний",
@@ Строка 1250: / Строка 1223: @@
    "logo": //ORM поле, без указания префикса
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
         "status": 1,
@@ Строка 1267: / Строка 1240: @@
         "orm_logo": "uploads/images/c03cfe3672022df9b0ad4aedbe3d52d6.jpg"
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/company/delete?id=2` <br>
+Адрес: ''/api/company/delete?id=2'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "id": 2
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-### `delete-file` удаление ORM данных
+==== delete-file удаление ORM данных ====
-Адрес: `/api/company/delete-file?id=2&field=logo` <br>
+Адрес: ''/api/company/delete-file?id=2&field=logo'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные: имя поля указывается без префикса
 Возвращаемые данные: модель с обновленными ORM полями
-```
+<code>
  "status": 1,
         "name": "Компания компаний",
@@ Строка 1302: / Строка 1275: @@
         "id": 162,
         "orm_logo": null
-```
+<code>
-## HOTEL Гостиницы
+=====  HOTEL Гостиницы =====
+==== index ====
+Адрес: ''/api/company/index'', ''/api/company/index?limit=20&offset=0'' с указанием количества отображаемый записей (limit) и сдвиг (offset)
-### `index`
+Метод запрос: ''POST''
-Адрес: `/api/company/index`, `/api/company/index?limit=20&offset=0` с указанием количества отображаемый записей (limit) и сдвиг (offset)
-Метод запрос: `POST`
 Данные:
-```
+<code>
         [
             search: Строка поиска. Поиск осуществляется по названию, адресу, псевдониму (alias)
@@ Строка 1318: / Строка 1290: @@
             city_name: Фильтр по городу (имеет предпочтение перед city_country)
         ]
-```
+</code>
 Возвращаемые данные: Список моделей удовлетворяющие переданным параметрам. Параметры не обязательные.
@@ Строка 1324: / Строка 1296: @@
 Orm поля начинаются с префикса orm_
-```
+<code>
     {
@@ Строка 1373: / Строка 1345: @@
         ]
     },
-```
+<code>
-### `view`
+==== view ====
-Адрес: `/api/company/view?id=1`
+Адрес: ''/api/company/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
     "id": 1,
@@ Строка 1441: / Строка 1413: @@
     ]
     }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/hotel/create`
+Адрес: ''/api/hotel/create''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name":"Гостиница 2",   *
@@ Строка 1455: / Строка 1427: @@
     * - обязательные поля
 ]
-```
+</code>
 Возвращаемые данные: модель гостиницы и модель автоматически созданного номера Sql гостиницы
-```
+<code>
 [
     "hotel": {
@@ Строка 1498: / Строка 1470: @@
     }
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/hotel/update?id=1` <br>
+Адрес: ''/api/hotel/update?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "name":"Гостиница 3",
@@ Строка 1512: / Строка 1484: @@
     "logo": //ORM поле, без указания префикса
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
 "name": "Гостиница 2",
@@ Строка 1545: / Строка 1517: @@
         "orm_field": null  //ORM поля c префиксом orm_
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/hotel/delete?id=2` <br>
+Адрес: ''/api/hotel/delete?id=2'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "id": 2
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-### `delete-file` удаление ORM поля
+==== ''delete-file'' удаление ORM поля ====
-Адрес: `/api/hotel/delete-field?id=2&field=photo`
+Адрес: ''/api/hotel/delete-field?id=2&field=photo''
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные: имя поля указывается без префикса
 Возвращаемые данные: редактируемая модель
-```
+<code>
 {   "id": 53,
     "city": 1,
@@ Строка 1603: / Строка 1575: @@
     "orm_photo": null
 }
-```
+<code>
-## USER Пользователи
+=====  USER Пользователи =====
+==== index ====
+Адрес: ''/api/user/index'', ''/api/user/index?type=susanin'' - пользователи компании, в противном случае список клиентов
-### `index`
+Метод запрос: ''POST''
-Адрес: `/api/user/index`, `/api/user/index?type=susanin` - пользователи компании, в противном случае список клиентов
-Метод запрос: `POST`
 Данные:
-```
+<code>
         [
             type: тип пользователя
@@ Строка 1640: / Строка 1611: @@
             Директор        50
-```
+<code>
 Возвращаемые данные: Список моделей удовлетворяющие переданным параметрам. Параметры не обязательные.
 Без указания параметров будет выведен список пользователей клиентов.
-```
+<code>
         {
@@ Строка 1670: / Строка 1641: @@
             "updated_at": 1531995144
         }
-```
+<code>
-### `view`
+==== view ====
-Адрес: `/api/user/view?id=1`
+Адрес: ''/api/user/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
        "id": 3,
@@ Строка 1690: / Строка 1661: @@
        "updated_at": 1531995494
 }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/user/create`
+Адрес: ''/api/user/create''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "login":"ivan",
@@ Строка 1717: / Строка 1688: @@
             Начальник       40
             Директор        50
-```
+<code>
 Возвращаемые данные: модель созданного объекта
-```
+<code>
 [
         "status": true,
@@ Строка 1732: / Строка 1703: @@
         "id": 13
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/user/update?id=1` <br>
+Адрес: ''/api/user/update?id=1'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "login":"ivan",
@@ Строка 1747: / Строка 1718: @@
     "company": 10
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
         "status": true,
@@ Строка 1762: / Строка 1733: @@
         "id": 13
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/user/delete?id=2` <br>
+Адрес: ''/api/user/delete?id=2'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
    "id": 2
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-## CITY Города
-### `index`
+=====  CITY Города =====
-Адрес: `/api/city/index?country=1&letter=А`
+==== index ====
+Адрес: ''/api/city/index?country=1&letter=А''
-Метод запрос: `GET`
+Метод запрос: ''GET''
-Данные: `country - страна, $letter - буква`
+Данные: ''country - страна, $letter - буква''
 Возвращаемые данные: Список банков текущего объекта удовлетворяющие переданным параметрам name, bik. Параметры не обязательные. Без указания параметров будет выведен весь список банков.
-```
+<code>
 [
     {
@@ Строка 1799: / Строка 1769: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/city/view?id=1`
+Адрес: ''/api/city/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
     "id": 1,
@@ Строка 1813: / Строка 1783: @@
     "code": "SVX"
 }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/city/create?country=1`
+Адрес: ''/api/city/create?country=1''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Абакан",
     "code": "ABK"
 ]
-```
+</code>
 Возвращаемые данные: модель созданного документа
-```
+<code>
 [
     "id": 7,
@@ Строка 1833: / Строка 1803: @@
     "code": "MSK"
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/city/update?id=2` <br>
+Адрес: ''/api/city/update?id=2'' <br>
-Метод запрос: `POST`<br>
+Метод запрос: ''POST''<br>
 Данные:
-```
+<code>
 [
     "country": 1,
@@ Строка 1845: / Строка 1815: @@
     "code": "MSK"
 ]
-```
+</code>
 Возвращаемые данные: данные с новыми данными
-```
+<code>
 [
     "id": 7,
@@ Строка 1854: / Строка 1824: @@
     "code": ""
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/bank/delete?id=2`
+Адрес: ''/api/bank/delete?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
 ]
-```
+</code>
 Возвращаемые ID удаленной записи
-```
+<code>
-```
+</code>
-## HOTEL-ROOM Номера гостиниц
+=====  HOTEL-ROOM Номера гостиниц =====
-### `index`
+==== index ====
-Адрес: `/api/hotel-room/index?hotel=1`
+Адрес: ''/api/hotel-room/index?hotel=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
-Данные: `hotel - ID гостиницы`
+Данные: ''hotel - ID гостиницы''
 Возвращаемые данные: Список моделей текущего объекта удовлетворяющие переданным параметрам. Параметры не обязательные. Без указания параметров будет выведен весь список.
-```
+<code>
 [
     {
@@ Строка 1896: / Строка 1866: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/hotel-room/view?id=1`
+Адрес: ''/api/hotel-room/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
 {
     "id": 2,
@@ Строка 1916: / Строка 1886: @@
     "description": "Описание номера"
 }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/hotel-room/create?hotel=1`
+Адрес: ''/api/hotel-room/create?hotel=1''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Стандарт 2",
     "price_stand": "2300"
 ]
-```
+</code>
 Возвращаемые данные: модель созданного объекта
-```
+<code>
 [
     "hotel": "1",
@@ Строка 1940: / Строка 1910: @@
     "id": 17
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/hotel-room/update?id=2`
+Адрес: ''/api/hotel-room/update?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Стандарт 2",
     "price_stand": "23000"
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
     "hotel": "1",
@@ Строка 1964: / Строка 1934: @@
     "id": 17
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/hotel-room/delete?id=2`
+Адрес: ''/api/hotel-room/delete?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной записи
-```
+<code>
-```
+</code>
-## COMPANY-CONSIGNEE Грузополучатели
+=====  COMPANY-CONSIGNEE Грузополучатели =====
-### `index`
+==== index ====
-Адрес: `/api/company-consignee/index`
+Адрес: ''/api/company-consignee/index''
-Метод запрос: `POST`
+Метод запрос: ''POST''
-Данные: `name: Наименование грузополучателя`, `company: ID компании грузополучателя`
+Данные: ''name: Наименование грузополучателя'', ''company: ID компании грузополучателя''
 Возвращаемые данные: Список моделей текущего объекта удовлетворяющие переданным параметрам. Параметры не обязательные. Без указания параметров будет выведен весь список.
-```
+<code>
 [
     {
@@ Строка 2000: / Строка 1970: @@
     }
 ]
-```
+</code>
-### `view`
+==== view ====
-Адрес: `/api/company-consignee/view?id=1`
+Адрес: ''/api/company-consignee/view?id=1''
-Метод запрос: `GET`
+Метод запрос: ''GET''
 Данные: нет
 Возвращаемые данные: данные текущей модели
-```
+<code>
     {
         "id": 2,
@@ Строка 2014: / Строка 1984: @@
         "company": 133
     }
-```
+<code>
-### `create`
+==== create ====
-Адрес: `/api/company-consignee/create`
+Адрес: ''/api/company-consignee/create''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
         "name": "Компания 1",
@@ Строка 2026: / Строка 1996: @@
         "company": 133
 ]
-```
+</code>
 Возвращаемые данные: модель созданного объекта
-```
+<code>
 [
         "name": "Компания 1",
@@ Строка 2035: / Строка 2005: @@
         "id": 3
 ]
-```
+</code>
-### `update`
+==== update ====
-Адрес: `/api/company-consignee/update?id=2`
+Адрес: ''/api/company-consignee/update?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
     "name": "Компания 1",
 ]
-```
+</code>
 Возвращаемые данные: модель с новыми данными
-```
+<code>
 [
         "name": "Компания 1",
@@ Строка 2054: / Строка 2024: @@
         "id": 3
 ]
-```
+</code>
-### `delete`
+==== delete ====
-Адрес: `/api/company-consignee/delete?id=2`
+Адрес: ''/api/company-consignee/delete?id=2''
-Метод запрос: `POST`
+Метод запрос: ''POST''
 Данные:
-```
+<code>
 [
 ]
-```
+</code>
 Возвращаемые данные: ID удаленной записи
-```
+<code>
-```
+</code>