{ "openapi": "3.0.0", "info": { "title": "Проект Диспетчерской ЦУРОГ", "description": "Переводим на web интерфейс диспетчерскую задачу ЦУРОГ г.Хабаровска", "contact": { "name": "ООО ЦУРОГ-1", "url": "https://380380.рф" }, "version": "2.0.0" }, "servers": [ { "url": "https://dev.curog.ru/api", "description": "Учебный сервер" }, { "url": "http://localhost/api", "description": "сервер, поднятый через Dockers" }, { "url": "http://localhost:8000/api", "description": "Сервер поднятый PHPStorm на localhost" } ], "paths": { "/home_streets/{home_street}/firms": { "get": { "tags": [ "Address" ], "summary": "Список договоров управления/ресурсоснабжения организаций по адресу", "description": "AddressHomeFirmsController (privileges: Global: SYSTEM, ADMIN, FIRM)", "operationId": "address_home_firms_index", "parameters": [ { "name": "home_street", "in": "path", "description": "идентификатор адреса", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "фильтр по дате. Выбираем записи, которые действовали на данную дату. null - все записи", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmHomeCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/all_addresses": { "get": { "tags": [ "Address" ], "summary": "Список адресов с квартирами по условию", "description": "Address/AllAddressController (ограничения будут реализованы в самом запросе)", "operationId": "all_addresses.index", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "customerId", "in": "query", "description": "фильтр по ID коду УК/РСО", "required": false }, { "name": "contractorId", "in": "query", "description": "фильтр по ID подрядчика", "required": false }, { "name": "divisionId", "in": "query", "description": "фильтр по ID участка подрядчика", "required": false }, { "name": "cityId", "in": "query", "description": "Фильтр по ID населенного пункта", "required": false }, { "name": "streetId", "in": "query", "description": "Фильтр по ID улицы", "required": false }, { "name": "homeNumber", "in": "query", "description": "Фильтр по номеру дому", "required": false }, { "name": "parity", "in": "query", "description": "true - только четные дома, false - только нечетные дома, null - все дома", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAddressInfoCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/home_streets": { "get": { "tags": [ "Address" ], "summary": "Список адресов (по нас.пункту, улице, или дому)", "description": "HomeStreetController ( privileges: AllUsers (запрета нет) )", "operationId": "addressIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "description": "Чей список адресов получаем: (city - нас.пункта; street - улицы; home - по дому)", "required": true, "content": { "application/json": { "schema": { "enum": [ "city", "home", "street" ] } } } }, { "name": "objectId", "in": "query", "description": "Код ресурса владельца", "required": true }, { "name": "street_name", "in": "query", "description": "Фильтрация по наименовании улицы", "required": false }, { "name": "home_number", "in": "query", "description": "Фильтрация по номеру дома", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Ввод нового адрес. Может вместе с домом", "description": "HomeStreetController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "addressStore", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/home_streets/{home_street}": { "get": { "tags": [ "Address" ], "summary": "Просмотр адреса", "description": "HomeStreetController (privileges: Global: SYSTEM, ADMIN)", "operationId": "addressShow", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление адреса", "description": "HomeStreetController (privileges: Global: SYSTEM, ADMIN)", "operationId": "addressDelete", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование адреса", "description": "HomeStreetController (privileges: Global: SYSTEM, ADMIN)", "operationId": "addressUpdate", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/uk_home_streets": { "get": { "tags": [ "Address" ], "summary": "Список адресов (по нас.пункту, улице, или дому)", "description": "UKHomeStreetController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "addressUKIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице", "required": false }, { "name": "date", "in": "query", "description": "Дата, на которую нас интересует список адресов", "required": false }, { "name": "city_id", "in": "query", "description": "код id города", "required": false }, { "name": "street_name", "in": "query", "description": "Фильтрация по наименовании улицы", "required": false }, { "name": "street_id", "in": "query", "description": "Фильтрация коду улицы", "required": false }, { "name": "home_number", "in": "query", "description": "Фильтрация по номеру дома", "required": false }, { "name": "firm_id", "in": "query", "description": "код поставщика. Если введен, то выводим список домов, которые не принадлежат указанному Поставщику (это должен быть именно поставщик)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/all_properties": { "get": { "tags": [ "Properties" ], "summary": "Список всех свойств", "description": "AllPropertyController (privileges: R0)", "operationId": "allPropertyIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "name", "in": "query", "description": "для фильтрации по имени", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllProperties" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Properties" ], "summary": "создание свойства", "description": "AllPropertyController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "prop_id" ], "properties": { "prop_id": { "description": "код свойства", "type": "string", "example": "accept-calls" }, "prop_name": { "description": "описание свойства", "type": "string", "example": "Принимать обращения от жителей этой организации в ЦУРОГ" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllProperty" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/all_properties/{all_property}": { "get": { "tags": [ "Properties" ], "summary": "вывод данных о текущем свойстве", "description": "AllPropertyController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyShow", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllPropertyWithValues" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Удаление свойства из базы данных", "description": "AllPropertyController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyDelete", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Properties" ], "summary": "Изменение данных свойства", "description": "AllPropertyController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyUpdate", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "prop_id" ], "properties": { "prop_id": { "description": "код свойства", "type": "string", "example": "accept-calls" }, "prop_name": { "description": "описание свойства", "type": "string", "example": "Принимать обращения от жителей этой организации в ЦУРОГ" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllProperty" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/all_properties/{all_property}/all_property_values": { "get": { "tags": [ "Properties" ], "summary": "Список всех значение свойства", "description": "AllPropertyValueController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyValueIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "all_property", "in": "path", "description": "ресурс свойства", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllPropertyValue" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Properties" ], "summary": "создание значения свойства", "description": "AllPropertyValueController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyValueStore", "parameters": [ { "name": "all_property", "in": "path", "description": "ресурс свойства", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "value" ], "properties": { "value": { "description": "значение свойства", "type": "string", "example": "да" }, "description": { "description": "Пояснение этого значения", "type": "string", "example": "с обратным обзвоном" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllPropertyValue" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/all_properties/{all_property}/all_property_values/{all_property_value}": { "get": { "tags": [ "Properties" ], "summary": "вывод данных о текущем значении свойства", "description": "AllPropertyValueController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса свойства", "required": true }, { "name": "all_property_value", "in": "path", "description": "номер ресурса значения свойства", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllPropertyValue" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Properties" ], "summary": "Удаление значения свойства из базы данных", "description": "AllPropertyValueController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyValueDelete", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса свойства", "required": true }, { "name": "all_property_value", "in": "path", "description": "номер ресурса значения свойства", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Properties" ], "summary": "Изменение значения свойства", "description": "AllPropertyValueController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allPropertyValueUpdate", "parameters": [ { "name": "all_property", "in": "path", "description": "номер ресурса свойства", "required": true }, { "name": "all_property_value", "in": "path", "description": "номер ресурса значения свойства", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "value" ], "properties": { "value": { "description": "значение свойства", "type": "string", "example": "да" }, "description": { "description": "Пояснение этого значения", "type": "string", "example": "с обратным обзвоном" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllPropertyValue" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calendar": { "get": { "tags": [ "Catalog" ], "summary": "Календарь", "description": "CalendarsController (privileges: SYSTEM, ADMIN, AllUsers )", "operationId": "calendar.index", "parameters": [ { "name": "year", "in": "query", "description": "Год календаря", "required": true, "example": 2025 } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calendar/{calendar}": { "patch": { "tags": [ "Catalog" ], "summary": "Изменение статуса дня", "description": "calendarController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "calendarUpdate", "parameters": [ { "name": "calendar", "in": "path", "description": "Идентификатор записи", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IDay" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDay" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_controls": { "get": { "tags": [ "Calls" ], "summary": "Список обращений, находящихся на контроле у пользователя", "description": "Calls/CallControlController ( privileges: Calls - R1 )", "operationId": "call_controls.index", "parameters": [ { "name": "userId", "in": "query", "description": "ID пользователя", "required": true }, { "name": "status", "in": "query", "description": "Фильтр по статусу контроля (0 - снят с контроля; 1 - поставлен на контроль)", "required": false }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - Выводим без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallControl" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Calls" ], "summary": "Установка контроля пользователя за обращением", "description": "Calls/CallControlController ( privileges: Calls - C1 )", "operationId": "call_controls.store", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallControl" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallControl" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_controls/{call_control}": { "patch": { "tags": [ "Calls" ], "summary": "Снятие обращения с контроля пользователя", "description": "Calls/CallControlController (уровень доступа Call => U1)", "operationId": "call_control.update", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "call_control", "in": "path", "description": "номер ресурса контроля обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallControl" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallControl" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls": { "get": { "tags": [ "Calls" ], "summary": "Список обращений. Для разных значений Application-Type будут выводится разные данные в подчиненных массивах. Для подробной информации нужно обратиться к сервисному классу", "description": "Calls/CallController ( privileges: Calls - R1 )", "operationId": "calls.index", "parameters": [ { "name": "Application-Type", "in": "header", "required": false, "content": { "application/json": { "schema": { "default": "desktop", "enum": [ "desktop", "mobile", "mobileVC" ] } } } }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод первой страницы)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "callNumber", "in": "query", "description": "Фильтр по номеру обращения", "required": false }, { "name": "callId", "in": "query", "description": "Фильтр по calls.id", "required": false }, { "name": "firmId", "in": "query", "description": "Фильтр по ID фирмы УК/РСО", "required": false }, { "name": "contractorFirmId", "in": "query", "description": "Фильтр по ID подрядчика", "required": false }, { "name": "contractorDivisionId", "in": "query", "description": "Фильтр по ID подразделению подрядчика", "required": false }, { "name": "fio", "in": "query", "description": "Фильтр по ФИО обратившегося", "required": false }, { "name": "callerPhone", "in": "query", "description": "Фильтр по номеру телефона", "required": false }, { "name": "controlUserId", "in": "query", "description": "Фильтр по ответственному за контроль", "required": false }, { "name": "controlState", "in": "query", "description": "Дополнительный фильтр по контролируемым обращениям. 1 - стоят на контроле, 0 - сняты с контроля, null - все", "required": false }, { "name": "workPlaceId", "in": "query", "description": "Фильтр по рабочему месту (где принято обращение)", "required": false }, { "name": "folderId", "in": "query", "description": "Фильтр по ID папки", "required": false }, { "name": "isActive", "in": "query", "description": "Фильтр по незакрытым состояниям обращения (true, false). true - выводим только те обращения, у которых date_out = null(в состоянии у папки)", "required": false }, { "name": "finished", "in": "query", "description": "Фильтр по закрытым/открытым обращениям (call_date_out is null or is not null). true -полностью завершенные/закрытые, у которых call_date_out != null", "required": false }, { "name": "underControl", "in": "query", "description": "Используется вместе с controlUserId. true - находящиеся на контроле у этого пользователя в данный момент; false - сняты с контроля и в данный момент не находящиеся на контроле у этого пользователя; null - все", "required": false }, { "name": "folderSetId", "in": "query", "description": "Фильтр по коду набора папок", "required": false }, { "name": "cityId", "in": "query", "description": "Фильтр по коду населенного пункта", "required": false }, { "name": "streetId", "in": "query", "description": "Фильтр по коду улицы", "required": false }, { "name": "addressId", "in": "query", "description": "Фильтр по коду адреса", "required": false }, { "name": "flatId", "in": "query", "description": "Фильтр по коду лицевого счета", "required": false }, { "name": "topicId", "in": "query", "description": "Фильтр по коду темы обращения", "required": false }, { "name": "subtopicId", "in": "query", "description": "Фильтр по коду под темы обращения", "required": false }, { "name": "emergency", "in": "query", "description": "Фильтр по аварийным обращениям (true, false)", "required": false }, { "name": "dateStart", "in": "query", "description": "Интервальный фильтр - дата начала поиска ", "required": false }, { "name": "dateEnd", "in": "query", "description": "Интервальный фильтр - дата окончания поиска ", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Calls" ], "summary": "Создание обращения", "description": "Calls/CallController (privileges: Call => C1 для переданной home_street_id)", "operationId": "calls.store", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICreatedCall" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICreatedCall" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}": { "get": { "tags": [ "Calls" ], "summary": "Подробный просмотр обращения", "description": "CallController (privileges: Call => R1 )", "operationId": "calls.show", "parameters": [ { "name": "call", "in": "path", "description": "Идентификатор обращения", "required": true }, { "name": "currentUserFirmUserId", "in": "query", "description": "Код firm_users для пользователя", "required": true }, { "name": "Application-Type", "in": "header", "description": "desktop-для вэб приложения; mobile-для мобильного приложения исполнителя; mobileVC-для мобильного приложения жителя.", "required": false, "content": { "application/json": { "schema": { "default": "desktop", "enum": [ "desktop", "mobile", "mobileVC" ] } } } } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallView" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Calls" ], "summary": "Изменения предельной даты отработки обращения", "description": "Calls/CallController (уровень доступа Call => U1)", "operationId": "call.update", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "deadline": { "title": "предельная дата отработки обращения", "type": "string", "example": "2025-11-01" }, "subTopicId": { "title": "Другая подтема, меняется только если старая тема была виртуального оператора, а новая реальная. В остальных случаях молча не меняет", "type": "integer", "example": 5 }, "emergency": { "title": "изменения признака аварийности для обращения принятого виртуальным оператором", "type": "boolean", "example": false }, "consult": { "title": "Обращение является консультационным", "type": "boolean", "example": false }, "phoneNumber": { "title": "Номер телефона", "type": "string", "example": "+79123456789" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallView" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_docs/{call_doc}/unload": { "get": { "tags": [ "Calls" ], "summary": "Получение загруженного документа ", "description": "Calls/CallDocUnloadController (privileges: Call => R1 )", "operationId": "call_docs.show", "parameters": [ { "name": "call_doc", "in": "path", "description": "Идентификатор загруженного документа", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "file": { "type": "file" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_messages": { "get": { "tags": [ "Calls" ], "summary": "Список сообщений, отправленных жителю, по поданному обращению", "description": "Calls/CallMessageController ( privileges: Calls - R2 )", "operationId": "call_message.index", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод первой страницы)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод без пагинации)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallerMessageCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Calls" ], "summary": "Создание сообщения под обращению жителя", "description": "Calls/CallMessageController (privileges: Call => U2 для адреса обращения )", "operationId": "call_message.store", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallerMessage" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallerMessage" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_messages/{call_message}": { "delete": { "tags": [ "Calls" ], "summary": "Удаление задания на обратный обзвон по обращению жителя", "description": "Calls/CallMessageController (privileges: Call => U2 для адреса обращения )", "operationId": "call_message.destroy", "parameters": [ { "name": "call", "in": "path", "description": "номер ресурса обращения", "required": true }, { "name": "call_message", "in": "path", "description": "номер ресурса сообщения жителю", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call-lists": { "post": { "tags": [ "Calls" ], "summary": "Получение списка обращений по переданному массиву ID обращений", "description": "Calls/CallMobileVCViewController (privileges: Call => C1)", "operationId": "callsMobile.view", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "description": "ID обращения", "type": "integer", "example": 5 } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_protocol_messages": { "get": { "tags": [ "Calls" ], "summary": "Список сообщений", "description": "Calls/CallProtocolMessageController@index", "operationId": "call_protocol_messages.index", "parameters": [ { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "firmId", "in": "query", "description": "Фильтр по ID фирмы у которой надо показать обращения", "required": false }, { "name": "divisionId", "in": "query", "description": "Фильтр по ID подразделения фирмы надо показать обращения", "required": false }, { "name": "isRead", "in": "query", "description": "Фильтр только для прочитанных(true)/не прочитанных(false)/всех(null) сообщений", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallProtocolMessageCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_protocol_messages/{call_protocol_message}": { "post": { "tags": [ "Calls" ], "summary": "Получаем пользователя, у которого отобразилось сообщение", "description": "Calls/CallProtocolMessageController@store ", "operationId": "call_protocol_message.store", "parameters": [ { "name": "call_protocol_message", "in": "path", "description": "Идентификатор сообщения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Calls" ], "summary": "Получаем пользователя, который первым прочитает сообщение", "description": "Calls/CallProtocolMessageController@update ", "operationId": "call_protocol_message.update", "parameters": [ { "name": "call_protocol_message", "in": "path", "description": "Идентификатор сообщения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/queue_calls": { "get": { "tags": [ "Calls" ], "summary": "Поиск нового звонка оператору", "description": "Calls/CallQueueController ( privileges: Request - R1 )", "operationId": "queue_calls.index", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IRequestState" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Calls" ], "summary": "Создание буферной записи с данными о записи телефонного разговора", "description": "Calls/CallQueueController (privileges: Request => C1 )", "operationId": "queue_calls.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IRequestState" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IRequestState" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/queue_calls/{voice_id}": { "delete": { "tags": [ "Calls" ], "summary": "Закрытие звонка в очереди без привязывания к обращения", "description": "CallQueueController->destroy (privileges: System", "operationId": "requestDelete", "parameters": [ { "name": "voice_id", "in": "path", "description": "код ссылки на телефонный разговор в формате GUID", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/call_states/{call_state}": { "patch": { "tags": [ "Calls" ], "summary": "Двигаем обращение по папкам", "description": "Calls/CallStateMoveController -> U2", "operationId": "callState.move", "parameters": [ { "name": "call_state", "in": "path", "description": "ID состояния, с которого мы двигаем обращение", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "Application-Type", "in": "header", "required": false, "content": { "application/json": { "schema": { "default": "desktop", "enum": [ "desktop", "mobile", "mobileVC" ] } } } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IExtendedCallState" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IExtendedCallState" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_docs": { "post": { "tags": [ "Calls" ], "summary": "Прикрепление документа к обращению", "description": "Calls/CreateCallDocController (privileges: Call => U1 для переданной calls)", "operationId": "call_docs.store", "parameters": [ { "name": "call", "in": "path", "description": "Идентификатор обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "schema": "FileSchema", "properties": { "file": { "title": "Файл к загрузке", "type": "string", "format": "binary" }, "description": { "description": "описание документа", "type": "string", "example": "Фото аварии" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallDoc" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/calls/{call}/call_notes": { "post": { "tags": [ "Calls" ], "summary": "Создание сообщения для обращения", "description": "Calls/CreateCallNoteController (privileges: Call => U1 для переданной calls)", "operationId": "call_notes.store", "parameters": [ { "name": "call", "in": "path", "description": "Идентификатор обращения", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "note": { "description": "Текст сообщения", "type": "string", "example": "Авария в доме" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallNote" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/current_states": { "get": { "tags": [ "Login" ], "summary": "Список доступных папок пользователя с признаками состояния у каждой", "description": "CurrentStateController ( privileges: Current Users )", "operationId": "currentStateIndex", "parameters": [ { "name": "firmUserId", "in": "query", "description": "ID firm_users, для определения организации по которой будут выбраны данные по обращениям (если null, то организация по умолчанию)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICurrentSetState" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_docs/{call_doc}": { "delete": { "tags": [ "Calls" ], "summary": "Удаление документа из базы данных", "description": "Calls/DeleteCallDocController (privileges: Call => R0 или Call => U1 & auth->id === call_doc->user_id )", "operationId": "callDoc.delete", "parameters": [ { "name": "call_doc", "in": "path", "description": "номер ресурса докунта", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/folders/{folder}/call_states": { "get": { "tags": [ "Calls" ], "summary": "Обращений по указанной папке", "description": "Calls/FolderCallStateIndexController ( privileges: Calls - R1 )", "operationId": "callStateIndex", "parameters": [ { "name": "folder", "in": "path", "description": "ID папки" }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод первой страницы)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "callNumber", "in": "query", "description": "Фильтр по номеру обращения", "required": false }, { "name": "dateIn", "in": "query", "description": "Фильтр по дате создания обращения", "required": false }, { "name": "stateDateIn", "in": "query", "description": "Фильтр по дате перевода в текущую папку", "required": false }, { "name": "cityId", "in": "query", "description": "Фильтр по коду населенного пункта", "required": false }, { "name": "streetId", "in": "query", "description": "Фильтр по коду улицы", "required": false }, { "name": "addressId", "in": "query", "description": "Фильтр по коду адреса", "required": false }, { "name": "flatId", "in": "query", "description": "Фильтр по коду лицевого счета", "required": false }, { "name": "topicId", "in": "query", "description": "Фильтр по коду темы обращения", "required": false }, { "name": "subtopicId", "in": "query", "description": "Фильтр по коду под темы обращения", "required": false }, { "name": "emergency", "in": "query", "description": "Фильтр по аварийным обращениям (true, false)", "required": false }, { "name": "isActive", "in": "query", "description": "Фильтр по незакрытым обращениям (true, false). true - выводим только те обращения, у которых date_out = null", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderCallCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/requests": { "get": { "tags": [ "Calls" ], "summary": "Список зарегистрированных звонков", "description": "Calls/RequestController ( privileges: Request - R1 )", "operationId": "request.index", "parameters": [ { "name": "page", "in": "query", "description": "номер страницы. по умолчанию 1", "required": false }, { "name": "per_page", "in": "query", "description": "количество записей на странице. по умолчанию - 15", "required": false }, { "name": "startDate", "in": "query", "description": "дата начала периода выборки звонков", "required": false }, { "name": "endDate", "in": "query", "description": "дата окончания периода выборки звонков", "required": false }, { "name": "userFio", "in": "query", "description": "фильтр поиска звонков по ФИО пользователя, зарегистрировавшего звонок", "required": false }, { "name": "phoneNumber", "in": "query", "description": "фильтр по номеру телефона", "required": false }, { "name": "ateId", "in": "query", "description": "фильтр по Id очереди АТС", "required": false }, { "name": "state", "in": "query", "description": "фильтр по статусу звонка", "required": false, "content": { "application/json": { "schema": { "default": null, "enum": [ "NEW", "REGISTERED", "REJECTED" ] } } } } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IRequestCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/callers": { "get": { "tags": [ "Calls" ], "summary": "Получение списка обращений по указанным параметрам", "description": "Calls/SearchCallersController.get (privilege: Calls -> R2)", "operationId": "searchCallers", "parameters": [ { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - выводим без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "addressId", "in": "query", "description": "Фильтр по ID записи адреса (home_street). Если flatId заполнено, то этот фильтр игнорируется", "required": false }, { "name": "phone", "in": "query", "description": "Фильтр по номеру телефона звонящего", "required": false }, { "name": "fio", "in": "query", "description": "фильтр по ФИО", "required": false }, { "name": "withFlats", "in": "query", "description": "true - признак необходимости выводить только звонящих с квартирами (callers.flat_id is NOT null). false - IS NULL. null - вообще весь список", "required": false }, { "name": "flatId", "in": "query", "description": "Фильтр по ID темы обращения", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICaller" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/virtual_calls": { "post": { "tags": [ "Calls" ], "summary": "Создание обращения", "description": "Calls/VirtualCallController ( privileges: Call => C0 )", "operationId": "virtual_calls", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "flatId": { "description": "ID квартиры", "type": "integer", "example": 5432 }, "homeStreetId": { "description": "ID адреса", "type": "integer", "example": 5432 }, "callTopicId": { "description": "ID темы. необязательное поле", "type": "integer", "example": 5432 }, "notes": { "description": "Текст обращения", "type": "string", "example": "Караул. Все плохо. Помогите." }, "callerPhone": { "description": "телефон для обратной связи", "type": "string|null", "example": "89148889990" }, "callType": { "description": "Тип обращения (UK|TKO)", "type": "string", "example": "UK" }, "requestId": { "description": "ID записи разговора", "type": "string", "example": "71b91579-c811-4209-bd7d-2b4534d93cd1" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICreatedCall" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/queue_calls/{request_id}/voice": { "get": { "tags": [ "Calls" ], "summary": "Получение записи звонка", "description": "Calls/VoiceController ( privileges: Request - R1 )", "operationId": "queue_calls.voice", "parameters": [ { "name": "request_id", "in": "path", "description": "идентификатор файла - записи разговора (requests.voice_id)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Oк", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } }, "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/city_deletes": { "get": { "tags": [ "Address" ], "summary": "вывод данных об удалённых экземплярах населённых пунктов", "description": "данные об удалённых населённых пунктах, данные при выводе сортируются по убыванию даты удаления", "operationId": "cityAllDelShow", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutsideHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities": { "get": { "tags": [ "Address" ], "summary": "Список всех населенных пунктов", "description": "пока сделан общий список нас.пунктов, но они же могут принадлежать, как субъекту РФ, так и району", "operationId": "cityIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "name", "in": "query", "description": "поле для фильтра по наименованию", "required": false }, { "name": "region", "in": "query", "description": "поле для фильтра по наименованию субъекта федерации", "required": false }, { "name": "outside", "in": "query", "description": "поле для фильтра по наименованию района субъекта", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание нас.пункта", "description": "ограничение этой операции. могут только админы базы данных.", "operationId": "cityStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "typeId", "regionId" ], "properties": { "name": { "description": "наименование населенного пункта", "type": "string", "example": "Биробиджан" }, "okato": { "description": "код ОКАТО", "type": "string", "example": "99" }, "oktmo": { "description": "код ОКТМО", "type": "string", "example": "99" }, "fias": { "description": "код ФИАС", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "typeId": { "description": "код типа населенного пункта", "type": "integer", "example": 2 }, "regionId": { "description": "код субъекта РФ", "type": "integer", "example": 1 }, "outsideId": { "description": "код района субъекта РФ", "type": "integer", "example": 12 } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities/{city}": { "get": { "tags": [ "Address" ], "summary": "вывод данных о населенном пункте", "description": "выдаем данные о выбранном населенном пункте", "operationId": "cityShow", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление населенного пункта из базы данных", "description": "ограничение этой операции. могут только админы базы данных. Производится \"Мягкое\" удаление населенного пункта", "operationId": "cityDelete", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение населенного пункта", "description": "ограничение этой операции. могут только админы базы данных.", "operationId": "cityUpdate", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "typeId" ], "properties": { "name": { "description": "наименование населенного пункта", "type": "string", "example": "Биробиджан" }, "okato": { "description": "код ОКАТО", "type": "string", "example": "99" }, "oktmo": { "description": "код ОКТМО", "type": "string", "example": "99" }, "fias": { "description": "код ФИАС", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "typeId": { "description": "код типа населенного пункта", "type": "integer", "example": 2 }, "regionId": { "description": "код субъекта РФ", "type": "integer", "example": 1 }, "outsideId": { "description": "код района субъекта РФ", "type": "integer", "example": 12 } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities/{id}/hists": { "get": { "tags": [ "Address" ], "summary": "вывод данных об изменении экземпляра населённого пункта", "description": "CityHistController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "cityHistShow", "parameters": [ { "name": "id", "in": "path", "description": "идентификатор ресурса", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutsideHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/city_types": { "get": { "tags": [ "Address" ], "summary": "Список типов населенных пунктов.", "description": "CityTypeController ( privileges: Global: SYSTEM, ADMIN, ADDRESS)", "operationId": "cityTypeIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание элемента тип населенного пункта", "description": "CityTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "cityTypeStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "shortName", "name" ], "properties": { "name": { "description": "Наименование типа населенного пункта", "type": "string", "example": "село" }, "shortName": { "description": "краткое наименование типа нас.пункта, согласно КЛАДР", "type": "string", "example": "с." } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/city_types/{city_type}": { "get": { "tags": [ "Address" ], "summary": "просмотр выбранного типа населенного пункта", "description": "CityTypeController ( privileges: Global: SYSTEM, ADMIN, ADDRESS )", "operationId": "cityTypeShow", "parameters": [ { "name": "city_type", "in": "path", "description": "номер ресурса типа нас.пункта", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление типа населенного пункта. Не должно быть подчиненных населенных пунктов", "description": "CityTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "cityTypeDelete", "parameters": [ { "name": "city_type", "in": "path", "description": "номер ресурса типа населенного пункта", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение элемента тип населенного пункта", "description": "CityTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "cityTypeUpdate", "parameters": [ { "name": "city_type", "in": "path", "description": "номер ресурса типа населенного пункта", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "shortName", "name" ], "properties": { "name": { "description": "Наименование типа населенного пункта", "type": "string", "example": "село" }, "shortName": { "description": "краткое наименование типа нас.пункта, согласно КЛАДР", "type": "string", "example": "с." } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities/{city}/districts": { "get": { "tags": [ "Address" ], "summary": "Административный район города", "description": "DistrictController (privileges: )", "operationId": "districtIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "city", "in": "path", "description": "номер ресурса населённого пункта", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/District" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создания записи района города", "description": "DistrictController (privileges: )", "operationId": "districtStore", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населённого пункта", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "districtName" ], "properties": { "districtName": { "title": "Наименование адм.района города", "type": "string", "example": "Индустриальный район" }, "districtCode": { "title": "буквенный код, идентифицирующий район", "type": "string", "example": "ИН" }, "districtOkato": { "title": "код ОКАТО", "type": "string", "example": "99008" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/District" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/cities/{city}/districts/{district}": { "get": { "tags": [ "Address" ], "summary": "Просмотр записи района города", "description": "DistrictController (privileges: )", "operationId": "districtShow", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "district", "in": "path", "description": "номер просматриваемого ресурса", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/District" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "404": { "description": "Выбранного ресурса не существует" }, "406": { "description": "Несогласованность входных параметров" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "удаление пункта меню рабочего места", "description": "DistrictController (privileges: )", "operationId": "districtDelete", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "district", "in": "path", "description": "номер просматриваемого ресурса", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "404": { "description": "Выбранного ресурса не существует" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование района города", "description": "DistrictController (privileges: )", "operationId": "districtUpdate", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "district", "in": "path", "description": "номер просматриваемого ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "districtName" ], "properties": { "districtName": { "title": "Наименование адм.района города", "type": "string", "example": "Индустриальный район" }, "districtCode": { "title": "буквенный код, идентифицирующий район", "type": "string", "example": "ИН" }, "districtOkato": { "title": "код ОКАТО", "type": "string", "example": "99008" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/District" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "404": { "description": "Выбранного ресурса не существует" }, "406": { "description": "Несогласованность входных параметров" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/divisions": { "get": { "tags": [ "Firm" ], "summary": "Список подразделений у фирмы", "description": "DivisionController (privileges: SYSTEM...). Сортировка по наименованию", "operationId": "divisionIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firm", "in": "path", "description": "номер ресурса для нужной организации", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDivision" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Создание нового подразделения у организации.", "description": "DivisionController (privileges: System)", "operationId": "divisionStore", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование подразделения", "type": "string", "example": "ПТО" }, "emrg": { "description": "признак аварийной службы. true - аварийная (еще варианты 1|0, \"0\"|\"1\")", "type": "boolean", "example": "false" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDivision" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/divisions/{division}": { "get": { "tags": [ "Firm" ], "summary": "вывод данных о выбранном подразделении организации", "description": "DivisionController (privileges: )", "operationId": "divisionShow", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "division", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDivision" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Firm" ], "summary": "Удаление подразделения из базы данных", "description": "DivisionController->destroy (privileges: System", "operationId": "divisionDelete", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "division", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Редактирование подразделения", "description": "DivisionController (privileges: System)", "operationId": "divisionUpdate", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "division", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование подразделения", "type": "string", "example": "ПТО" }, "emrg": { "description": "признак аварийной службы. true - аварийная", "type": "boolean", "example": "false" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDivision" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/divisions/{division}/hists": { "get": { "tags": [ "Firm" ], "summary": "архив изменений подразделения", "description": "DivisionHistController (privileges: System)", "operationId": "divisionHistIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firm", "in": "path", "description": "номер ресурса для нужной организации", "required": true }, { "name": "division", "in": "path", "description": "номер ресурса для подразделения", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DivisionHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/entrances": { "get": { "tags": [ "Address" ], "summary": "Список подъездов по дому", "description": "EntranceController (privileges: allUsers)", "operationId": "home.entrances", "parameters": [ { "name": "home", "in": "path", "description": "идентификатор дома (Home)", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = all)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15 при условии, что page isnot null) иначе выводи всё", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entrancesCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Заведения нового подъезда в доме", "description": "EntrancesController (privileges: SYSTEM, ADMIN. Для модели Home)", "operationId": "home.entrances.store", "parameters": [ { "name": "home", "in": "path", "description": "идентификатор дома (Home)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "data.name", "data.password" ], "properties": { "data": { "$ref": "#/components/schemas/Entrance" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Entrance" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/entrances/{entrance}": { "get": { "tags": [ "Address" ], "summary": "просмотр подъезда по дому", "description": "EntranceController (privileges: allUsers)", "operationId": "home.entrances.show", "parameters": [ { "name": "home", "in": "path", "description": "идентификатор дома (Home)", "required": true }, { "name": "entrance", "in": "path", "description": "идентификатор подъезда (Entrance)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Entrance" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "entrance_home_id не соответствует home_id" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление подъезда на доме", "description": "EntrancesController (privileges: SYSTEM, ADMIN. Для модели Home)", "operationId": "home.entrances.destroy", "parameters": [ { "name": "home", "in": "path", "description": "идентификатор дома (Home)", "required": true }, { "name": "entrance", "in": "path", "description": "идентификатор подъезда (Entrance)", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование подъезда на доме", "description": "EntrancesController (privileges: SYSTEM, ADMIN. Для модели Home)", "operationId": "home.entrances.update", "parameters": [ { "name": "home", "in": "path", "description": "идентификатор дома (Home)", "required": true }, { "name": "entrance", "in": "path", "description": "идентификатор подъезда (Entrance)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Entrance" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Entrance" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Неверная пара дом-подъезд" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firm_phones": { "get": { "tags": [ "Catalog" ], "summary": "Список телефонов организации", "description": "FirmPhones/FirmPhoneController ( privileges: FirmPhone - R2 )", "operationId": "firm_phone.index", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "from", "in": "query", "description": "источник, с которого мы делаем заход на список. Возможные варианты: (firm - заход с УК, division - заход с подразделения УК)", "required": true, "content": { "application/json": { "schema": { "enum": [ "firm", "division" ] } } } }, { "name": "objectId", "in": "query", "description": "id записи-источника (владельца)", "required": true, "example": 5 }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод всего списка без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Catalog" ], "summary": "Создание нового телефона у организации.", "description": "Создание нового телефона организации", "operationId": "firm_phone.store", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFirmPhone" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmPhone" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/firm_phones/{firm_phone}": { "get": { "tags": [ "Catalog" ], "summary": "вывод данных о выбранном телефоне организации", "description": "просмотр данных о телефоне организации", "operationId": "firm_phone.show", "parameters": [ { "name": "firm_phone", "in": "path", "description": "номер ресурса телефона организации", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFirmPhone" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Catalog" ], "summary": "Удаление телефона организации из базы данных", "description": "Удаление телефона организации", "operationId": "firm_phone.delete", "parameters": [ { "name": "firm_phone", "in": "path", "description": "ID телефона организации", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Catalog" ], "summary": "Редактирование телефона организации", "description": "Update the specified resource in storage.", "operationId": "firm_phone.update", "parameters": [ { "name": "firm_phone", "in": "path", "description": "ID телефона организации", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFirmPhone" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmPhone" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/contractor_homes": { "get": { "tags": [ "Firm" ], "summary": "Список домов по подрядчику", "description": "FirmContractorHomesController (privileges: SYSTEM, ADMIN, для модели ContractorHome)", "operationId": "firms.firm_contracts_homes.index", "parameters": [ { "name": "firm", "in": "path", "description": "идентификатор подрядчика", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = all)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15 при условии, что page is not null) иначе выводи всё", "required": false }, { "name": "ffContractId", "in": "query", "description": "идентификатор договора подряда", "required": false }, { "name": "customerFirmName", "in": "query", "description": "строка для фильтрации по имени заказчика", "required": false }, { "name": "streetName", "in": "query", "description": "фильтр по наименованию улицы", "required": false }, { "name": "homeNumber", "in": "query", "description": "фильтр по номеру дома", "required": false }, { "name": "onDate", "in": "query", "description": "фильтр по дате договора подряда", "required": false }, { "name": "cityId", "in": "query", "description": "фильтр по идентификатору населённого пункта", "required": false }, { "name": "divisionId", "in": "query", "description": "фильтр по идентификатору подразделения", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractorHomesCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Создание связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями", "description": "FirmContractorHomesController (privileges: SYSTEM, ADMIN, для модели ContractorHome)", "operationId": "firms.firm_contracts_homes.store", "parameters": [ { "name": "firm", "in": "path", "description": "идентификатор подрядчика", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractorHomesCollection" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/contractor_homes/{contractor_home}": { "get": { "tags": [ "Firm" ], "summary": "просмотр связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями", "description": "FirmContractorHomesController (privileges: SYSTEM, ADMIN, для модели ContractorHome)", "operationId": "firms.firm_contracts_homes.show", "parameters": [ { "name": "firm", "in": "path", "description": "идентификатор подрядчика", "required": true }, { "name": "contractor_home", "in": "path", "description": "идентификатор связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractorHomesResource" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "У подрядчика нет указанного договора подряда" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Firm" ], "summary": "Удаление связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями", "description": "FirmContractorHomesController (privileges: SYSTEM, ADMIN. Для модели ContractorHome)", "operationId": "firms.firm_contracts_homes.destroy", "parameters": [ { "name": "firm", "in": "path", "description": "идентификатор подрядчика", "required": true }, { "name": "contractor_home", "in": "path", "description": "идентификатор связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Исправление связи договора управления и подрядчиков УК. Дата закрытия производится днем ранее.", "description": "FirmContractorHomesController (privileges: SYSTEM, ADMIN, Расчетный отдел)", "operationId": "firms.firm_contracts_homes.update", "parameters": [ { "name": "firm", "in": "path", "description": "id ресурса организации", "required": true }, { "name": "contractor_home", "in": "path", "description": "id ресурса связи договора управления дома с подрядчиком", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractorHomesResource" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ContractorHomesResource" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms": { "get": { "tags": [ "Firm" ], "summary": "Список организаций", "description": "Список обслуживающих жилищный фонд организации.", "operationId": "firmIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "id", "in": "query", "description": "фильтр по коду организации", "required": false }, { "name": "name", "in": "query", "description": "фильтр по наименовании организации (регистронезависимый поиск по части имени)", "required": false }, { "name": "rank", "in": "query", "description": "фильтр по типу организации (если несколько типов, то через запятую)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmEdit" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Создание новой организации.", "description": "Создание новой организации", "operationId": "firmStore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "rank", "public_email", "use_call_service" ], "properties": { "data": { "$ref": "#/components/schemas/IFirmEdit" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmEdit" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}": { "get": { "tags": [ "Firm" ], "summary": "вывод данных о выбранной организации", "description": "вывод данных о выбранной организации", "operationId": "firmShow", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmEdit" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Firm" ], "summary": "Удаление организации из базы данных", "description": "Эта операция очень редкая. в основе своей, мы будет закрывать организацию, а не удалять", "operationId": "firmDelete", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Редактирование организации", "description": "Update the specified resource in storage.", "operationId": "firmUpdate", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "rank", "public_email", "use_call_service" ], "properties": { "data": { "$ref": "#/components/schemas/IFirmEdit" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmEdit" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/hists": { "get": { "tags": [ "Firm" ], "summary": "Список изменений записи firms", "description": "Архив изменений записи firms.", "operationId": "firmHistIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firm", "in": "path", "description": "ресурс фирмы, у которой смотрим архив", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/firm_homes": { "get": { "tags": [ "Firm" ], "summary": "Список договоров управления/ресурсоснабжения по организации", "description": "FirmHomeController (privileges: Global: SYSTEM, ADMIN, FIRM)", "operationId": "firm_homes_index", "parameters": [ { "name": "firm", "in": "path", "description": "id ресурса организации", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "contractor_firm_id", "in": "query", "description": "фильтр по коду подрядчика", "required": false }, { "name": "without_contractor_firm_id", "in": "query", "description": "фильтр, исключающий подрядчика", "required": false }, { "name": "division_id", "in": "query", "description": "фильтр по коду подразделения подрядчика", "required": false }, { "name": "city_id", "in": "query", "description": "фильтр по коду населенного пункта", "required": false }, { "name": "street_id", "in": "query", "description": "фильтр по коду улицы", "required": false }, { "name": "street_name", "in": "query", "description": "фильтр по наименованию улицы", "required": false }, { "name": "groupReceiverId", "in": "query", "description": "код группы правил, к которой мы планируем прикрепить дома. Уберу дома, которые уже присоединены к группам с такими же темами", "required": false }, { "name": "home_number", "in": "query", "description": "фильтр по номеру дома", "required": false }, { "name": "param_date", "in": "query", "description": "фильтр по дате. Выбираем записи, которые действовали на данную дату. null - на текущую дату", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmHomeCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Присоединение/отсоединение домов к организации и его подрядчикам. Отсоединение производится днем ранее.", "description": "FirmHomeController (privileges: SYSTEM, ADMIN, Расчетный отдел)", "operationId": "firm_homes_create", "parameters": [ { "name": "firm", "in": "path", "description": "id ресурса организации", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmHomeCollection" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/firm_homes/{firm_home}": { "get": { "tags": [ "Firm" ], "summary": "Просмотр договора управления дома с УК и ее подрядчиков. Дата закрытия производится днем ранее.", "description": "FirmHomeController (privileges: SYSTEM, ADMIN, Расчетный отдел)", "operationId": "firm_homes_show", "parameters": [ { "name": "firm", "in": "path", "description": "id ресурса организации", "required": true }, { "name": "firm_home", "in": "path", "description": "id ресурса связи дома с УК", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FirmHome" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Firm" ], "summary": "Удаление договора управления у УК", "description": "FirmHomeController (privileges: SYSTEM, ADMIN.)", "operationId": "firm_homes_delete", "parameters": [ { "name": "firm", "in": "path", "description": "идентификатор подрядчика", "required": true }, { "name": "firm_home", "in": "path", "description": "идентификатор договора управления", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Исправление связи дома и УК и его подрядчиков. Дата закрытия производится днем ранее.", "description": "FirmHomeController (privileges: SYSTEM, ADMIN, Расчетный отдел)", "operationId": "firm_homes_update", "parameters": [ { "name": "firm", "in": "path", "description": "id ресурса организации", "required": true }, { "name": "firm_home", "in": "path", "description": "id ресурса связи дома с УК", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FirmHome" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/FirmHome" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/firm_properties": { "get": { "tags": [ "Firm" ], "summary": "Список свойств фирмы", "description": "Список свойств организации (доступ к записям будет по разрешению модели Firm)", "operationId": "firmPropertyIndex", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmProperty" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Создание свойства организации.", "description": "Создание нового свойства организации", "operationId": "firmPropertyStore", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "main_property_id" ], "properties": { "main_property_id": { "description": "Код основного свойства", "type": "integer", "example": 3 }, "property_value": { "description": "Значение свойства", "type": "string|null", "example": "нет" }, "main_property_val_id": { "description": "код значения свойства (при его наличие)", "type": "integer|null", "example": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmProperty" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/firm_properties/{firm_property}": { "get": { "tags": [ "Firm" ], "summary": "вывод данных о выбранного свойства организации", "description": "вывод данных о свойстве организации", "operationId": "firmPropertyShow", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "firm_property", "in": "path", "description": "номер ресурса свойства организации", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmProperty" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Firm" ], "summary": "Удаление свойства организации из базы данных", "description": "Удаление свойства у фирмы", "operationId": "firmPropertyDelete", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "firm_property", "in": "path", "description": "номер ресурса свойства организации", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Редактирование свойства организации", "description": "Update the specified resource in storage.", "operationId": "firmPropertyUpdate", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "firm_property", "in": "path", "description": "номер ресурса свойства организации", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "rank", "public_email", "use_call_service" ], "properties": { "main_property_id": { "description": "Код основного свойства", "type": "integer", "example": 3 }, "property_value": { "description": "Значение свойства", "type": "string|null", "example": "нет" }, "main_property_val_id": { "description": "код значения свойства (при его наличие)", "type": "integer|null", "example": null } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmProperty" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm_id}/receivers": { "get": { "tags": [ "Firm" ], "summary": "Список подрядчиков с подразделениями, которые могут принимать обращения", "description": "FirmReceiversController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "getReceivers", "parameters": [ { "name": "firm_id", "in": "path", "description": "номер ресурса организации", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmReceiverCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firm-to-firm-contracts": { "get": { "tags": [ "Firm" ], "summary": "Список заказчиков/подрядчиков организации", "description": "FirmToFirmController (privileges: Global: SYSTEM, ADMIN, FIRM)", "operationId": "firmToFirmContractorIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "from", "in": "query", "description": "тип организаций, который нас интересует - подрядчики или заказчики (contractor || customer)", "required": true, "content": { "application/json": { "schema": { "enum": [ "contractor", "customer" ] } } } }, { "name": "objectId", "in": "query", "description": "Ресурс записи организации (firms.id).", "required": true }, { "name": "name", "in": "query", "description": "запрос на фильтрацию данных по наименованию", "required": false }, { "name": "start_date", "in": "query", "description": "фильтр по дате (начальная дата). Выбираем записи, у которых дата начала больше или равна введенной", "required": false }, { "name": "end_date", "in": "query", "description": "фильтр по дате (конечная дата). Выбираем записи, у которых дата окончания меньше или равна введенной", "required": false }, { "name": "sorted", "in": "query", "description": "запрос на сортировку по наименованию (name,des или name,asc)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmToFirmCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Firm" ], "summary": "Введение договора подряда", "description": "FirmToFirmController (privileges: Global: SYSTEM, ADMIN)", "operationId": "firmToFirmContractorStore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmToFirmContract" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmToFirmContract" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firm-to-firm-contracts/{firm-to-firm-contract}": { "delete": { "tags": [ "Firm" ], "summary": "Удаление договора подряда", "description": "FirmToFirmController (privileges: Global: SYSTEM, ADMIN)", "operationId": "firmToFirmContractorDelete", "parameters": [ { "name": "firm-to-firm-contract", "in": "path", "description": "номер удаляемого ресурса", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": { "default": "Ok" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Firm" ], "summary": "Изменение дат договора подряда", "description": "FirmToFirmController (privileges: Global: SYSTEM, ADMIN)", "operationId": "firmToFirmContractorUpdate", "parameters": [ { "name": "firm-to-firm-contract", "in": "path", "description": "номер ресурса редактируемой связи", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmToFirmContract" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmToFirmContract" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firm_types": { "get": { "tags": [ "Firm" ], "summary": "Список типов организаций", "description": "FirmTypeIndexController ( privileges: all. only view)", "operationId": "firmTypeIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/accounts": { "get": { "tags": [ "Address" ], "summary": "Список лицевых счетов с квартиры или дома", "description": "AccountController (privileges: SYSTEM, ADMIN, AllUsers )", "operationId": "accounts.index", "parameters": [ { "name": "from", "in": "query", "description": "источник, с которого мы делаем заход на список. Возможные варианты: (Address - заход с адреса для админов, Flat - заход с квартиры)", "required": true, "content": { "application/json": { "schema": { "enum": [ "Address", "Flat" ] } } } }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "objectId", "in": "query", "description": "id записи-источника (владельца)", "required": true, "example": 5 }, { "name": "page", "in": "query", "description": "№ страницы (default = null вывод без пагинации)", "required": false, "example": 1 }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "Дата на которую делать выборку, если null, то выводим всех", "required": false }, { "name": "firmId", "in": "query", "description": "Фильтр по коду фирмы", "required": false }, { "name": "account", "in": "query", "description": "Фильтр по номеру лицевого счета (начинается с...)", "required": false }, { "name": "firstName", "in": "query", "description": "Фильтр Имени", "required": false }, { "name": "lastName", "in": "query", "description": "Фильтр Фамилии", "required": false }, { "name": "patronymicName", "in": "query", "description": "Фильтр Отчеству", "required": false }, { "name": "flatFloor", "in": "query", "description": "Фильтр по этажу", "required": false }, { "name": "flatNum", "in": "query", "description": "Фильтр по номеру квартиры", "required": false }, { "name": "entranceId", "in": "query", "description": "Фильтр по id подъезда", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание лицевого счёта", "description": "AccountController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "account.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAccount" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAccount" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/accounts/{account}": { "get": { "tags": [ "Address" ], "summary": "Лицевой счёт с квартиры или дома", "description": "AccountController (privileges: SYSTEM, ADMIN, AllUsers )", "operationId": "accounts.show", "parameters": [ { "name": "account", "in": "path", "description": "Идентификатор лицевого счёта", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAccount" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление лицевого счёта", "description": "AccountController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "account.destroy", "parameters": [ { "name": "account", "in": "path", "description": "идентификатор лицевого счёта", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение лицевого счёта", "description": "AccountController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "account.update", "parameters": [ { "name": "account", "in": "path", "description": "идентификатор лицевого счёта", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAccount" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAccount" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/debitors": { "get": { "tags": [ "Address" ], "summary": "Задолженность по лицевому счету", "description": "Flats/DebitorController ( privileges: Debitor => R1 )", "operationId": "debitorIndex", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = null вывод без пагинации)", "required": false, "example": 1 }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "addressId", "in": "query", "description": "Фильтр по id записи адреса (home_street.id)", "required": false }, { "name": "flatId", "in": "query", "description": "Фильтр по id квартиры (flats.id)", "required": false }, { "name": "firmId", "in": "query", "description": "Фильтр по id фирмы (firms.id)", "required": false }, { "name": "accountId", "in": "query", "description": "Фильтр по id лицевого счета (accounts.id)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/flats/{flat}/emails": { "get": { "tags": [ "Address" ], "summary": "Список электронных адресов по квартире", "description": "Flats/EmailController (privileges: flats - R1 )", "operationId": "email.index", "parameters": [ { "name": "flat", "in": "path", "description": "номер ресурса для нужной квартиры", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (null - без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание электронного адреса на квартире", "description": "Flats/EmailController ( privileges: flats - U1 )", "operationId": "email.store", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IEmail" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IEmail" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/flats/{flat}/emails/{email}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по адресу электронной почты", "description": "Flats/EmailController (privileges: flats - R1 )", "operationId": "email.show", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "email", "in": "path", "description": "идентификатор адреса эл.почты", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IEmail" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "удаление адреса эл.почты", "description": "Flats/EmailController (privileges: flats - U1 )", "operationId": "email.destroy", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "email", "in": "path", "description": "идентификатор адреса эл.почты", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": {}, "example": "Ok" } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение данных по электронной почте", "description": "Flats/EmailController ( privileges: flats - U1 )", "operationId": "email.update", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "email", "in": "path", "description": "идентификатор адреса эл.почты", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IEmail" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IEmail" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/home_streets/{home_street}/flats": { "get": { "tags": [ "Address" ], "summary": "Список квартир по запрошенному адресу", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flatIndex", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса номера дома(адрес)", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = null вывод без пагинации)", "required": false, "example": 1 }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "Дата на которую делать выборку, если null, то текущую дату", "required": false }, { "name": "entranceNumber", "in": "query", "description": "Фильтр по подъезду", "required": false }, { "name": "entranceId", "in": "query", "description": "Фильтр по id подъезда", "required": false }, { "name": "floor", "in": "query", "description": "Фильтр по этажу", "required": false }, { "name": "num", "in": "query", "description": "Фильтр по номеру квартиры", "required": false }, { "name": "residential", "in": "query", "description": "Фильтр по типу помещений. true - только жилые, false-нежилые, null-все", "required": false }, { "name": "first_name", "in": "query", "description": "Фильтр Имени", "required": false }, { "name": "last_name", "in": "query", "description": "Фильтр Фамилии", "required": false }, { "name": "patronymic_name", "in": "query", "description": "Фильтр Отчеству", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание квартиры", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flat.store", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса номера дома(адрес)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/home_streets/{home_street}/flats/{flat}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по выбранной квартире", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flat.show", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса номера дома(адрес)", "required": true }, { "name": "flat", "in": "path", "description": "номер ресурса квартиры", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление квартиры", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flat.destroy", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса номера дома(адрес)", "required": true }, { "name": "flat", "in": "path", "description": "номер ресурса квартиры", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение данных квартире", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flat.update", "parameters": [ { "name": "home_street", "in": "path", "description": "номер ресурса номера дома(адрес)", "required": true }, { "name": "flat", "in": "path", "description": "номер ресурса квартиры", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/flats/{flat}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по выбранной квартире", "description": "FlatController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "flat.showOnly", "parameters": [ { "name": "flat", "in": "path", "description": "номер ресурса квартиры", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFlat" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/folders": { "get": { "tags": [ "Folders" ], "summary": "Список папок организации (все папки организации и расширения папок)", "description": "FirmFoldersController (privileges firms-show and folder_sets-show)", "operationId": "folders", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCollections" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Заведения новой папки у фирмы ", "description": "FirmFoldersController (privileges: SYSTEM, ADMIN.)", "operationId": "firm_folder.store", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/folders/{folder}": { "get": { "tags": [ "Folders" ], "summary": "просмотр данных папки организации", "description": "FirmFoldersController (privileges: SYSTEM, ADMIN.)", "operationId": "firmFolder.show", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса firms", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Удаление ошибочно внесенной папки", "description": "FirmFoldersController (privileges: SYSTEM, ADMIN.)", "operationId": "firm_folder.delete", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса firms", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Изменение данных по папке. Неизменными будут код master_id и folder_set_id", "description": "FirmFoldersController (privileges: SYSTEM, ADMIN.)", "operationId": "firmFolder.update", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса firms", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folder_accesses": { "get": { "tags": [ "Folders" ], "summary": "просмотр разрешений на работу с наборами папок. Можно смотреть либо с пользователя, либо пользователей с набора папок", "description": "FolderAccessController ( privileges: Global: SYSTEM)", "operationId": "folderAccessIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "description": "наименование объекта (user, folder)", "required": true, "content": { "application/json": { "schema": { "enum": [ "folder", "user" ] } } } }, { "name": "objectId", "in": "query", "description": "номер ресурса", "required": true }, { "name": "fsEmployeeFio", "in": "query", "description": "поле для фильтра по ФИО пользователя", "required": false }, { "name": "fsEmployeeName", "in": "query", "description": "поле по логину пользователя", "required": false }, { "name": "fsFirmName", "in": "query", "description": "фильтр по наименовании организации", "required": false }, { "name": "fsDivisionName", "in": "query", "description": "фильтр по наименовании подразделения организации", "required": false }, { "name": "userFio", "in": "query", "description": "поле для фильтра по ФИО пользователя", "required": false }, { "name": "userName", "in": "query", "description": "поле по логину пользователя", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "title": "список с данными", "type": "array", "items": { "$ref": "#/components/schemas/IFolderSetUserAccess" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Создание разрешения для доступа пользователя к набору папок", "description": "FolderAccessController ( privileges: pattern - SYSTEM)", "operationId": "folderAccessStore", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSetUserConnection" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/folder_accesses/{folder_access}": { "get": { "tags": [ "Folders" ], "summary": "просмотр разрешений на работу с наборами папок. Смотрим одну запись", "description": "FolderAccessController ( privileges: Global: SYSTEM)", "operationId": "folderAccessShow", "parameters": [ { "name": "folder_access", "in": "path", "description": "номер ресурса записи доступа", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSetUserAccess" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Удаление ошибочно введенного разрешения для доступа к набору папок", "description": "FolderAccessController (privileges: Global(SYSTEM, ADMIN)", "operationId": "folderAccessDelete", "parameters": [ { "name": "folder_access", "in": "path", "description": "номер ресурса записи доступа", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Изменение доступа к набору папок (поля folderSetId и userId - не заполнять)", "description": "FolderAccessController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "folderAccessUpdate", "parameters": [ { "name": "folder_access", "in": "path", "description": "номер ресурса записи доступа", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSetUserConnection" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSetUserAccess" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/folder_accesses/{id}/histories": { "get": { "tags": [ "Folders" ], "summary": "просмотр истории изменений разрешений на работу с наборами папок.", "description": "FolderAccessController ( privileges: Global: SYSTEM)", "operationId": "folderAccessHistories", "parameters": [ { "name": "id", "in": "path", "description": "Код ресурса действующей записи", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSetUserAccess" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/folder_sets/{folder_set}/folders": { "get": { "tags": [ "Folders" ], "summary": "Список папок набора папок", "description": "FoldersController (privileges: folder_sets-show)", "operationId": "folders.index", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "folder_set", "in": "path", "description": "номер ресурса для набора папок", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCollections" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Заведения новой папки у набора папок ", "description": "FoldersController (privileges: folder_sets-create, folders-create)", "operationId": "folder.store", "parameters": [ { "name": "folder_set", "in": "path", "description": "номер ресурса набора папок", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folder_sets/{folder_set}/folders/{folder}": { "get": { "tags": [ "Folders" ], "summary": "просмотр данных папки организации", "description": "FoldersController (privileges: folder_sets-show, folders-show)", "operationId": "folder.show", "parameters": [ { "name": "folder_set", "in": "path", "description": "номер ресурса набора папок (folder_sets)", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Удаление папки. У этой папки не должно быть подчиненных записей.", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "folder.delete", "parameters": [ { "name": "folder_set", "in": "path", "description": "номер ресурса набора папок (folder_sets)", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Изменение данных по папке. Неизменными будут код master_id и folder_set_id", "description": "FoldersController (privileges: folder_sets-update, folders-update)", "operationId": "folder.update", "parameters": [ { "name": "folder_set", "in": "path", "description": "номер ресурса набора папок (folder_sets)", "required": true }, { "name": "folder", "in": "path", "description": "номер ресурса папки (folders)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolder" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folders/{folder}/folder_sections": { "post": { "tags": [ "Folders" ], "summary": "Создание локального расширения папки.", "description": "FolderSectionController ( privileges: Global: SYSTEM, ADMIN; Firm: LocalAdmin; Self: SelfFolders)", "operationId": "folderSectionStore", "parameters": [ { "name": "folder", "in": "path", "description": "номер ресурса папки", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSection" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folders/{folder}/folder_sections/{folder_section}": { "patch": { "tags": [ "Folders" ], "summary": "Изменения имени локального расширения папки.", "description": "FolderSectionController ( privileges: Global: SYSTEM, ADMIN; Firm: LocalAdmin; Self: SelfFolders)", "operationId": "folderSectionUpdate", "parameters": [ { "name": "folder", "in": "path", "description": "номер ресурса папки", "required": true }, { "name": "folder_section", "in": "path", "description": "ресурс папки-расширения", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSection" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folder_set/byOwner": { "get": { "tags": [ "Folders" ], "summary": "Список папок по заданному субъекту.", "description": "Folders/FolderSetByOwnerController (privileges: FolderSets)", "operationId": "folderSetsOwner.show", "parameters": [ { "name": "Application-Type", "in": "header", "required": false, "content": { "application/json": { "schema": { "default": "desktop", "enum": [ "desktop", "mobile" ] } } } }, { "name": "from", "in": "query", "description": "Тип субъекта (firm, division, firm_user)", "required": true, "content": { "application/json": { "schema": { "enum": [ "firm", "division", "firm_user", "user" ] } } } }, { "name": "objectId", "in": "query", "description": "ID субъекта (для значения user передавать нужно id соответствующей firm_users)", "required": true }, { "name": "previewCount", "in": "query", "description": "количество обращений в массиве previewRecentCalls. Для мобильного приложения. По умолчанию 3.", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFoldersByOwnerId" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folder_sets": { "get": { "tags": [ "Folders" ], "summary": "просмотр всех наборов папок. Либо всех папок организации", "description": "FolderSetController (privileges: Global(SYSTEM, SYSADMIN))", "operationId": "folderSetIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (null - вывод первой страницы)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firmId", "in": "query", "description": "выборка по конкретной фирме", "required": false }, { "name": "firmName", "in": "query", "description": "фильтр по наименовании организации", "required": false }, { "name": "divisionName", "in": "query", "description": "фильтр по наименовании подразделению организации", "required": false }, { "name": "employeeName", "in": "query", "description": "фильтр по логину пользователя", "required": false }, { "name": "employeeFio", "in": "query", "description": "фильтр по ФИО пользователя", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSetSelectionCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Создание набора папок у сущности", "description": "FolderSetController (privileges: Global - SYSTEM, ADMIN)", "operationId": "folderSetPost", "parameters": [ { "name": "from", "in": "query", "description": "Наименование объекта-владельца: firm,division,user", "required": true }, { "name": "objectId", "in": "query", "description": "Номер ресурса объекта-владельца. Для значения user, код ресурса-владельца должен быть id таблицы firm_users", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSet" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/folder_sets/{folder_set}": { "get": { "tags": [ "Folders" ], "summary": "просмотр всех наборов папок. Либо всех папок организации", "description": "FolderSetController (privileges: Global(SYSTEM, SYSADMIN))", "operationId": "folderSetShow", "parameters": [ { "name": "folder_set", "in": "path", "description": "номер ресурса folder_set", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IFolderSet" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Изменение состояния набора папок. Можем делать ее действующей (true) или не действующей (false)", "description": "FolderSetController (privileges: Global, SYSTEM )", "operationId": "folderSetValidUpdate", "parameters": [ { "name": "Accept", "in": "header", "content": { "application/json": { "schema": { "default": "application/json" } } } }, { "name": "folder_set", "in": "path", "description": "номер ресурса folder_set", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "fsValid" ], "properties": { "fsValid": { "description": "Признак действующего набора папок(true-действующая;false-удаленная)", "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSet" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/firms/{firm}/folder_sets_tree": { "get": { "tags": [ "Folders" ], "summary": "Список структуры папок организации (все наборы папок подчиненных структур)", "description": "FolderSetsTreeController (privileges firms-show)", "operationId": "folderSetsTree", "parameters": [ { "name": "firm", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFirmFoldersTree" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/master_folders": { "get": { "tags": [ "Folders" ], "summary": "Список мастер-папок. Глобальные папки.", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "masterFolderIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFolder" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Folders" ], "summary": "Создание элемента мастер-папок", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "masterFolderStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "type" ], "properties": { "name": { "description": "наименование папки", "type": "string", "example": "В работе" }, "type": { "description": "тип папки. Возможны варианты: START, WORK, FINAL, CHECK", "type": "string", "example": "WORK" }, "position": { "description": "ранжирование в отчете", "type": "integer", "example": 3 } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFolder" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/master_folders/{master_folder}": { "get": { "tags": [ "Folders" ], "summary": "просмотр выбранной мастер-папки", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN )", "operationId": "masterFolderShow", "parameters": [ { "name": "master_folder", "in": "path", "description": "номер ресурса мастер-папки", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFolder" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Folders" ], "summary": "Удаление мастер-папки. У этой папки не должно быть подчиненных папок. архив удаляется вместе с самой мастер-папкой", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "masterFolderDelete", "parameters": [ { "name": "master_folder", "in": "path", "description": "номер ресурса мастер-папки", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Folders" ], "summary": "Изменение Мастер-папки", "description": "MasterFolderController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "masterFolderUpdate", "parameters": [ { "name": "master_folder", "in": "path", "description": "номер ресурса мастер-папки", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "type" ], "properties": { "name": { "description": "наименование папки", "type": "string", "example": "В работе" }, "type": { "description": "тип папки. Возможны варианты: START, WORK, FINAL, CHECK", "type": "string", "example": "WORK" }, "position": { "description": "ранжирование в отчете", "type": "integer", "example": 3 } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFolder" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/master_folders/{master_folder}/hists": { "get": { "tags": [ "Folders" ], "summary": "Архив изменений данных в записи мастер-папки", "description": "MasterFolderHistController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "masterFolderHistIndex", "parameters": [ { "name": "master_folder", "in": "path", "description": "номер ресурса организации", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFolderHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/master_folder_rights": { "get": { "tags": [ "Folders" ], "summary": "запрос на получение для текущего пользователя разрешенных CRUD операция с таблицей master_folders", "description": "MasterFolderController ( privileges: пользователь должен быть аутентифицирован)", "operationId": "masterFolderRights", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "rights": { "description": "строка содержит разрешенные пользователю операции над таблицей master_folders", "type": "string", "example": "CRUD" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/users/{user}/folder_sets": { "get": { "tags": [ "Folders" ], "summary": "Список всех папок у организаций (с подчиненными структурами), к которым пользователь имеет отношение, с указанием прав доступа пользователя к этим папкам", "description": "UserFirmFolderAccessController (privileges firms-show and folder_sets-show)", "operationId": "userFolderAccesses.index", "parameters": [ { "name": "user", "in": "path", "description": "номер ресурса пользователя", "required": true }, { "name": "fsFirmId", "in": "query", "description": "выборка по id конкретной фирме", "required": false }, { "name": "fsDivisionId", "in": "query", "description": "фильтр по id подразделению организации", "required": false }, { "name": "fsEmployeeName", "in": "query", "description": "фильтр по логину пользователя", "required": false }, { "name": "fsEmployeeFio", "in": "query", "description": "фильтр по ФИО пользователя", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFolderSetUserAccessCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/address_receivers": { "get": { "tags": [ "Address" ], "summary": "Список правил регистрации обращений граждан по дому (все его адреса)", "description": "HomeAddressReceiversController (privileges: home -> SYSTEM -> read)", "operationId": "home_address_receivers_index", "parameters": [ { "name": "home", "in": "path", "description": "id ресурса дома", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = null)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "фильтр по дате. Выбираем записи, которые действовали после указанной даты. null - на текущую дату", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeAddressReceiverCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по дому с его адресом", "description": "HomeController (privileges: )", "operationId": "homeShow", "parameters": [ { "name": "home", "in": "path", "description": "номер ресурса дома", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeShow" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/firm_homes": { "get": { "tags": [ "Address" ], "summary": "Список УК, Поставщиков по дому", "description": "HomeFirmsController (privileges: unlimited)", "operationId": "home_firm_homes_index", "parameters": [ { "name": "home", "in": "path", "description": "id ресурса дома", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "фильтр по дате. Выбираем записи, которые действовали после указанной даты. null - на текущую дату", "required": false }, { "name": "sorted", "in": "query", "description": "поле для указания сортировки. Варианты: on_date,asc|des", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmHomeCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/action_items": { "get": { "tags": [ "Menu" ], "summary": "Активные пункты меню", "description": "ActionItemController (privileges: SYSTEM)", "operationId": "actionItemIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "name", "in": "query", "description": "фильтр по наименовании пункта меню", "required": false }, { "name": "route", "in": "query", "description": "фильтр по маршруту пункта меню", "required": false }, { "name": "resource_name", "in": "query", "description": "фильтр по ресурсу", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Menu" ], "summary": "Создание активного пункта меню", "description": "ActionItemController ( privileges: Global: SYSTEM)", "operationId": "actionItemsStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список улиц" }, "actionRoute": { "description": "Внутренний маршрут для фронта", "type": "string", "example": "api/streets" }, "notes": { "description": "Описание пункта меню", "type": "string", "example": "Список улиц по организации для чего-нибудь" }, "actionResourceId": { "description": "Код ресурса", "type": "integer", "example": 5 } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/action_items/{action_item}": { "get": { "tags": [ "Menu" ], "summary": "Просмотр выбранного активного пункта меню", "description": "ActionItemController ( privileges: Global: SYSTEM )", "operationId": "actionItemShow", "parameters": [ { "name": "action_item", "in": "path", "description": "номер ресурса из таблицы action_items", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Menu" ], "summary": "удаление активного пункта меню", "description": "actionItemController ( privileges: Global: SYSTEM)", "operationId": "actionItemDelete", "parameters": [ { "name": "action_item", "in": "path", "description": "номер ресурса в таблице action_item", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Menu" ], "summary": "Редактирование активного пункта меню", "description": "actionItemController ( privileges: Global: SYSTEM)", "operationId": "actionItemUpdate", "parameters": [ { "name": "action_item", "in": "path", "description": "номер ресурса из таблици action_item", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список улиц" }, "actionRoute": { "description": "Внутренний маршрут для фронта", "type": "string", "example": "api/streets" }, "notes": { "description": "Описание пункта меню", "type": "string", "example": "Список улиц по организации для чего-нибудь" }, "actionResourceId": { "description": "Код ресурса", "type": "integer", "example": 5 } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionItems" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/items": { "get": { "tags": [ "Menu" ], "summary": "Список всех пунктов главного меню и подменю", "description": "ItemController (privileges: SYSTEM)", "operationId": "itemIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Menu" ], "summary": "Создание элемента тип населенного пункта", "description": "ItemController ( privileges: Global: SYSTEM)", "operationId": "itemStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "position", "name" ], "properties": { "position": { "description": "позиция пункта меню в иерархии меню", "type": "integer", "example": 5 }, "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "sub_position": { "description": "Относительное расположение текущего пункта меню", "type": "string", "example": "left-top" }, "item_parent": { "description": "вызывающий пункт меню. Если это верхний уровень, то тут будет null", "type": "integer", "example": null }, "resource_id": { "description": "ссылка на ресурс", "type": "integer", "example": null }, "item_route": { "description": "для прописывание внутренних маршрутов фронта", "type": "string", "example": null }, "delimiter": { "description": "выделенный пункт меню", "type": "boolean", "example": false }, "notes": { "description": "Примечания", "type": "string", "example": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/items/{item}": { "get": { "tags": [ "Menu" ], "summary": "Просмотр выбранного пункта меню", "description": "ItemController ( privileges: Global: SYSTEM )", "operationId": "itemShow", "parameters": [ { "name": "item", "in": "path", "description": "номер ресурса с таблице items", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Menu" ], "summary": "удаление пункта меню", "description": "ItemController ( privileges: Global: SYSTEM)", "operationId": "itemDelete", "parameters": [ { "name": "item", "in": "path", "description": "номер ресурса с таблице items", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Menu" ], "summary": "Редактирование строки пункта меню", "description": "ItemController ( privileges: Global: SYSTEM)", "operationId": "itemUpdate", "parameters": [ { "name": "item", "in": "path", "description": "номер ресурса с таблице items", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "position", "name", "delimiter" ], "properties": { "position": { "description": "позиция пункта меню в иерархии меню", "type": "integer", "example": 5 }, "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "sub_position": { "description": "Относительное расположение текущего пункта меню", "type": "string", "example": "left-top" }, "item_parent": { "description": "вызывающий пункт меню. Если это верхний уровень, то тут будет null", "type": "integer", "example": null }, "resource_id": { "description": "ссылка на ресурс", "type": "integer", "example": null }, "item_route": { "description": "для прописывание внутренних маршрутов фронта", "type": "string", "example": null }, "delimiter": { "description": "выделенный пункт меню", "type": "boolean", "example": false }, "notes": { "description": "Примечания", "type": "string", "example": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/work_places/{work_place}/menu_items": { "get": { "tags": [ "Menu" ], "summary": "Пункты меню рабочего места", "description": "MenuItemController (privileges: SYSTEM)", "operationId": "menuItemIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "work_place", "in": "path", "description": "номер ресурса рабочего места", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItems" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Menu" ], "summary": "Создание элемента пункта меню рабочего места", "description": "MenuItemController (privileges: SYSTEM)", "operationId": "menuItemStore", "parameters": [ { "name": "work_place", "in": "path", "description": "идентификатор в таблице work_place", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "title": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "position": { "title": "Позиция в меню одного уровня", "type": "integer", "example": 1 }, "subPosition": { "title": "Относительное расположение текущего пункта меню", "description": "разрешенные значения: null, bottom_left, bottom_right, left_top, right_top", "type": "string", "example": "left-top" }, "itemCover": { "description": "диапазон покрытия", "type": "string", "example": "system" }, "parentId": { "title": "вызывающий пункт меню. Если это верхний уровень, то тут будет null", "type": "integer", "example": null }, "actionId": { "title": "ссылка на активный пункт меню", "type": "integer", "example": null }, "delimiter": { "title": "разделитель над текущем пунктом меню", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItems" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/work_places/{work_place}/menu_items/{menu_item}": { "delete": { "tags": [ "Menu" ], "summary": "удаление пункта меню рабочего места", "description": "MenuItemController ( privileges: Global: SYSTEM)", "operationId": "menuItemDelete", "parameters": [ { "name": "work_place", "in": "path", "description": "идентификатор в таблице work_place", "required": true }, { "name": "menu_item", "in": "path", "description": "идентификатор в таблице menu_items", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Menu" ], "summary": "Редактирование пункта меню рабочего места", "description": "MenuItemController ( privileges: SYSTEM)", "operationId": "menuItemUpdate", "parameters": [ { "name": "work_place", "in": "path", "description": "номер ресурса рабочего места", "required": true }, { "name": "menu_item", "in": "path", "description": "номер ресурса пункта меню", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "title": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "position": { "title": "Позиция в меню одного уровня", "type": "integer", "example": 1 }, "subPosition": { "title": "Относительное расположение текущего пункта меню", "type": "string", "example": "left-top" }, "itemCover": { "description": "диапазон покрытия", "type": "string", "example": "system" }, "actionId": { "title": "ссылка на активный пункт меню", "type": "integer", "example": null }, "delimiter": { "title": "разделитель над текущем пунктом меню", "type": "boolean", "example": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuItems" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/work_places": { "get": { "tags": [ "Menu" ], "summary": "Список рабочих мест программы", "description": "WorkPlaceController (privileges: SYSTEM)", "operationId": "workPlaceIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkPlace" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Menu" ], "summary": "Создание рабочего места", "description": "WorkPlaceController ( privileges: Global: SYSTEM)", "operationId": "workPlaceStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование рабочего месяца", "type": "string", "example": "Простой пользователь" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkPlace" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/work_places/{work_place}": { "delete": { "tags": [ "Menu" ], "summary": "удаление рабочего места", "description": "WorkPlaceController ( privileges: Global: SYSTEM)", "operationId": "workPlaceDelete", "parameters": [ { "name": "work_place", "in": "path", "description": "номер ресурса в таблице work_places", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Menu" ], "summary": "Редактирование наименования рабочего места", "description": "WorkPlaceController ( privileges: Global: SYSTEM)", "operationId": "workPlaceUpdate", "parameters": [ { "name": "work_place", "in": "path", "description": "номер ресурса из таблици work_place", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование рабочего месяца", "type": "string", "example": "Простой пользователь" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkPlace" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/magazines": { "get": { "tags": [ "Magazine" ], "summary": "Список событий в оперативном журнале", "description": "Magazines/MagazineController@index ( privileges: Magazine => R1 )", "operationId": "magazine.index", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "cityId", "in": "query", "description": "Фильтр по ID населенного пункта", "required": false }, { "name": "streetId", "in": "query", "description": "Фильтр по ID улицы", "required": false }, { "name": "addressId", "in": "query", "description": "Фильтр по ID дома (адреса)", "required": false }, { "name": "flatId", "in": "query", "description": "Фильтр по ID квартиры", "required": false }, { "name": "utilityId", "in": "query", "description": "Фильтр по ID услуги", "required": false }, { "name": "planDate", "in": "query", "description": "Фильтр по дате планового отсутствия услуги", "required": false }, { "name": "factDate", "in": "query", "description": "Фильтр по дате фактического отсутствия услуги", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IMagazineCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Magazine" ], "summary": "Создание строки события оперативного журнала", "description": "Magazines/MagazineController@store ( privileges: Magazine => C1 )", "operationId": "magazine.store", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/magazines/{magazine}": { "get": { "tags": [ "Magazine" ], "summary": "Подробный просмотр услуги", "description": "Magazines/MagazineController@index ( privileges: Magazine => R1 )", "operationId": "magazine.show", "parameters": [ { "name": "magazine", "in": "path", "description": "Идентификатор события", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Magazine" ], "summary": "Удаление события оперативного журнала", "description": "Magazines/MagazineController@destroy (privileges: Magazine => D0)", "operationId": "magazine.delete", "parameters": [ { "name": "magazine", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Magazine" ], "summary": "Редактирование события оперативного журнала", "description": "Magazines/MagazineController@update ( privileges: Magazine => U1 )", "operationId": "magazine.update", "parameters": [ { "name": "magazine", "in": "path", "description": "номер ресурса оперативного журнала", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/magazines/auto-load": { "post": { "tags": [ "Magazine" ], "summary": "Загрузка файла Word из ЕДДС в наш оперативный журнал", "description": "Magazines/MagazineController@autoLoad ( privileges: Magazine => C0)", "operationId": "magazine.autoload", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "schema": "FileSchema", "properties": { "file": { "title": "Файл к загрузке", "type": "string", "format": "binary" }, "cityId": { "description": "id населенного пункта, по которому делаем оперативный журнал", "type": "integer", "example": 61 } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "file": { "type": "file" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/magazines/{magazine}/unload_protocol": { "get": { "tags": [ "Magazine" ], "summary": "Выгрузка файла протокола автоматической загрузки оперативного журнала", "description": "Magazines/MagazineController@unloadProtocol ( privileges: Magazine => R0 )", "operationId": "magazine.protocol", "parameters": [ { "name": "magazine", "in": "path", "description": "Идентификатор события", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "file": { "type": "file" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/magazines/{magazine}/source_file": { "get": { "tags": [ "Magazine" ], "summary": "Выгрузка файла протокола автоматической загрузки оперативного журнала", "description": "Magazines/MagazineController@unloadSourceFile ( privileges: Magazine => R1 )", "operationId": "magazine.source", "parameters": [ { "name": "magazine", "in": "path", "description": "Идентификатор события", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "file": { "type": "file" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/outside_deletes": { "get": { "tags": [ "Address" ], "summary": "вывод данных об удалённых экземплярах административных районов Субъекта РФ", "description": "выдаем данные об удалённых районах, данные при выводе сортируются по убыванию даты удаления", "operationId": "outsideAllDelShow", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutsideHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/regions/{region}/outsides": { "get": { "tags": [ "Address" ], "summary": "Список административных районов субъекта РФ", "description": "Список не большой, фильтрацию делать не буду. По умолчанию пагинируется по 15 записей.", "operationId": "outsideIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "region", "in": "path", "description": "идентификатор субъекта РФ", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Outside" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание нового административного района у субъекта РФ.", "description": "Создание нового административного района у субъекта РФ.", "operationId": "outsideStore", "parameters": [ { "name": "region", "in": "path", "description": "идентификатор субъекта РФ", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование административного района", "type": "string", "example": "Хабаровский район" }, "okato": { "description": "Код по ОКАТО", "type": "string", "example": "01" }, "oktmo": { "description": "код по ОКТМО", "type": "string", "example": "201" }, "fias": { "description": "UUID административного района в ФИАС.", "type": "string", "example": "7d468f39-1afa-41ec-8c4f-9738603cb3d4" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Outside" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/regions/{region}/outsides/{outside}": { "delete": { "tags": [ "Address" ], "summary": "Удаление административного района Субъекта РФ из базы данных", "description": "Удаление административного района Субъекта РФ из базы данных", "operationId": "outsideDelete", "parameters": [ { "name": "region", "in": "path", "description": "идентификатор субъекта РФ", "required": true }, { "name": "outside", "in": "path", "description": "административный район субъекта РФ", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование административного района субъекта РФ", "description": "Редактирование административного района субъекта РФ", "operationId": "outsideUpdate", "parameters": [ { "name": "region", "in": "path", "description": "идентификатор субъекта РФ", "required": true }, { "name": "outside", "in": "path", "description": "административный район субъекта РФ", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "properties": { "name": { "description": "Наименование административного района", "type": "string", "example": "Хабаровский район" }, "okato": { "description": "Код по ОКАТО", "type": "string", "example": "01" }, "oktmo": { "description": "код по ОКТМО", "type": "string", "example": "201" }, "fias": { "description": "UUID административного района в ФИАС.", "type": "string", "example": "7d468f39-1afa-41ec-8c4f-9738603cb3d4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Outside" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Не соответствие входных параметров" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/outsides/{id}/hists": { "get": { "tags": [ "Address" ], "summary": "вывод данных об изменении экземпляра административного района Субъекта РФ", "description": "OutsideHistController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "outsideHistShow", "parameters": [ { "name": "id", "in": "path", "description": "идентификатор ресурса", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutsideHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/flats/{flat}/owners": { "get": { "tags": [ "Address" ], "summary": "Список собственников квартиры", "description": "OwnerController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "ownerIndex", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = null вывод без пагинации)", "required": false, "example": 1 }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "onDate", "in": "query", "description": "Дата на которую делать выборку, если null, то в выборке будут все собственники", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание собственника квартиры", "description": "OwnerController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "owner.store", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IOwner" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IOwner" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/flats/{flat}/owners/{owner}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по собственнику квартиры", "description": "OwnerController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "owner.show", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "owner", "in": "path", "description": "идентификатор собственника квартиры", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IOwner" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение данных о собственнике квартиры", "description": "OwnerController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "owner.update", "parameters": [ { "name": "flat", "in": "path", "description": "идентификатор квартиры", "required": true }, { "name": "owner", "in": "path", "description": "идентификатор собственника квартиры", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IOwner" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IOwner" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home_id}/pipes": { "get": { "tags": [ "Address" ], "summary": "Список разводок вертикальных труб по дому (стояки)", "description": "Pipes/PipeController ( privileges: Home - R1 )", "operationId": "pipe.index", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "home_id", "in": "path", "description": "Идентификатор дома", "required": true }, { "name": "utilityId", "in": "query", "description": "Идентификатор коммунальной услуги", "required": false }, { "name": "page", "in": "query", "description": "Номер выводимой страницы (null - вывод первой страницы)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание стояка", "description": "Pipes/PipeController ( privileges: Pipe - C1 )", "operationId": "pipe.store", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "home_id", "in": "path", "description": "Идентификатор дома", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home_id}/pipes/{pipe_id}": { "get": { "tags": [ "Address" ], "summary": "просмотр данных по стояку дома", "description": "Pipes/PipeController (privileges: Pipe - R1 )", "operationId": "pipe.show", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "home_id", "in": "path", "description": "Идентификатор дома", "required": true }, { "name": "pipe_id", "in": "path", "description": "Идентификатор стояка", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение данных по стояку дома", "description": "Pipes/PipeController ( privileges: Pipe - U1 )", "operationId": "pipe.update", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "home_id", "in": "path", "description": "идентификатор дома", "required": true }, { "name": "pipe_id", "in": "path", "description": "идентификатор стояка", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IPipe" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/pipes/{pipe}": { "delete": { "tags": [ "Address" ], "summary": "Удаление стояка дома", "description": "Pipes/PipeController (privileges: Pipe - D1 )", "operationId": "pipe.destroy", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "home", "in": "path", "description": "идентификатор дома", "required": true }, { "name": "pipe", "in": "path", "description": "идентификатор стояка", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_sub_topics/{call_sub_topic}/questionnaires": { "get": { "tags": [ "Catalog" ], "summary": "Получения pdf-файла со списком вопросов для дозвонившегося", "description": "Questionnaires/QuestionnaireController:index ( privileges: Questionnaire => R0)", "operationId": "questionnaireIndex", "parameters": [ { "name": "call_sub_topic", "in": "path", "description": "идентификатор подтемы", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "file": { "type": "file" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Catalog" ], "summary": "Прикрепление документа к подтеме", "description": "Questionnaires/QuestionnaireController:store ( privileges: Questionnaire => C0)", "operationId": "questionnaire.store", "parameters": [ { "name": "call_sub_topic", "in": "path", "description": "идентификатор подтемы", "required": true } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "schema": "FileSchema", "properties": { "file": { "title": "Файл к загрузке", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_sub_topics/{call_sub_topic}/questionnaires/{questionnaire}": { "delete": { "tags": [ "Catalog" ], "summary": "Удаление опросника у подтемы. ", "description": "Questionnaires/QuestionnaireController:destroy ( privileges: Questionnaire => D0)", "operationId": "questionnaire.delete", "parameters": [ { "name": "call_sub_topic", "in": "path", "description": "номер ресурса подтемы (call_sub_topics)", "required": true }, { "name": "questionnaire", "in": "path", "description": "номер ресурса документа-опросника (questionnaire)", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/address_receivers": { "get": { "tags": [ "Receiver" ], "summary": "Просмотр адресов с правилом регистрации обращений", "description": "AddressReceiverController (privileges: Global: SYSTEM, ADMIN)", "operationId": "address_receiver.index", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = null, без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "description": "Наименование объекта-владельца (Address, Group_Receiver, Firm_Home)", "required": true }, { "name": "objectId", "in": "query", "description": "Номер ресурса объекта-владельца", "required": true }, { "name": "onDate", "in": "query", "description": "фильтр по дате. Если она введена, то выбираем данные по дате", "required": false }, { "name": "firmId", "in": "query", "description": "фильтр по коду firms", "required": false }, { "name": "cityId", "in": "query", "description": "фильтр по коду cities", "required": false }, { "name": "streetName", "in": "query", "description": "фильтр по наименовании улицы", "required": false }, { "name": "homeNumber", "in": "query", "description": "фильтр по номеру улицы", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAddressReceiverCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Не хватает входных параметров" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/group_receivers/{group_receiver}/address_receivers": { "post": { "tags": [ "Receiver" ], "summary": "Присоединение списка домов к группе правил", "description": "AddressReceiverController (privileges: firm-create)", "operationId": "address_receiver.store", "parameters": [ { "name": "group_receiver", "in": "path", "description": "номер группы правил ввода обращений", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IAddressReceiverCollection" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/group_receivers/{group_receiver}/address_receivers/{address_receiver}": { "get": { "tags": [ "Receiver" ], "summary": "Просмотр адреса, присоединенного к группе правил приема обращения", "description": "AddressReceiverController (privileges: firm-View)", "operationId": "address_receiver.show", "parameters": [ { "name": "group_receiver", "in": "path", "description": "номер группы правил ввода обращений", "required": true }, { "name": "address_receiver", "in": "path", "description": "id ресурса связи дома с группой правил", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAddressReceiver" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Receiver" ], "summary": "Удаление договора управления у УК", "description": "FirmHomeController (privileges: SYSTEM, ADMIN.)", "operationId": "address_receiver.delete", "parameters": [ { "name": "group_receiver", "in": "path", "description": "номер группы правил ввода обращений", "required": true }, { "name": "address_receiver", "in": "path", "description": "id ресурса связи дома с группой правил", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Receiver" ], "summary": "Исправление дат участия дома в группе. Дата закрытия производится днем ранее.", "description": "AddressReceiverController (privileges: Global-update)", "operationId": "address_receiver.update", "parameters": [ { "name": "group_receiver", "in": "path", "description": "номер группы правил ввода обращений", "required": true }, { "name": "address_receiver", "in": "path", "description": "id ресурса связи дома с группой правил", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAddressReceiver" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IAddressReceiver" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_receivers": { "get": { "tags": [ "Receiver" ], "summary": "Список получателей обращений по адресу и теме", "description": "Receivers/CallReceiverController (privileges: CallReceiver => R1)", "operationId": "call_receiver.index", "parameters": [ { "name": "addressId", "in": "query", "description": "ID записи HomeStreet", "required": true }, { "name": "topicId", "in": "query", "description": "ID темы обращения (CallTopic)", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "title": "Список получателей обращений (основной и аварийный)", "type": "array", "items": { "$ref": "#/components/schemas/INewCallReceiver" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/group_receivers": { "get": { "tags": [ "Receiver" ], "summary": "Список групп правил регистрации обращений", "description": "GroupReceiverController (privileges: Global: SYSTEM, ADMIN)", "operationId": "group_receiver.index", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "required": true, "content": { "application/json": { "schema": { "default": "firm", "enum": [ "firm", "home", "home_street" ] } } } }, { "name": "objectId", "in": "query", "description": "Номер ресурса объекта-владельца", "required": true }, { "name": "firmId", "in": "query", "description": "фильтр по коду firms для работы через адреса", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data (через firms)": { "title": "Список групп при входе через фирму (firm)", "type": "array", "items": { "$ref": "#/components/schemas/IFirmGroupReceiver" } }, "data (через адрес)": { "title": "Список групп при входе через адрес (home_street)", "type": "array", "items": { "$ref": "#/components/schemas/IAddressGroupReceiver" } }, "data (через дом)": { "title": "Список групп при входе через дом (home)", "type": "array", "items": { "$ref": "#/components/schemas/IHomeGroupReceiver" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Receiver" ], "summary": "Создание группы правил регистрации обращений", "description": "GroupReceiverController (privileges: Global - SYSTEM, ADMIN)", "operationId": "group_receiver.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/group_receivers/{group_receiver}": { "get": { "tags": [ "Receiver" ], "summary": "Группы правил регистрации обращений", "description": "GroupReceiverController (privileges: SYSTEM, ADMIN)", "operationId": "group_receiver.show", "parameters": [ { "name": "group_receiver", "in": "path", "description": "идентификатор группы правил (group_receiver)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Receiver" ], "summary": "Удаление группы правил регистрации обращений", "description": "GroupReceiverController ( privileges: Global: SYSTEM, ADMIN, AllUsers )", "operationId": "group_receiver.destroy", "parameters": [ { "name": "group_receiver", "in": "path", "description": "идентификатор группы правил (group_receiver)", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Receiver" ], "summary": "Изменение группы правил регистрации обращений", "description": "GroupReceiverController (privileges: SYSTEM, ADMIN, AllUsers )", "operationId": "group_receiver.update", "parameters": [ { "name": "group_receiver", "in": "path", "description": "идентификатор группы правил (group_receiver)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/homes/{home}/receivers": { "get": { "tags": [ "Receiver" ], "summary": "Список потенциальных получателей обращений для дома", "description": "Receivers/ReceiverByHomeController (privileges: CallReceiver => R1)", "operationId": "receiver.index", "parameters": [ { "name": "home", "in": "path", "description": "ID ресурса дома (homes)", "required": true }, { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "title": "Список потенциальных получателей обращений", "type": "array", "items": { "$ref": "#/components/schemas/ICallReceiverSelectable" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/regions": { "get": { "tags": [ "Address" ], "summary": "Список всех субъектов РФ", "description": "RegionController (privileges: SYSTEM)", "operationId": "regionIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Region" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание субъекта РФ", "description": "RegionController (privileges: SYSTEM)", "operationId": "regionStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "shortName" ], "properties": { "name": { "description": "наименование субъекта", "type": "string", "example": "Еврейская Автономная Область" }, "shortName": { "description": "сокращенное наименование субъекта", "type": "string", "example": "ЕАО" }, "code": { "description": "цифровой код региона", "type": "string", "example": "79" }, "isoCode": { "description": "цифровой код ISO", "type": "string", "example": "RU-YEV" }, "gostCode": { "description": "цифровой код ГОСТ", "type": "string", "example": "RU-JEW" }, "fias": { "description": "код фиас", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "okato": { "description": "код ОКАТО", "type": "string", "example": "99" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Region" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/regions/{region}": { "get": { "tags": [ "Address" ], "summary": "вывод данных о субъекте", "description": "RegionController (privileges: SYSTEM)", "operationId": "regionShow", "parameters": [ { "name": "region", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Region" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление субъекта РФ из базы данных", "description": "RegionController (privileges: SYSTEM)", "operationId": "regionDelete", "parameters": [ { "name": "region", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение субъекта", "description": "RegionController (privileges: SYSTEM)", "operationId": "regionUpdate", "parameters": [ { "name": "region", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "shortName" ], "properties": { "name": { "description": "наименование субъекта", "type": "string", "example": "Еврейская Автономная Область " }, "shortName": { "description": "сокращенное наименование субъекта", "type": "string", "example": "ЕАО" }, "code": { "description": "цифровой код региона", "type": "string", "example": "79" }, "isoCode": { "description": "цифровой код ISO", "type": "string", "example": "RU-YEV" }, "gostCode": { "description": "цифровой код ГОСТ", "type": "string", "example": "RU-JEW" }, "fias": { "description": "код фиас", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "okato": { "description": "код ОКАТО", "type": "string", "example": "99" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Region" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/regions/{region}/hists": { "get": { "tags": [ "Address" ], "summary": "Архив изменений субъекта РФ", "description": "По умолчанию пагинируется по 15 записей.", "operationId": "regionHistIndex", "parameters": [ { "name": "region", "in": "path", "description": "номер ресурса для regions", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionHist" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/reports/magazines": { "post": { "tags": [ "Reports" ], "summary": "Отчет по списку обращений.", "description": "Reports/ReportController", "operationId": "magazine.report", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IMagazineRegistryReportRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IReportResponse" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/reports/calls": { "post": { "tags": [ "Reports" ], "summary": "Отчет по списку обращений.", "description": "Reports/ReportController", "operationId": "calls.report", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallsRegistryReportRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IReportResponse" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/reports/calls_by_firms": { "post": { "tags": [ "Reports" ], "summary": "Сводный отчет по обращениям у выбранной УК/РСО.", "description": "Reports/ReportController", "operationId": "calls_by_firms.report", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallByFirmReportRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IReportResponse" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/reports/report_results/{reportResult}": { "get": { "tags": [ "Reports" ], "summary": "Подробный просмотр данных об отчете", "description": "ReportResultController (privileges: )", "operationId": "report_result.show", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "reportResult", "in": "path", "description": "Идентификатор обращения", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IReportResponse" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/reports/report_results/{reportResult}/download": { "get": { "tags": [ "Reports" ], "summary": "Выгрузка файла отчета", "description": "ReportResultController (privileges: )", "operationId": "report_result.download", "parameters": [ { "name": "firm-user-id", "in": "header", "description": "организация от имени которой зашел пользователь (firm_users.id)", "required": true }, { "name": "reportResult", "in": "path", "description": "Идентификатор обращения", "required": true } ], "responses": { "200": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/resource_templates": { "get": { "tags": [ "Authorization" ], "summary": "Список разрешений для шаблона либо для ресурса", "description": "ResourceTemplateController (privileges: SYSTEM)", "operationId": "resourceTemplateIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "required": true, "content": { "application/json": { "schema": { "enum": [ "template", "resource" ] } } } }, { "name": "objectId", "in": "query", "description": "идентификатор в таблице templates либо resources", "required": true }, { "name": "name", "in": "query", "description": "поле для фильтра по наименованию", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTemplate" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Authorization" ], "summary": "Создание прав доступа.", "description": "ResourceTemplateController (privileges: SYSTEM)", "operationId": "resourceTemplatesStore", "parameters": [ { "name": "resource_id", "in": "query", "description": "Идентификатор ресурса в таблице resources", "required": true }, { "name": "template_id", "in": "query", "description": "Идентификатор шаблона в таблице templates", "required": true }, { "name": "temp_access", "in": "query", "description": "Шаблон с правилами доступа", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTemplate" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "424": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/resource_templates/{resource_template}": { "get": { "tags": [ "Authorization" ], "summary": "Вывод данных о правах доступа", "description": "ResourceTemplateController (privileges: SYSTEM)", "operationId": "resourceTemplatesShow", "parameters": [ { "name": "resource_template", "in": "path", "description": "Идентификатор прав доступа в таблице resource_templates", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTemplateShow" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "424": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Authorization" ], "summary": "Удаление прав доступа", "description": "ResourceTemplateController ( privileges: Global: SYSTEM)", "operationId": "resourceTemplateDelete", "parameters": [ { "name": "resource_template", "in": "path", "description": "Идентификатор прав доступа в таблице resource_templates", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Ошибка удаления" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Authorization" ], "summary": "Редактирование прав доступа", "description": "ResourceTemplateController ( privileges: Global: SYSTEM)", "operationId": "resourceTemplatesUpdate", "parameters": [ { "name": "resource_template", "in": "path", "description": "Идентификатор прав доступа в таблице resource_templates", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "temp_access" ], "properties": { "temp_access": { "description": "Права доступа", "type": "string", "example": "C0R0U0D0" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceTemplate" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "424": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/resources": { "get": { "tags": [ "Authorization" ], "summary": "Просмотр ресурсов", "description": "ResourceController ( privileges: Global: SYSTEM)", "operationId": "resourceIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "name", "in": "query", "description": "фильтр по наименованию ресурса", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/resources/{resource}": { "get": { "tags": [ "Authorization" ], "summary": "просмотр выбранного ресурса", "description": "ResourceController ( privileges: Global: SYSTEM, ADMIN, ADDRESS )", "operationId": "resourceShow", "parameters": [ { "name": "resource", "in": "path", "description": "Идентификатор записи в таблице resources", "required": true } ], "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Authorization" ], "summary": "Изменение ресурса", "description": "ResourceController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "resourceUpdate", "parameters": [ { "name": "resource", "in": "path", "description": "Идентификатор записи в таблице resources", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "description" ], "properties": { "description": { "description": "Описание ресурса", "type": "string", "example": "Ресурс для модели" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/ate_queues": { "get": { "tags": [ "Catalog" ], "summary": "Список очередей АТС по приему обращений", "description": "Services/AteQueueController ( privileges: all users )", "operationId": "ate_queues.index", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = null вывод без пагинации)", "required": false, "example": 1 }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false, "example": 15 } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ICallQueueCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Catalog" ], "summary": "Создание обращения", "description": "Services/AteQueueController (privileges: AteQueue => C0 )", "operationId": "ate_queues.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallQueue" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallQueue" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/ate_queues/{ate_queue}": { "get": { "tags": [ "Catalog" ], "summary": "просмотр данных о выбранной очереди АТС", "description": "Services/AteQueueController (privileges: AteQueue => R0)", "operationId": "ate_queues.show", "parameters": [ { "name": "ate_queue", "in": "path", "description": "номер ресурса очереди АТС", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallQueue" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Catalog" ], "summary": "Удаление очереди АТС", "description": "Services/AteQueueController (privileges: AteQueue => D0)", "operationId": "ate_queues.destroy", "parameters": [ { "name": "ate_queue", "in": "path", "description": "номер ресурса очереди АТС", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Catalog" ], "summary": "Редактирование очереди АТС", "description": "Services/AteQueueController (privileges: AteQueue => U0)", "operationId": "ate_queues.update", "parameters": [ { "name": "ate_queue", "in": "path", "description": "номер ресурса очереди АТС", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallQueue" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ICallQueue" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/errors/mobile": { "post": { "tags": [ "Catalog" ], "summary": "Сохранение ошибки работы мобильного приложения.", "description": "Services/ClientErrorController (privileges: Call => C1 для переданной home_street_id)", "operationId": "client_error.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IClientError" } }, "type": "object" } } } }, "responses": { "204": { "description": " ", "content": { "application/json": { "schema": { "default": " " } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/ping": { "post": { "tags": [ "Catalog" ], "summary": "проверка доступа к сервису", "description": "Services/PingController (privileges: not authentication)", "operationId": "ping.store", "responses": { "200": { "description": "ответ на запрос", "content": { "application/json": { "schema": { "default": "pong" } } } }, "404": { "description": "не смогли достучаться" } }, "security": [ { "Token": [] } ] } }, "/emergency": { "post": { "tags": [ "Calls" ], "summary": "Создание сообщения на фронт ", "description": "Sockets/EmergencyTestController ", "operationId": "emergency.socket", "requestBody": { "content": { "application/json": { "schema": { "properties": { "testId": { "description": "id вместо номера сообщения", "type": "integer", "example": 5 }, "userId": { "description": "id вместо данных о владельце папки", "type": "integer", "example": 55 } }, "type": "object" } } } }, "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/street_types": { "get": { "tags": [ "Address" ], "summary": "Справочников типов улиц", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetType" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание типа улиц", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "shortName" ], "properties": { "name": { "description": "полное наименование", "type": "string", "example": "бульвар" }, "shortName": { "description": "сокращенное наименование (согласно КЛАДР) с точкой для разделения", "type": "string", "example": "б-р." } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetType" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/street_types/{street_type}": { "get": { "tags": [ "Address" ], "summary": "просмотр записи типа улицы", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeShow", "parameters": [ { "name": "street_type", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetType" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление типа улицы. У этого типа не должно быть подчиненных улиц", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeDelete", "parameters": [ { "name": "street_type", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование типа улиц", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeUpdate", "parameters": [ { "name": "street_type", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "shortName" ], "properties": { "name": { "description": "полное наименование", "type": "string", "example": "бульвар" }, "shortName": { "description": "сокращенное наименование (согласно КЛАДР) с точкой для разделения", "type": "string", "example": "б-р." } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetType" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/street_types/{id}/hists": { "get": { "tags": [ "Address" ], "summary": "Архив изменений типа улицы", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetTypeHistIndex", "parameters": [ { "name": "id", "in": "path", "description": "код ресурса записи, у которой смотрим архив", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetTypeHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/streets": { "get": { "tags": [ "Address" ], "summary": "Общий список улиц", "description": "AllStreetController (all)", "operationId": "allStreetIndex", "parameters": [ { "name": "Application-Type", "in": "header", "required": false, "content": { "application/json": { "schema": { "default": "desktop", "enum": [ "desktop", "mobile" ] } } } }, { "name": "page", "in": "query", "description": "№ страницы (default = null без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "city", "in": "query", "description": "код населенного пункта для фильтра по нас.пунктам", "required": false }, { "name": "name", "in": "query", "description": "наименование улицы, по которому будем фильтровать улицы", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllStreet" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "создание улицы из общего списка", "description": "AllStreetController (privileges: SYSTEM, ADMIN)", "operationId": "allStreetStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "cityId", "prefixId" ], "properties": { "name": { "description": "полное наименование улицы", "type": "string", "example": "Озерная" }, "fias": { "description": "ФИАС улицы", "type": "string|null", "example": null }, "cityId": { "description": "Ресурс населенного пункта", "type": "integer", "example": 2 }, "prefixId": { "description": "Ресурс типа улицы", "type": "integer", "example": 3 } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllStreet" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/streets/{street}": { "get": { "tags": [ "Address" ], "summary": "просмотр записи улицы", "description": "AllStreetController (privileges: SYSTEM, ADMIN)", "operationId": "allStreetShow", "parameters": [ { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllStreet" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление улицы. У этой улицы не должно быть подчиненных домов", "description": "AllStreetController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "allStreetDelete", "parameters": [ { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Редактирование улицы", "description": "AllStreetController (privileges: SYSTEM, ADMIN)", "operationId": "allStreetUpdate", "parameters": [ { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "cityId", "prefixId" ], "properties": { "name": { "description": "полное наименование улицы", "type": "string", "example": "Озерная" }, "fias": { "description": "ФИАС улицы", "type": "string|null", "example": null }, "prefixId": { "description": "Ресурс типа улицы", "type": "integer", "example": 3 } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllStreet" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities/{city}/streets": { "get": { "tags": [ "Address" ], "summary": "Список улиц по населенному пункта", "description": "StreetController ( privileges: Global: SYSTEM, ADMIN, OPERATOR, LOCALUSER)", "operationId": "streetIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Street" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Address" ], "summary": "Создание улицы", "description": "StreetController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetStore", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "streetTypeId" ], "properties": { "name": { "description": "полное наименование улицы.", "type": "string", "example": "Озерная" }, "fias": { "description": "ФИАС улицы.", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "streetTypeId": { "description": "тип улицы. Берем из таблицы street_types", "type": "integer", "example": "1" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Street" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/cities/{city}/streets/{street}": { "get": { "tags": [ "Address" ], "summary": "просмотр записи улицы", "description": "StreetController ( privileges: Global: SYSTEM, ADMIN, OPERATOR, LOCALUSER)", "operationId": "streetShow", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Street" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Не соответствие входных параметров" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Address" ], "summary": "Удаление улицы. У этой улицы не должно быть подчиненных домов", "description": "StreetTypeController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetDelete", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "responses": { "204": { "description": "Oк" }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Address" ], "summary": "Изменение улицы", "description": "StreetController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetUpdate", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "street", "in": "path", "description": "номер ресурса просматриваемой улицы", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "streetTypeId" ], "properties": { "name": { "description": "полное наименование улицы.", "type": "string", "example": "Озерная" }, "fias": { "description": "ФИАС улицы.", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "streetTypeId": { "description": "тип улицы. Берем из таблицы street_types", "type": "integer", "example": "1" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Street" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Не соответствие входных параметров" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "cities/{city}/streets/{id}/hists": { "get": { "tags": [ "Address" ], "summary": "Архив изменений улицы", "description": "StreetController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "streetHistIndex", "parameters": [ { "name": "city", "in": "path", "description": "номер ресурса населенного пункта", "required": true }, { "name": "id", "in": "path", "description": "код ресурса записи, у которой смотрим архив", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreetTypeHist" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "406": { "description": "Не соответствие входных параметров" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/template_users": { "get": { "tags": [ "Authorization" ], "summary": "просмотр связи пользователя и шаблона", "description": "TemplateUserController ( privileges: Global: SYSTEM)", "operationId": "templateUserIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "from", "in": "query", "description": "наименование объекта (user, template)", "required": true, "content": { "application/json": { "schema": { "enum": [ "user", "template" ] } } } }, { "name": "objectId", "in": "query", "description": "номер ресурса", "required": true }, { "name": "userName", "in": "query", "description": "фильтр по логину пользователя", "required": false }, { "name": "userFIO", "in": "query", "description": "фильтр по ФИО пользователя", "required": false }, { "name": "firmId", "in": "query", "description": "фильтр по коду фирмы", "required": false }, { "name": "divisionId", "in": "query", "description": "фильтр по коду подразделения", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUserCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Authorization" ], "summary": "Присоединение списка пользователей к шаблонам", "description": "TemplateUserController ( privileges: Global: SYSTEM, Admin)", "operationId": "templateUserStore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "required": [ "userId", "templateId" ], "properties": { "userId": { "title": "ресурс пользователя", "type": "integer", "example": 11 }, "templateId": { "title": "ресурс шаблона", "type": "integer", "example": 1 }, "connectAction": { "title": "Признак присоединения пользователя к шаблону", "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/template_users/{template_user}": { "delete": { "tags": [ "Authorization" ], "summary": "Удаление связи из базы данных", "description": "TemplateUserController ( privileges: Global: SYSTEM, ADMIN)", "operationId": "templateUserDelete", "parameters": [ { "name": "template_user", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/templates": { "get": { "tags": [ "Authorization" ], "summary": "Список шаблонов рабочего места", "description": "TemplateController (privileges: SYSTEM)", "operationId": "templateIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "name", "in": "query", "description": "фильтр по наименованию шаблона рабочего места", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Authorization" ], "summary": "Создание шаблона рабочего места", "description": "TemplateController ( privileges: Global: SYSTEM)", "operationId": "templateStore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "description" ], "properties": { "name": { "description": "Наименование шаблона рабочего места", "type": "string", "example": "SYSTEM" }, "description": { "description": "Описание шаблона рабочего места", "type": "string", "example": "Данный шаблон даёт полный доступ ко всем объектам программы" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "400": { "description": "Повторный ввод записи" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" }, "424": { "description": "Недостаточно переданных данных для создания записи" } }, "security": [ { "Token": [] } ] } }, "/templates/{template}": { "get": { "tags": [ "Authorization" ], "summary": "Просмотр выбранного шаблона рабочего места", "description": "TemplateController ( privileges: Global: SYSTEM )", "operationId": "templateShow", "parameters": [ { "name": "template", "in": "path", "description": "идентификатор в таблице templates", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Authorization" ], "summary": "Удаление шаблона рабочего места", "description": "TemplateController ( privileges: Global: SYSTEM)", "operationId": "templateDelete", "parameters": [ { "name": "template", "in": "path", "description": "Идентификатор в таблице templates", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Authorization" ], "summary": "Редактирование шаблона рабочего места", "description": "TemplateController ( privileges: Global: SYSTEM)", "operationId": "templateUpdate", "parameters": [ { "name": "template", "in": "path", "description": "Идентификатор в таблице templates", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "description" ], "properties": { "name": { "description": "Наименование организации", "type": "string", "example": "SYSTEM" }, "description": { "description": "Описание шаблона рабочего места", "type": "string", "example": "Данный шаблон даёт полный доступ ко всем объектам программы" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что пошло не так" } }, "security": [ { "Token": [] } ] } }, "/templates/{template}/copy": { "post": { "tags": [ "Authorization" ], "summary": "Идентификатор шаблона-источника в таблице templates.", "description": "TemplateCopyController (privileges: SYSTEM)", "operationId": "templateCopy", "parameters": [ { "name": "template", "in": "path", "description": "идентификатор в таблице templates", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "templ_name", "templ_descr" ], "properties": { "templ_name": { "description": "Наименование шаблона рабочего места", "type": "string", "example": "OPERATOR" }, "templ_descr": { "description": "Описание шаблона рабочего места", "type": "string", "example": "Данный шаблон даёт доступ к необходимым оператору объектам программы" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/templates/{template}/users": { "get": { "tags": [ "Authorization" ], "summary": "Список пользователей, у которых есть данный шаблон рабочего места.", "description": "TemplateUsersController (privileges: SYSTEM)", "operationId": "templateUsers", "parameters": [ { "name": "template", "in": "path", "description": "идентификатор в таблице templates", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = 1)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUser" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/call_topics": { "get": { "tags": [ "Catalog" ], "summary": "Список тем со списком подчиненных под тем", "description": "TopicIndexController ( privileges: Global: SYSTEM, ADMIN, OPERATOR, LOCALUSER)", "operationId": "callTopicIndex", "parameters": [ { "name": "forTenant", "in": "query", "description": "Вывод тем. true - выводим темы и подтемы доступные для населения", "required": false, "content": { "application/json": { "schema": { "default": "false", "enum": [ "true", "false" ] } } } } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Catalog" ], "summary": "Редактирование списка тем и подтем обращений", "description": "CallTopicUpdateController (privileges: SYSTEM, ADMIN)", "operationId": "callTopicStore2", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "id" ], "properties": { "topics": { "type": "array", "items": { "$ref": "#/components/schemas/CallTopic" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } }, "/gis_themas": { "get": { "tags": [ "Catalog" ], "summary": "Список тем, полученных из ГИС ЖКХ", "description": "Topics/GisThemasController ( privileges: GisThema => R0)", "operationId": "gisThemaIndex", "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGisThemaCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/delete_other_tokens": { "post": { "tags": [ "Login" ], "summary": "Удаление остальных токенов", "description": "DeleteTokenController (privileges: none)", "operationId": "deleteOtherTokens", "responses": { "204": { "description": "ok", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Пользователь не аутентифицирован" } }, "security": [ { "Token": [] } ] } }, "/user_mobile": { "post": { "tags": [ "Login" ], "summary": "создание и получение токена для мобильного пользователя", "description": "GetTokenForMobileUserController (privileges: pavlov)", "operationId": "userMobile", "responses": { "201": { "description": "ok", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/user/next_call_number": { "get": { "tags": [ "Login" ], "summary": "Получение номера последнего созданного обращения", "description": "Users/LastNumberController.get (privilege: current user)", "operationId": "userLastNumberGet", "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/INextCallNumber" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/login": { "post": { "tags": [ "Login" ], "summary": "получение токена", "operationId": "login", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "password", "rToken" ], "properties": { "name": { "type": "string", "example": "pavlov" }, "password": { "type": "string", "example": "123456" }, "rToken": { "description": "токен от reCaptcha", "type": "string", "example": "2093ruwejdlks" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } } } }, "401": { "description": "Ошибка проверка на reCaptcha", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "request denied" }, "errors": { "type": "array", "items": { "properties": { "authentication[0]": { "description": "переданный токен для Google не валидный", "type": "string", "example": "request denied" }, "authentication[1]": { "description": "вероятно это бот. Оценка 0.4", "type": "string", "example": "request denied: 0.4" }, "authentication[2]": { "description": "Вероятно это человек, но нужна доп.проверка. Оценка 0.6", "type": "string", "example": "verify: 0.6" } }, "type": "object" } } }, "type": "object" } } } }, "403": { "description": "Ошибка аутентификации" } }, "security": [ { "XSRF-Token": [] } ] } }, "/loginUser": { "post": { "tags": [ "Login" ], "summary": "Получение всех исходных данных пользователя", "description": "LoginUserController (privileges: none)", "operationId": "loginUser", "requestBody": { "content": { "application/json": { "schema": { "required": [ "oldPassword", "newPassword" ], "properties": { "name": { "title": "логин пользователя", "type": "string", "example": "pavlov" }, "password": { "title": "пароль пользователя", "type": "string", "example": "123456" }, "rToken": { "title": "токен от reCaptcha", "type": "string", "example": "2093ruwejdlks" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ILogUserApi" } } } }, "401": { "description": "Пользователь не аутентифицирован" } } } }, "/refresh": { "post": { "tags": [ "Login" ], "summary": "Обновление токенов", "description": "RefreshController (privileges: none)", "operationId": "refreshToken", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "accessToken": { "title": "Новый токен", "type": "string", "example": "2|E6sDZzwSKiaCqSnAPBDYoZ6E9HRlR9NIrrl0Xfaz" }, "refreshToken": { "title": "Новый refresh токен", "type": "string", "example": "3|E6sDZzwSKiayscjdhyBDYoZ6E9HRlR9NIrrl0Xfaz" }, "refreshTokenExpiresAt": { "title": "дата и время окончания действия refresh token (время местное)", "type": "string", "example": "2026-10-01 17:30" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" } }, "security": [ { "Token": [] } ] } }, "/user/access": { "get": { "tags": [ "Login" ], "summary": "Список всех разрешений пользователя", "description": "Список не пагинируется - выдается общим", "operationId": "userAccessIndex", "responses": { "401": { "description": "пользователь не идентифицирован" }, "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllUserResources" } } } }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/users": { "get": { "tags": [ "Login" ], "summary": "Список пользователей", "description": "UserController (privileges: SYSTEM, FirmUser, DivisionUser)", "operationId": "loginIndex", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы (default = null - вывод всего списка)", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false }, { "name": "firm_id", "in": "query", "description": "фильтр по ID фирмы", "required": false }, { "name": "firm_name", "in": "query", "description": "фильтр по наименованию фирмы", "required": false }, { "name": "division_id", "in": "query", "description": "фильтр по ID подразделения", "required": false }, { "name": "division_name", "in": "query", "description": "фильтр по наименованию подразделения", "required": false }, { "name": "id", "in": "query", "description": "фильтр по ID пользователя", "required": false }, { "name": "name", "in": "query", "description": "фильтр по логину пользователя", "required": false }, { "name": "fio", "in": "query", "description": "фильтр по ФИО пользователя", "required": false }, { "name": "sorted", "in": "query", "description": "сортировка (варианты: id,des|asc, name,asc|des,fio,asc|des)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "title": "Список пользователей", "type": "array", "items": { "$ref": "#/components/schemas/IUser" } } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Ошибка в запросе" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Login" ], "summary": "Создание пользователя", "description": "UserController (privileges: SYSTEM)", "operationId": "userStore", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "responses": { "201": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/user": { "get": { "tags": [ "Login" ], "summary": "Данные текущего пользователя", "description": "-", "operationId": "loginShow", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" } }, "security": [ { "Token": [] } ] } }, "/users/{user}": { "get": { "tags": [ "Login" ], "summary": "Данные указанного пользователя", "description": "Вывести данные указанного пользователя", "operationId": "userShow", "parameters": [ { "name": "user", "in": "path", "description": "номер ресурса", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" } }, "security": [ { "Token": [] } ] }, "put": { "tags": [ "Login" ], "summary": "Перевод пользователя в другое подразделение, в рамках одного предприятия", "description": "ограничение этой операции. могут только админы базы данных.", "operationId": "userReconnect", "parameters": [ { "name": "user", "in": "path", "description": "номер ресурса", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "new_firm_type", "new_firm_id" ], "properties": { "new_firm_type": { "description": "к кому будем подключать пользователя: к фирме или подразделению (но все в рамках одной фирмы)", "type": "string", "example": "firm | division" }, "new_firm_id": { "type": "integer", "example": "12" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ILogUser" } } } }, "400": { "description": "неправильные значения входного параметра" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Login" ], "summary": "Удаление пользователя", "description": "UserController (privileges: SYSTEM)", "operationId": "userDelete", "parameters": [ { "name": "user", "in": "path", "description": "Номер ресурса", "required": true } ], "responses": { "204": { "description": "ok" }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Что-то пошло не так" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Login" ], "summary": "Изменение пользователя", "description": "UserController (privileges: SYSTEM, localAdmin)", "operationId": "userUpdate", "parameters": [ { "name": "user", "in": "path", "description": "Номер ресурса", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/users/{user}/firms": { "get": { "tags": [ "Login" ], "summary": "Список организаций, к которым подключен пользователь", "description": "UserFirmController (privileges: allUsers)", "operationId": "user_firm_index", "parameters": [ { "name": "user", "in": "path", "description": "идентификатор пользователя", "required": true }, { "name": "page", "in": "query", "description": "№ страницы (default = null) - список без пагинации", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во на странице (default=15)", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUserFirm" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/user/info": { "patch": { "tags": [ "Login" ], "summary": "Изменение пользователя", "description": "UserInfoUpdateController (privileges: current user)", "operationId": "current_user_info", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUser" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ILogUser" } }, "type": "object" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/user/password": { "patch": { "tags": [ "Login" ], "summary": "Изменение своего пароля у пользователя", "description": "UserPasswordController (privileges: you own)", "operationId": "userPasswordUpdate", "requestBody": { "content": { "application/json": { "schema": { "required": [ "oldPassword", "newPassword" ], "properties": { "oldPassword": { "title": "текущий пароль пользователя", "type": "string", "example": "qwertyasdfg" }, "newPassword": { "title": "новый пароль пользователя", "type": "string", "example": "asdfgqwerty" } }, "type": "object" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfo" } } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/users/{user}/firm_users/{firm_user}": { "patch": { "tags": [ "Login" ], "summary": "Изменение организации по умолчания", "description": "UserSetDefaultFirmController (privileges: user->U1)", "operationId": "setDefaultUpdate", "parameters": [ { "name": "user", "in": "path", "description": "идентификатор пользователя", "required": true }, { "name": "firm_user", "in": "path", "description": "идентификатор firm_users", "required": true } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Пользователь не аутентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "Недостаточно данных или они ошибочны" } }, "security": [ { "Token": [] } ] } }, "/users/{user}/templates": { "get": { "tags": [ "Authorization" ], "summary": "Список шаблонов рабочего места, которые подключены к данному пользователю.", "description": "UserTemplatesController (privileges: SYSTEM)", "operationId": "userTemplates", "parameters": [ { "name": "page", "in": "query", "description": "№ страницы", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во элементов на странице", "required": false }, { "name": "user", "in": "path", "description": "Идентификатор пользователя в таблице users.", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTemplate" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/user/work_folder_set": { "get": { "tags": [ "Login" ], "summary": "Рабочий набор папок для текущего пользователя", "description": "Users/UserWorkFolderSetController (privilege: current user)", "operationId": "userWorkFolderSet", "parameters": [ { "name": "firmUserId", "in": "query", "description": "ID записи firm_users", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IBaseId" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/users/{user}/access": { "get": { "tags": [ "Login" ], "summary": "Список всех разрешений выбранного пользователя", "description": "добавляется пагинация", "operationId": "usersAccessIndex", "parameters": [ { "name": "user", "in": "path", "description": "номер ресурса", "required": false }, { "name": "page", "in": "query", "description": "№ страницы", "required": false }, { "name": "per_page", "in": "query", "description": "кол-во элементов на странице", "required": false }, { "name": "resource", "in": "query", "description": "фильтр по наименовании ресурса", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllUserResources" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/utilities": { "get": { "tags": [ "Magazine" ], "summary": "Список обращений", "description": "Utilities/UtilityController@index ( privileges: Utility - R0 )", "operationId": "utility.index", "parameters": [ { "name": "page", "in": "query", "description": "Номер выводимо страницы (null - вывод без пагинации)", "required": false }, { "name": "per_page", "in": "query", "description": "Количество строк на странице (null - вывод по 15 строк)", "required": false }, { "name": "nameFilter", "in": "query", "description": "Фильтр по наименовании услуги", "required": false } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IUtilityCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Magazine" ], "summary": "Создание жилищно-коммунальной услуги", "description": "Utilities/UtilityController@store ( privileges: Utility => C0 )", "operationId": "utility.store", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUtility" } }, "type": "object" } } } }, "responses": { "201": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUtility" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/utilities/{utility}": { "get": { "tags": [ "Magazine" ], "summary": "Подробный просмотр услуги", "description": "Utilities/UtilityController@show ( privileges: Utility => R0 )", "operationId": "utility.show", "parameters": [ { "name": "utility", "in": "path", "description": "Идентификатор услуги", "required": true } ], "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUtility" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "delete": { "tags": [ "Magazine" ], "summary": "Удаление услуги", "description": "Utilities/UtilityController@delete ( privileges: Utility => D0 )", "operationId": "utility.destroy", "parameters": [ { "name": "utility", "in": "path", "description": "Идентификатор услуги", "required": true } ], "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] }, "patch": { "tags": [ "Magazine" ], "summary": "Изменения наименования услуги", "description": "Utilities/UtilityController@update ( privileges: Utility => U0 )", "operationId": "utility.update", "parameters": [ { "name": "utility", "in": "path", "description": "Идентификатор услуги", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUtility" } }, "type": "object" } } } }, "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IUtility" } }, "type": "object" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] } }, "/work-types": { "get": { "tags": [ "Catalog" ], "summary": "Список видов работ со всеми подчиненными структурами", "description": "WorkTypeIndexController ( privileges: Global: SYSTEM, ADMIN, OPERATOR, LOCALUSER)", "operationId": "workTypeIndex", "responses": { "200": { "description": "Oк", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkTypeCollection" } } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватаем входных параметров" } }, "security": [ { "Token": [] } ] }, "post": { "tags": [ "Catalog" ], "summary": "Редактирование списка видов и подвидов работ", "description": "WorkTypeUpdateController (privileges: SYSTEM, ADMIN)", "operationId": "workTypeStore", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "id" ], "properties": { "workTypes": { "type": "array", "items": { "$ref": "#/components/schemas/WorkType" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Oк", "content": { "application/json": { "schema": {} } } }, "401": { "description": "пользователь не идентифицирован" }, "403": { "description": "Недостаточно прав доступа" }, "422": { "description": "нет содержимого или не хватает входных параметров" } }, "security": [ { "Token": [] } ] } } }, "components": { "schemas": { "AllUserResources": { "title": "AllUserResources - Список всех разрешений пользователя", "description": "", "properties": { "resource_id": { "description": "код ресурса для таблицы Resources", "type": "integer", "example": 2 }, "resource_name": { "description": "Наименование ресурса", "type": "string", "example": "RESOURCE" }, "user_access": { "description": "строка разрешения пользователя", "type": "string", "example": "R0E0" } }, "type": "object" }, "ActionItems": { "title": "ActionItems - активные пункты меню программы", "description": "Активный пункт меню программы. Т.е. пункт который вызовет действие ", "properties": { "id": { "description": "код ресурса для таблицы action_items", "type": "integer", "example": 2 }, "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список домов" }, "actionRoute": { "description": "Внутренний маршрут для фронта", "type": "string", "example": "/homes" }, "actionResourceId": { "description": "Код ресурсной записи", "type": "integer", "example": 5 }, "actionResourceName": { "description": "Наименование ресурса", "type": "string", "example": "FIRM_TYPE" }, "notes": { "description": "описание пункта меню", "type": "string", "example": "Список домов предприятия" } }, "type": "object" }, "AddressCollection": { "title": "Addresses - Список вывод адресов(нас.пункт, улица, дом) по условию", "properties": { "data": { "title": "массив в выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/Address" } } }, "type": "object" }, "IAddressInfoCollection": { "title": "Список адресов с квартирами по условию", "properties": { "data": { "title": "массив с выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/IAddressInfo" } } }, "type": "object" }, "IAddressInfo": { "title": "IAddressInfo - полный адрес от нас.пункта до квартиры", "description": "Описание вывода данных из таблиц (streets, homes, home_street, flats, cities)", "properties": { "id": { "title": "номер ресурса home_street", "type": "integer", "readOnly": true, "example": 1 }, "streetId": { "title": "номер ресурса улицы (streets)", "type": "integer", "example": 1 }, "streetPrefixName": { "title": "тип улицы", "type": "string", "readOnly": true, "example": "улица" }, "streetName": { "title": "наименование улицы", "type": "string", "readOnly": true, "example": "Школьная" }, "homeNumber": { "title": "номер дома", "type": "string", "example": "666А" }, "homeCorp": { "title": "корпус дома", "type": "string", "example": "2" }, "homeFrame": { "title": "строение дома", "type": "string", "example": "8" }, "manageFirmId": { "title": "ресурс УК, с которой договор управления", "type": "integer", "readOnly": true, "example": 1 }, "manageFirmName": { "title": "наименование УК, с которой договор управления", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "manageFirmDate": { "title": "дата начала управления", "type": "string", "readOnly": true, "example": "2024-12-01" }, "cityId": { "title": "ресурс населенного пункта", "type": "integer", "example": 8 }, "cityPrefixName": { "title": "тип населенного пункта", "type": "string", "readOnly": true, "example": "поселок" }, "cityName": { "title": "наименование населенного пункта", "type": "string", "readOnly": true, "example": "Чирки" }, "districtId": { "title": "ресурс административного района города", "type": "integer", "example": 18 }, "districtName": { "title": "наименование адм.района", "type": "string", "readOnly": true, "example": "Индустриальный район" }, "fias": { "title": "ФИАС адреса", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "homeId": { "title": "ресурс дома/здания (homes)", "type": "integer", "example": 8 }, "builtYear": { "title": "год постройки", "type": "integer", "example": 2024 }, "wearOut": { "title": "процент износа", "type": "integer", "example": 50.5 }, "maxFloors": { "title": "максимальная этажность дома", "type": "integer", "example": 10 }, "hasMultiAddress": { "title": "наличие двойного адреса", "type": "boolean", "readOnly": true, "example": false }, "firms": { "type": "array", "items": { "$ref": "#/components/schemas/IFirmAddressInfo" }, "readOnly": true }, "flats": { "type": "array", "items": { "$ref": "#/components/schemas/IFlatInfo" }, "readOnly": true } }, "type": "object" }, "Address": { "title": "Address - Список адресов", "description": "Описание вывода данных из таблиц улиц, домов, нас.пунктов (streets, homes, home_street, cities)", "properties": { "id": { "title": "номер ресурса home_street", "type": "integer", "readOnly": true, "example": 1 }, "streetId": { "title": "номер ресурса улицы (streets)", "type": "integer", "example": 1 }, "streetPrefixName": { "title": "тип улицы", "type": "string", "readOnly": true, "example": "улица" }, "streetName": { "title": "наименование улицы", "type": "string", "readOnly": true, "example": "Школьная" }, "homeNumber": { "title": "номер дома", "type": "string", "example": "666А" }, "homeCorp": { "title": "корпус дома", "type": "string", "example": "2" }, "homeFrame": { "title": "строение дома", "type": "string", "example": "8" }, "manageFirmId": { "title": "ресурс УК, с которой договор управления", "type": "integer", "readOnly": true, "example": 1 }, "manageFirmName": { "title": "наименование УК, с которой договор управления", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "manageFirmDate": { "title": "дата начала управления", "type": "string", "readOnly": true, "example": "2024-12-01" }, "cityId": { "title": "ресурс населенного пункта", "type": "integer", "example": 8 }, "cityPrefixName": { "title": "тип населенного пункта", "type": "string", "readOnly": true, "example": "поселок" }, "cityName": { "title": "наименование населенного пункта", "type": "string", "readOnly": true, "example": "Чирки" }, "districtId": { "title": "ресурс административного района города", "type": "integer", "example": 18 }, "districtName": { "title": "наименование адм.района", "type": "string", "readOnly": true, "example": "Индустриальный район" }, "fias": { "title": "ФИАС адреса", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "homeId": { "title": "ресурс дома/здания (homes)", "type": "integer", "example": 8 }, "builtYear": { "title": "год постройки", "type": "integer", "example": 2024 }, "wearOut": { "title": "процент износа", "type": "integer", "example": 50.5 }, "maxFloors": { "title": "максимальная этажность дома", "type": "integer", "example": 10 }, "hasMultiAddress": { "title": "наличие двойного адреса", "type": "boolean", "readOnly": true, "example": false } }, "type": "object" }, "IContractorAddressInfo": { "title": "IContractorAddressInfo - информация по подрядчикам, обслуживающим дом", "description": "Подрядчик по адресу", "properties": { "id": { "title": "ID подрядной организации (firm_to_firm_contractors.contractor_id)", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование подрядчика", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "divisionId": { "title": "ID участка подрядчика, который обслуживаем адрес", "type": "integer", "readOnly": true, "example": 34 }, "divisionName": { "title": "наименование участка подрядчика", "type": "string", "readOnly": true, "example": "Участок на Школьной" } }, "type": "object" }, "IFirmAddressInfo": { "title": "IFirmAddressInfo - информация по УК/РСО, обслуживающим дом", "description": "С кем договора на дом", "properties": { "id": { "title": "ID УК/РСО, обслуживающей дом", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование УК/РСО", "type": "string", "readOnly": true, "example": "ООО Василёк" }, "rank": { "title": "Тип организации", "type": "integer", "readOnly": true, "example": 1 }, "contractors": { "type": "array", "items": { "$ref": "#/components/schemas/IContractorAddressInfo" }, "readOnly": true } }, "type": "object" }, "AllProperties": { "title": "AllProperties - Свойства", "description": "Описание выходных данных модели AllProperty", "properties": { "id": { "type": "integer", "readOnly": true, "example": 5 }, "prop_id": { "description": "краткое обозначение свойства", "type": "string", "example": "accept-calls" }, "prop_name": { "description": "описание свойства", "type": "string", "example": "Принимать обращения от жителей этой организации в ЦУРОГ" }, "prop_values": { "type": "array", "items": { "$ref": "#/components/schemas/AllPropertyValue" } } }, "type": "object" }, "AllProperty": { "title": "AllProperty - Свойства", "description": "Описание выходных данных модели AllProperty", "properties": { "id": { "type": "integer", "readOnly": true, "example": 5 }, "prop_id": { "description": "краткое обозначение свойства", "type": "string", "example": "accept-calls" }, "prop_name": { "description": "описание свойства", "type": "string", "example": "Принимать обращения от жителей этой организации в ЦУРОГ" } }, "type": "object" }, "AllPropertyValue": { "title": "AllPropertyValue - описание выходных данных для модели (AllPropertyValue)", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 5 }, "value": { "description": "разрешенное значение для свойства", "type": "string", "example": "да" }, "description": { "description": "краткое описание этого значения", "type": "string", "example": "Учет работ не ведется" } }, "type": "object" }, "AllPropertyWithValues": { "title": "AllPropertyWithValues - вывод свойства с его значениями", "description": "Описание выходных данных модели AllProperty вместе со списком значений", "properties": { "all_property": { "$ref": "#/components/schemas/AllProperty" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/AllPropertyValue" } } }, "type": "object" }, "AllStreet": { "title": "Streets - данные по улице", "description": "вывод данных по улице для общего списка улиц", "properties": { "id": { "title": "Номер ресурса", "description": "Вывод данных по улице для общего списка улиц.", "type": "integer", "example": 3 }, "name": { "title": "Наименование улицы", "type": "string", "example": "Брянская" }, "fias": { "title": "ФИАС дома", "type": "string|null", "example": null }, "cityId": { "title": "ресурс населенного пункта", "type": "string", "example": 4 }, "cityName": { "title": "Наименование населенного пункта", "type": "string", "example": "Сосновка" }, "cityPrefixId": { "title": "Ресурс типа населенного пункта", "type": "integer", "example": 5 }, "cityPrefixName": { "title": "Тип населенного пункта", "type": "string", "example": "село" }, "cityPrefixShortName": { "title": "Сокращенное наименование нас.пункта", "type": "string", "example": "с." }, "prefixId": { "title": "Ресурс типа улицы", "type": "integer", "example": 6 }, "prefixName": { "title": "Наименование типа улицы", "type": "string", "example": "улица" }, "prefixShortName": { "title": "Сокращенный тип улицы", "type": "string", "example": "ул." } }, "type": "object" }, "ICallQueueCollection": { "title": "Общий список очередей АТС", "description": "Класс для вывода списком данных об очередях", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/ICallQueue" } } }, "type": "object" }, "ICallQueue": { "title": "Просмотр данных об очереди на АТС по приему обращений (ate_queues)", "properties": { "id": { "title": "ID записи ate_queue", "type": "integer", "readOnly": true, "example": 5 }, "queueId": { "title": "ID очереди на АТС в формате UUID", "type": "integer", "readOnly": false, "example": "3d25cd73-27f0-4e93-ab6d-d3d71aadacd4" }, "active": { "title": "Признак - действующая очередь True.", "type": "boolean", "readOnly": false, "example": true }, "note": { "title": "Примечание, описание очереди", "type": "string", "readOnly": false, "example": "Очередь для приема обращений по оператору вывоза мусора" } }, "type": "object" }, "CalendarCollection": { "title": "Календарь", "properties": { "data": { "title": "Массив со списком месяцев года.", "type": "array", "items": { "$ref": "#/components/schemas/IMonth" } } }, "type": "object" }, "IMonth": { "title": "IMonth - месяц календаря", "description": "Один месяц календаря", "properties": { "month": { "title": "номер месяца", "type": "integer", "readOnly": true, "example": 5 }, "days": { "title": "дни месяца", "type": "array", "items": { "$ref": "#/components/schemas/IDay" } } }, "type": "object" }, "IDay": { "title": "IDay - день календаря", "description": "Один день календаря", "properties": { "id": { "title": "id записи из таблицы calendars", "type": "integer", "readOnly": true, "example": 5 }, "dayNumber": { "title": "Число месяца", "type": "integer", "readOnly": true, "example": 5 }, "day": { "title": "День в году", "type": "string", "readOnly": true, "example": "2024-12-31" }, "dayOfWeek": { "title": "День недели (1 - понедельник)", "type": "integer", "readOnly": true, "example": 1 }, "dayStatus": { "title": "Какой день (0-рабочий, 1-выходной, 2-праздничный)", "type": "integer", "example": 0 } }, "type": "object" }, "ICallCollection": { "title": "Общий список обращений", "description": "Информация о списке обращений", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/ICall" } } }, "type": "object" }, "ICallControl": { "title": "Просмотр данных о контроле за обращением (call_controls)", "properties": { "id": { "title": "ID записи call_controls", "type": "integer", "readOnly": true, "example": 425 }, "controlUserId": { "title": "ID пользователя-контролера за кем закреплен контроль", "type": "integer", "readOnly": false, "example": 33 }, "controlUserFio": { "title": "ФИО этого пользователя", "type": "string", "readOnly": true, "example": "Геннадьев Петр Иванович" }, "controlUserName": { "title": "Логин этого пользователя", "type": "string", "readOnly": true, "example": "CityORA10" }, "controlStatusId": { "title": "Текущий статус: 1 на контроле, 0 снят с контроля", "type": "integer", "readOnly": false, "example": 1 }, "createdAt": { "title": "Дата и время установки контроля", "type": "string", "readOnly": true, "example": "2025-10-20 11:12" }, "createdUserId": { "title": "ID пользователя поставившего обращение на контроль пользователю controlUserId", "type": "integer", "readOnly": true, "example": 33 }, "createdUserFio": { "title": "ФИО этого пользователя", "type": "string", "readOnly": true, "example": "Петров Иван Геннадьевич" }, "createdUserName": { "title": "Логин этого пользователя", "type": "string", "readOnly": true, "example": "CityORA11" }, "updatedAt": { "title": "Дата и время снятия контроля", "type": "string", "readOnly": true, "example": "2025-10-25 11:15" }, "updatedUserId": { "title": "ID пользователя снятие обращение с контроля пользователя", "type": "integer", "readOnly": true, "example": 33 }, "updatedUserFio": { "title": "ФИО этого пользователя", "type": "string", "readOnly": true, "example": "Иванов Геннадий Петрович" }, "updatedUserName": { "title": "Логин этого пользователя", "type": "string", "readOnly": true, "example": "CityORA15" } }, "type": "object" }, "ICreatedCall": { "title": "Данные для ввода обращения", "properties": { "id": { "title": "идентификатор обращения", "type": "integer", "readOnly": true, "example": 45 }, "callNumber": { "title": "Номер созданного обращения", "type": "string", "example": "123/456" }, "mainFirmId": { "title": "ID организации, обслуживающей этот дом", "type": "integer", "example": 46 }, "addressId": { "title": "ID адреса, на который пришло обращение", "type": "integer", "example": 48 }, "flatId": { "title": "ID квартиры для обращение (может быть null)", "type": "integer", "example": 148 }, "callerId": { "title": "ID звонящего (обратившегося). Может быть null", "type": "integer", "example": 222 }, "callerFio": { "title": "ФИО звонящего", "type": "string", "example": "Иванов Иван" }, "callerPhone": { "title": "Телефон, для связи с звонящим", "type": "string", "example": "89141111111" }, "callSourceId": { "title": "Код рабочего места пользователя", "type": "integer", "example": 23 }, "callSubTopicId": { "title": "Код под темы обращения", "type": "integer", "example": 23 }, "emergency": { "title": "true - аварийное обращение", "type": "boolean", "example": false }, "deadline": { "title": "крайняя дата исполнения обращения", "type": "string", "example": "2025-01-10" }, "dateIn": { "title": "дата и время создания обращения", "type": "string", "readOnly": true, "example": "2025-01-10 09:00" }, "notes": { "title": "Примечание к обращению", "type": "string", "example": "Что-то тут можно написать" }, "requestId": { "title": "ID записи телефонного разговора из АТС", "type": "string|null", "example": "71b91579-c811-4209-bd7d-2b4534d93cd1" }, "userFolderSetId": { "title": "ID рабочего набора папок", "type": "integer", "example": 44 }, "receiverFolderSetId": { "title": "ID набора папок получателя обращения", "type": "integer", "example": 888 }, "emergencyFolderSetId": { "title": "ID набора папок получателя аварийного обращения", "type": "integer", "example": 688 }, "callReceiverId": { "title": "ID правила приема обращения для всех обращений", "description": "поле ТОЛЬКО для ВВОДА", "type": "integer", "example": 688 }, "emergencyCallReceiverId": { "title": "ID правила приема обращения для аварийных обращений", "description": "поле ТОЛЬКО для ВВОДА", "type": "integer", "example": 689 }, "callToEmergency": { "title": "Действие для заявки при автоматическом обращении: true-в аварийное время уходит в АДС; false|null-в АДС только если заявка аварийная.", "description": "поле ТОЛЬКО для ВВОДА", "type": "boolean|null", "example": null }, "consult": { "title": "Признак консультационного обращения", "type": "boolean", "example": false }, "email": { "$ref": "#/components/schemas/IEmail" }, "callControl": { "$ref": "#/components/schemas/ICallControl" }, "contractors": { "title": "Список получателей обращения ", "type": "array", "items": { "$ref": "#/components/schemas/ICallReceiverSelectable" }, "readOnly": true } }, "type": "object" }, "ICallDoc": { "title": "Просмотр данных о прикрепленном документе (call_docs)", "properties": { "id": { "title": "ID файла, прикрепленного к обращению (call_docs)", "type": "integer", "readOnly": true, "example": 425 }, "callId": { "title": "ID обращения (calls)", "type": "integer", "readOnly": true, "example": 45 }, "filename": { "title": "наименование файла", "type": "string", "readOnly": true, "example": "bill_727010979298_202510.pdf" }, "description": { "title": "описание файла", "type": "string", "readOnly": true, "example": "письменное заявление жителя" }, "createdAt": { "title": "Дата и время загрузки файла", "type": "string", "readOnly": true, "example": "2025-10-20 11:12" }, "userId": { "title": "ID пользователя, загрузившего файл", "type": "integer", "readOnly": true, "example": 33 }, "userFIO": { "title": "ФИО пользователя, загрузившего файл", "type": "string", "readOnly": true, "example": "Иванов Петр Геннадьевич" }, "userName": { "title": "Логин пользователя, загрузившего файл", "type": "string", "readOnly": true, "example": "CityORA15" } }, "type": "object" }, "ICallerMessageCollection": { "title": "Общий список сообщений, отосланных гражданину по обращению", "description": "Список сообщений по обращению", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/ICallerMessage" } } }, "type": "object" }, "ICallerMessage": { "title": "Сообщение гражданину по обращению ", "properties": { "id": { "title": "ID сообщения (call_messages)", "type": "integer", "readOnly": true, "example": 45 }, "callId": { "title": "ID созданного обращения (calls.id)", "type": "integer", "readOnly": true, "example": 111 }, "userMessage": { "title": "Часть сообщения, созданная вручную", "type": "string", "example": "Сантехника сегодня не будет. Тоните" }, "userId": { "title": "ID пользователя сформировавшего сообщение", "type": "integer", "readOnly": true, "example": 33 }, "userName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "CityORA15" }, "userFio": { "title": "ФИО пользователя", "type": "string", "readOnly": true, "example": "Петров И.И." }, "createdAt": { "title": "Дата создания обращения", "type": "string", "readOnly": true, "example": "2026-04-01 13:00:23" }, "sentAt": { "title": "Дата отправки обращения жителю", "type": "string", "readOnly": true, "example": "" }, "sentTo": { "title": "Способ отправки сообщения: \"phone\" | \"sms\" | \"email\". Тут без пояснений", "type": "string", "example": "phone" } }, "type": "object" }, "ICallNote": { "title": "Просмотр примечания по обращению (call_notes)", "properties": { "id": { "title": "ID примечания обращения (call_notes)", "type": "integer", "readOnly": true, "example": 425 }, "callId": { "title": "ID обращения (calls)", "type": "integer", "readOnly": true, "example": 42 }, "note": { "title": "текст обращения", "type": "string", "readOnly": true, "example": "Отключили холодную воду" }, "userId": { "title": "ID пользователя, внесшего обращения", "type": "integer", "readOnly": true, "example": 33 }, "userFIO": { "title": "ФИО пользователя, внесшего обращения", "type": "string", "readOnly": true, "example": "Иванов Петр Геннадьевич" }, "userName": { "title": "Логин пользователя, внесшего обращения", "type": "string", "readOnly": true, "example": "CityORA15" }, "createdAt": { "title": "Дата и время создания примечания", "type": "string", "readOnly": true, "example": "2025-10-20 11:12" }, "updatedAt": { "title": "Дата и время последнего обновления примечания", "type": "string", "readOnly": true, "example": "2025-10-20 11:15" } }, "type": "object" }, "ICallProtocolMessageCollection": { "title": "Общий список созданных сообщений об полученных обращений", "description": "Информация о списке сообщений", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/ICallMessage" } } }, "type": "object" }, "ICallMessage": { "title": "Данные для ввода сообщения о созданном обращении во входящей папке", "properties": { "id": { "title": "ID сообщения (call_protocol_messages)", "type": "integer", "readOnly": true, "example": 45 }, "callId": { "title": "ID созданного обращения (calls.id)", "type": "integer", "example": 111 }, "firmId": { "title": "ID организации, куда было направлено обращение", "type": "integer", "example": 15 }, "divisionId": { "title": "ID подразделения, куда было направлено обращение", "type": "integer", "example": 33 }, "firmUserId": { "title": "ID пользователя в фирме, кому было направлено обращение", "type": "integer", "example": 33 }, "emergency": { "title": "Признак аварийности обращения", "type": "boolean", "example": false }, "topic": { "title": "Тема обращения", "type": "string", "example": "Отсутствие отопления" }, "subtopic": { "title": "Под тема обращения", "type": "string", "example": "Порыв в подъезде" }, "note": { "title": "Самое первое сообщение", "type": "string", "example": "Ой-Ой-Ой, у меня все плохо" }, "address": { "title": "адресная строка", "type": "string", "example": "г.Хабаровск, ул.Запарина д.35, кв.5" }, "callStateIn": { "title": "Дата и время, когда сообщение было создано", "type": "string", "example": "2025-11-01 09:05" }, "whenRead": { "title": "Дата и время, когда прочитано сообщение", "type": "string", "example": "2025-11-01 10:05" }, "readerId": { "title": "ID пользователя, который первый прочитал сообщение", "type": "integer", "example": 11 }, "readerName": { "title": "Login пользователя, который первый прочитал сообщение", "type": "string", "example": "PoberOra02" }, "readerFIO": { "title": "ФИО пользователя, который первый прочитал сообщение", "type": "string", "example": "Иванов Иван Иванович" } }, "type": "object" }, "IRequestState": { "title": "Данные для ввода обращения", "properties": { "id": { "title": "код ресурса (ID записи Request)", "type": "integer", "readOnly": true, "example": 45 }, "requestId": { "title": "код ссылки на голосовое сообщение на АТС", "type": "string", "example": "3d25cd73-27f0-4e93-ab6d-d3d71aadacd4" }, "phoneNumber": { "title": "Номер телефона, с которого звонит житель", "type": "string", "example": "89249995566" }, "requestStatus": { "title": "Состояние текущего звонка", "type": "string", "readOnly": true, "example": "NEW" }, "callId": { "title": "код обращения", "type": "integer", "readOnly": true, "example": 123456 }, "queueId": { "title": "код очереди АТС", "type": "string", "example": "B96CE249-342C-32A9-A4A9-AAA9560814F1" }, "queueName": { "title": "Пояснение очереди", "type": "string", "readOnly": true, "example": "Очередь для приема обращений по ТКО Хабаровске" } }, "type": "object" }, "ICall": { "title": "Данные для ввода обращения", "properties": { "id": { "title": "ID обращения (calls)", "type": "integer", "readOnly": true, "example": 45 }, "number": { "title": "Номер созданного обращения (calls.call_number)", "type": "string", "example": "123-456" }, "dateIn": { "title": "Дата и время созданного обращения", "type": "string", "example": "2025-10-05 19:00" }, "dateOut": { "title": "Дата закрытия обращения, когда обращение считается закрытым", "type": "string", "example": "2025-10-20 20:00" }, "deadline": { "title": "Крайний срок исполнения обращения", "type": "string", "example": "2025-10-19" }, "emergency": { "title": "Признак аварийности обращения", "type": "boolean", "example": false }, "workPlaceId": { "title": "ID рабочего места пользователя", "type": "integer", "example": 65 }, "mainFirmId": { "title": "ID организации, которая отвечает за данный жилищный фонд (УК/РСО)", "type": "integer", "example": 15 }, "mainFirmName": { "title": "Наименование организации, которая отвечает за данный жилищный фонд (УК/РСО)", "type": "string", "example": "ООО \"Васелек\"" }, "mainFirmRank": { "title": "тип организации, которая отвечает за данный жилищный фонд (УК/РСО)", "type": "integer", "example": 1 }, "receiverFirmId": { "title": "ID организации, куда было первоначально направлено обращение", "type": "integer", "example": 17 }, "receiverFirmName": { "title": "Наименование организации, куда было первоначально отправлено обращение", "type": "string", "example": "ООО \"Ромашка\"" }, "receiverDivisionId": { "title": "ID подразделения, куда было первоначально направлено обращение", "type": "integer", "example": 33 }, "receiverDivisionName": { "title": "Наименование этого подразделения", "type": "string", "example": "Участок 5" }, "cityId": { "title": "ID населенного пункта", "type": "integer", "example": 5 }, "cityName": { "title": "наименование населенного пункта", "type": "string", "example": "Нью-Васюки" }, "cityPrefixShortName": { "title": "тип населенного пункта", "type": "string", "example": "г." }, "streetId": { "title": "ID улицы", "type": "integer", "example": 76 }, "streetName": { "title": "наименование улицы", "type": "string", "example": "100 лет г.Владивостоку" }, "streetPrefixShortName": { "title": "префикс улицы", "type": "string", "example": "пр-т " }, "addressId": { "title": "ID адреса (home_street.id)", "type": "integer", "example": 987 }, "homeId": { "title": "ID здания", "type": "integer", "example": 76 }, "homeNumber": { "title": "Номер дома", "type": "string", "example": "12" }, "homeCorp": { "title": "корпус дома", "type": "string", "example": "5" }, "homeFrame": { "title": "строение", "type": "string", "example": null }, "firmHomeId": { "title": "ID договора управления домом", "type": "integer", "example": 76 }, "contractorHomeId": { "title": "ID договора подряда домом", "type": "integer", "example": 76 }, "contractorFirmId": { "title": "ID фирмы-подрядчика", "type": "integer", "example": 76 }, "contractorFirmName": { "title": "Наименование фирмы-подрядчика", "type": "integer", "example": 76 }, "contractorDivisionId": { "title": "ID участка фирмы-подрядчика", "type": "integer", "example": 76 }, "contractorDivisionName": { "title": "Наименование участка фирмы-подрядчика", "type": "integer", "example": 76 }, "flatId": { "title": "ID квартиры", "type": "integer", "example": 123 }, "flatNum": { "title": "Номер квартиры", "type": "string", "example": "56" }, "callerId": { "title": "ID обратившегося", "type": "integer", "example": 54 }, "callerFio": { "title": "ФИО обратившегося", "type": "string", "example": "Ирина Петровна" }, "callerPhone": { "title": "Телефон для связи с обратившимся", "type": "string", "example": "89149141414" }, "topicId": { "title": "ID темы обращения", "type": "integer", "example": 45 }, "topicName": { "title": "Тема обращения", "type": "string", "example": "Отсутствие отопления" }, "subTopicId": { "title": "ID под темы обращения", "type": "integer", "example": 2 }, "subTopicName": { "title": "Под тема обращения", "type": "string", "example": "Порыв в подъезде" }, "callStateDateIn": { "title": "дата помещения обращения в папку", "type": "string", "example": "2026-01-02" }, "callStateDateOut": { "title": "дата перевода обращения из папки", "type": "string", "example": "2026-01-04" }, "registerFirmId": { "title": "ID организации, которая зарегистрировала обращение", "type": "integer", "example": 5 }, "registerFirmName": { "title": "Наименование организации, которая зарегистрировала обращение", "type": "string", "example": "ИП Чебурашка" }, "registerDivisionId": { "title": "ID подразделения, которое зарегистрировало обращение", "type": "integer", "example": null }, "registerDivisionName": { "title": "Наименование подразделения, которое зарегистрировало обращение", "type": "string", "example": null }, "registerUserId": { "title": "ID пользователя, который принял обращение", "type": "integer", "example": 99 }, "registerUserFio": { "title": "ФИО этого пользователя", "type": "string", "example": "Петров Пьер" }, "registerUserName": { "title": "Логин этого пользователя", "type": "string", "example": "Petrov" }, "haveDocs": { "title": "для Desktop приложения: есть ли у обращения прикрепленные документы", "type": "boolean", "example": false }, "currFolderCalls": { "type": "array", "items": { "$ref": "#/components/schemas/ICurrFolderCall" } }, "controls": { "type": "array", "items": { "$ref": "#/components/schemas/ICallControl" }, "readOnly": true }, "callNotes": { "title": "список примечаний. Только для мобильного приложения, при определенных условиях", "type": "array", "items": { "$ref": "#/components/schemas/ICallNote" }, "readOnly": true }, "callDocs": { "title": "Список вложенных документов. Только для мобильного приложения, при определенных условиях.", "type": "array", "items": { "$ref": "#/components/schemas/ICallDoc" }, "readOnly": true } }, "type": "object" }, "IExtendedCallState": { "title": "Просмотр изменений движения обращения (call_states)", "properties": { "id": { "title": "ID движения обращения (call_states)", "type": "integer", "readOnly": true, "example": 425 }, "callId": { "title": "ID записи обращения (call_states.call_id)", "type": "integer", "readOnly": true, "example": 1425 }, "createdAt": { "title": "Дата и время создания состояния", "type": "string", "readOnly": true, "example": "2025-10-01 05:45" }, "deadline": { "title": "Дата предельного нахождения в текущей папке", "type": "string", "readOnly": false, "example": "2025-10-05" }, "prevId": { "title": "ID предыдущей записи состояния обращения (call_states.previous_call_state_id)", "type": "integer", "readOnly": true, "example": 145 }, "dateOut": { "title": "Дата и время, когда обращение было перемещено из этой папки", "type": "string", "readOnly": true, "example": "2025-10-06 05:45" }, "okTransferring": { "title": "true: из текущего состояния обращение можно переводить в другие состояния", "type": "boolean", "readOnly": true, "example": true }, "note": { "title": "Примечание, внесенное к данному состоянию", "type": "string", "example": "Это их обращение" }, "action_after": { "title": "Действие с обращением в родительской папке. Варианты: “NONE”, “CHECK”, “FINAL\"", "type": "string", "readOnly": false, "example": "FINAL" }, "userMessage": { "title": "сообщение жителю для обратного обзвона", "type": "string", "writeOnly": true, "example": "" }, "prevFolderId": { "title": "ID предыдущей папки", "type": "integer", "readOnly": true, "example": 424 }, "prevFolderName": { "title": "Наименование предыдущей папки", "type": "string", "readOnly": true, "example": "Входящие" }, "prevFolderType": { "title": "Тип предыдущей папки", "type": "string", "readOnly": true, "example": "START" }, "prevFolderSetId": { "title": "ID предыдущего набора папок", "type": "integer", "readOnly": true, "example": 44 }, "prevFolderSetFirmRank": { "title": "Тип организации, в которой обращение находилось до этого", "type": "integer", "readOnly": true, "example": 3 }, "prevFolderFirmId": { "title": "ID фирмы-владельца папки", "type": "integer", "readOnly": true, "example": 4 }, "prevFolderFirmName": { "title": "Наименование этой фирмы", "type": "string", "readOnly": true, "example": "ООО \"Ромашка\"" }, "prevFolderDivisionId": { "title": "ID участка фирмы-владельца папки", "type": "integer", "readOnly": true, "example": 14 }, "prevFolderDivisionName": { "title": "Наименование этого участка", "type": "string", "readOnly": true, "example": "участок 1" }, "prevFolderSetFirmUserId": { "title": "ID набора папок пользователя предыдущего состояния", "type": "integer", "readOnly": true, "example": 16 }, "prevFolderUserId": { "title": "ID пользователя-владельца папки", "type": "integer", "readOnly": true, "example": 6 }, "prevFolderUserName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "PoberOra02" }, "prevFolderUserFio": { "title": "ФИО пользователя-владельца папки", "type": "string", "readOnly": true, "example": "Петров Иван Иванович" }, "currFolderId": { "title": "ID папки, к которой состояние обращения присоединено ", "type": "integer", "readOnly": false, "example": 411 }, "currFolderName": { "title": "Наименование этой папки", "type": "string", "readOnly": true, "example": "Выполнено" }, "currFolderType": { "title": "тип папки", "type": "string", "readOnly": true, "example": "START" }, "currFolderSetId": { "title": "ID набора папки, в которому состояние обращения присоединено", "type": "integer", "readOnly": true, "example": 44 }, "currFolderSetFirmRank": { "title": "Тип организации, в которой обращение находится сейчас", "type": "integer", "readOnly": true, "example": 2 }, "currFolderSetFirmId": { "title": "ID фирмы-владельца набора папки", "type": "integer", "readOnly": false, "example": 487 }, "currFolderSetFirmName": { "title": "Наименование фирмы-владельца", "type": "string", "readOnly": true, "example": "ООО \"Васелёк\"" }, "currFolderSetDivisionId": { "title": "ID подразделения фирмы-владельца набора папки", "type": "integer", "readOnly": false, "example": 487 }, "currFolderSetDivisionName": { "title": "Наименование подразделения фирмы-владельца", "type": "string", "readOnly": true, "example": "Участок М" }, "currFolderSetFirmUserId": { "title": "ID набора папок пользователя текущего состояния", "type": "integer", "readOnly": false, "example": 36 }, "currFolderSetUserId": { "title": "ID пользователя-владельца набора папок", "type": "integer", "readOnly": true, "example": 6 }, "currFolderSetUserName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "PoberOra02" }, "currFolderSetUserFio": { "title": "ФИО пользователя-владельца набора папок", "type": "string", "readOnly": true, "example": "Петров Иван Иванович" }, "userId": { "title": "ID пользователя поместившего обращение в текущую папку", "type": "integer", "readOnly": true, "example": 6 }, "userName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "PoberOra02" }, "userFio": { "title": "ФИО пользователя поместившего обращение в текущую папку", "type": "string", "readOnly": true, "example": "Петров Иван Иванович" }, "phones": { "title": "список телефонов организации, у которой это состояние находится", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" }, "readOnly": true } }, "type": "object" }, "ICallView": { "title": "Подробный просмотр обращения жителя (calls)", "properties": { "id": { "title": "ID обращения (calls)", "type": "integer", "readOnly": true, "example": 45 }, "number": { "title": "Номер созданного обращения (calls.call_number)", "type": "string", "example": "123-456" }, "dateIn": { "title": "Дата и время созданного обращения", "type": "string", "example": "2025-10-05 19:00" }, "dateOut": { "title": "Дата закрытия обращения, когда обращение считается закрытым", "type": "string", "example": "2025-10-20" }, "emergency": { "title": "Признак аварийности обращения", "type": "boolean", "example": false }, "deadline": { "title": "предельная дата исполнения обращения", "type": "string", "example": false }, "workPlaceId": { "title": "ID рабочего места пользователя", "type": "integer", "example": 65 }, "workPlaceShortName": { "title": "Наименование рабочего места", "type": "string", "example": "Рабочее место работника УК" }, "topicId": { "title": "ID темы обращения", "type": "integer", "example": 45 }, "topicName": { "title": "Тема обращения", "type": "string", "example": "Отсутствие отопления" }, "subTopicId": { "title": "ID под темы обращения", "type": "integer", "example": 2 }, "subTopicName": { "title": "Под тема обращения", "type": "string", "example": "Порыв в подъезде" }, "requestId": { "title": "Ссылка на уникальный код телефонного разговора", "type": "string|null", "example": "71b91579-c811-4209-bd7d-2b4534d93cd1" }, "cityId": { "title": "ID населенного пункта", "type": "integer", "example": 5 }, "cityName": { "title": "наименование населенного пункта", "type": "string", "example": "Нью-Васюки" }, "cityPrefixShortName": { "title": "тип населенного пункта", "type": "string", "example": "г." }, "streetId": { "title": "ID улицы", "type": "integer", "example": 76 }, "streetName": { "title": "наименование улицы", "type": "string", "example": "100 лет г.Владивостоку" }, "streetPrefixShortName": { "title": "префикс улицы", "type": "string", "example": "пр-т " }, "addressId": { "title": "ID адреса (home_street.id)", "type": "integer", "example": 987 }, "homeId": { "title": "ID здания", "type": "integer", "example": 76 }, "homeNumber": { "title": "Номер дома", "type": "string", "example": "12" }, "homeCorp": { "title": "корпус дома", "type": "string", "example": "5" }, "homeFrame": { "title": "строение", "type": "string", "example": null }, "flatId": { "title": "ID квартиры", "type": "integer", "example": 123 }, "flatNum": { "title": "Номер квартиры", "type": "string", "example": "56" }, "flatFloor": { "title": "Этаж квартиры", "type": "integer", "example": "4" }, "entranceId": { "title": "ID подъезда", "type": "integer", "example": 45 }, "entranceNom": { "title": "Номер подъезда", "type": "string", "example": "2" }, "entranceIntercom": { "title": "Код домофона", "type": "string", "example": null }, "residentialFlat": { "title": "признак нежилого помещения. true - нежилье", "type": "boolean", "example": true }, "residentialName": { "title": "наименование юридического лица", "type": "string", "example": "ООО \"Ромашка\"" }, "callerId": { "title": "ID обратившегося", "type": "integer", "example": 54 }, "callerFio": { "title": "ФИО обратившегося", "type": "string", "example": "Ирина Петровна" }, "callerPhone": { "title": "Телефон для связи с обратившимся", "type": "string", "example": "89149141414" }, "mainFirmId": { "title": "ID организации, отвечающей, в конечной итоге, за обращение", "type": "integer", "example": 566 }, "mainFirmName": { "title": "Наименование этой организации.", "type": "string", "example": "ООО \"Ромашка\"" }, "mainFirmRank": { "title": "Тип организации", "type": "string", "example": "УК/РСО" }, "acceptorFirmId": { "title": "ID организации, в которую житель дозвонился", "type": "integer", "example": 145 }, "acceptorFirmName": { "title": "Наименование принявшей организации", "type": "string", "example": "ООО \"Василек\"" }, "acceptorDivisionId": { "title": "ID участка организации, в который житель дозвонился", "type": "integer", "example": 146 }, "acceptorDivisionName": { "title": "Наименование этого участка", "type": "string", "example": "Участок 8" }, "receiverFirmId": { "title": "ID организации, куда обращение было отправлена при регистрации", "type": "integer", "example": 147 }, "receiverFirmName": { "title": "Наименование этой организации", "type": "string", "example": "ООО \"Лилия\"" }, "receiverDivisionId": { "title": "ID участка, организации, куда обращение было отправлено при регистрации", "type": "integer", "example": 148 }, "receiverDivisionName": { "title": "Наименование участка", "type": "string", "example": "ремонтное подразделение №5" }, "currFolderId": { "title": "ID папки, где обращение находится сейчас", "type": "integer", "example": 4 }, "currFolderName": { "title": "Наименование папки, где обращение находится сейчас", "type": "string", "example": "Отдано в работу слесарю" }, "currFolderType": { "title": "Тип папки, где сейчас находится обращение", "type": "string", "example": "START" }, "currUserId": { "title": "ID пользователя, у которого находится обращение на исполнении", "type": "integer", "example": 99 }, "currUserFio": { "title": "ФИО этого пользователя", "type": "string", "example": "Петров Пьер" }, "currFirmId": { "title": "ID организации, в которой находится обращение на исполнении", "type": "integer", "example": 5 }, "currFirmName": { "title": "Наименование организации, в которой находится на исполнении в данный момент", "type": "string", "example": "ИП Чебурашка" }, "currDivisionId": { "title": "ID подразделения, в котором обращение находится в данный момент", "type": "integer", "example": null }, "consult": { "title": "Признак консультационного обращения", "type": "boolean", "example": false }, "currDivisionName": { "title": "Наименование подразделения, в котором находится обращение", "type": "string", "example": null }, "callNotes": { "type": "array", "items": { "$ref": "#/components/schemas/ICallNote" }, "readOnly": true }, "callStates": { "type": "array", "items": { "$ref": "#/components/schemas/IExtendedCallState" }, "readOnly": true }, "callDocs": { "type": "array", "items": { "$ref": "#/components/schemas/ICallDoc" }, "readOnly": true }, "callControls": { "type": "array", "items": { "$ref": "#/components/schemas/ICallControl" }, "readOnly": true }, "magazine": { "$ref": "#/components/schemas/IMagazine" } }, "type": "object" }, "IControlStatusCall": { "title": "Состояния проверки обращения", "properties": { "id": { "title": "идентификатор строки в таблице", "type": "string", "readOnly": true, "example": "Входящие" }, "name": { "title": "Наименование состояния проверки обращения", "type": "string", "example": "Входящие" }, "description": { "title": "Описание состояния проверки обращения", "type": "string", "example": "Развёрнутое описание" } }, "type": "object" }, "ICurrFolderCall": { "title": "текущее состояние обращения в наборе папок", "properties": { "id": { "title": "ID записи call_states", "type": "integer", "readOnly": true, "example": 45 }, "dateIn": { "title": "дата, когда обращение было помещено в эту папку", "type": "string", "example": "2025-10-05 19:00" }, "dateOut": { "title": "дата, когда обращение было перемещено из этой папки", "type": "string", "example": "2025-10-20 20:00" }, "deadline": { "title": "дата, по которую обращение может находиться в папкке", "type": "string", "example": "2025-10-19" }, "folderId": { "title": "ID папки (folders.id)", "type": "integer", "example": 17 }, "folderName": { "title": "наименование папки (folders.name)", "type": "string", "example": "Завершено" }, "folderType": { "title": "тип папки (master_folders.type)", "type": "string", "example": "FINAL" }, "firmId": { "title": "ID организации (firms.id)", "type": "integer", "example": 5 }, "firmName": { "title": "name организации – владельца (firms.name)", "type": "string", "example": "ИП Чебурашка" }, "divisionId": { "title": "ID участка (divisions.id)", "type": "integer", "example": null }, "divisionName": { "title": "наименование участка (divisions.name)", "type": "string", "example": null }, "userId": { "title": "ID пользователя", "type": "integer", "example": 99 }, "userFio": { "title": "ФИО этого пользователя", "type": "string", "example": "Петров Пьер" }, "userName": { "title": "Логин этого пользователя", "type": "string", "example": "Petrov" } }, "type": "object" }, "ICurrentFolderState": { "title": "Состояние папок", "properties": { "folderName": { "title": "имя папки", "type": "string", "readOnly": true, "example": "Входящие" }, "folderPosition": { "title": "позиция папки в отчетах", "type": "integer", "readOnly": true, "example": 5 }, "folderType": { "title": "Тип текущей папки", "type": "string", "readOnly": true, "example": "START" }, "callsInList": { "title": "кол-во неотработанных обращений в папке", "type": "integer", "readOnly": true, "example": 15 }, "callsOutOfTime": { "title": "из них просрочено", "type": "integer", "readOnly": true, "example": 3 } }, "type": "object" }, "ICurrentSetState": { "title": "Данные о наборе папок", "description": "Информация о наборах папок с данными об обращениях", "properties": { "folderSetId": { "title": "ID набора папок", "type": "integer", "readOnly": true, "example": 1 }, "folderSetValid": { "title": "Признак действующих папок", "type": "boolean", "readOnly": true, "example": true }, "firmId": { "title": "id организации", "type": "integer", "readOnly": true, "example": 1 }, "firmName": { "title": "наименование организации", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "firmRank": { "title": "Код типа организации", "type": "integer", "readOnly": true, "example": 1 }, "firmRankName": { "title": "Наименование типа организации", "type": "string", "readOnly": true, "example": "Управляющая организация" }, "divisionId": { "title": "код подразделения", "type": "integer", "readOnly": true, "example": 10 }, "divisionName": { "title": "Наименование подразделения", "type": "string", "readOnly": true, "example": "ПТО" }, "employeeId": { "title": "ID работника", "type": "integer", "readOnly": true, "example": 15 }, "employeeName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "PoberOra12" }, "employeeFio": { "title": "ФИО пользователя", "type": "string", "readOnly": true, "example": "Иванов И.И." }, "folders": { "$ref": "#/components/schemas/IFolder" }, "folderStates": { "$ref": "#/components/schemas/ICurrentFolderState" } }, "type": "object" }, "IFolderCallCollection": { "title": "Список обращений по папке", "description": "Информация о списке обращений, находящихся в конкретной папке", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/IFolderCall" } } }, "type": "object" }, "IFolderCall": { "title": "Вывод списка обращений, находящихся в конкретной папке", "description": "Информация об обращениях, находящихся в конкретной папке", "properties": { "id": { "title": "id записи в таблице call_states", "type": "integer", "readOnly": true, "example": 1 }, "callId": { "title": "id записи в таблице calls", "type": "integer", "readOnly": true, "example": 1 }, "callNumber": { "title": "номер обращения(calls.call_number)", "type": "string", "readOnly": true, "example": "16-4432" }, "callDateIn": { "title": "Дата и время создания обращения (calls.created_at)", "type": "string", "readOnly": true, "example": "2025-11-01 08:00" }, "callStateDateIn": { "title": "Дата и время попадания обращения в папку (call_states.created_at)", "type": "string", "readOnly": true, "example": "2025-11-01 09:00" }, "callStateDateOut": { "title": " Дата, когда обращение вышло из папки(call_states.date_out)", "type": "string", "readOnly": true, "example": "2025-11-05 10:00" }, "callDateOut": { "title": "Дата, когда работа с обращением считается законченной(calls.date_out)", "type": "string", "readOnly": true, "example": "2025-11-15 11:00" }, "callDeadLine": { "title": "Крайний срок выполнения обращения (calls.deadLine)", "type": "string", "readOnly": true, "example": "2025-11-05" }, "callStateDeadLine": { "title": "Предельная дата до которой обращение должно быть отработано (т.е. переведено в любую папку “финального” типа) в ЭТОМ наборе папок (call_states.deadline)", "type": "string", "readOnly": true, "example": "2025-11-04" }, "emergency": { "title": "Признак аварийности", "type": "boolean", "readOnly": true, "example": true }, "cityId": { "title": "id населенного пункта", "type": "integer", "readOnly": true, "example": 1 }, "cityName": { "title": "название населенного пункта", "type": "string", "readOnly": true, "example": "Хабаровск" }, "cityPrefixShortName": { "title": "сокращенное название типа населенного пункта", "type": "string", "readOnly": true, "example": "г." }, "streetId": { "title": "id улицы", "type": "integer", "readOnly": true, "example": 1 }, "streetName": { "title": "название улицы", "type": "string", "readOnly": true, "example": "Куросава" }, "streetPrefixShortName": { "title": "сокращенное название префикса улицы", "type": "string", "readOnly": true, "example": "ул." }, "addressId": { "title": "id адреса (обращение “цепляется” только к той записи home_streets, которая была указана жителем при подаче обращения)", "type": "integer", "readOnly": true, "example": 1 }, "homeId": { "title": "id дома", "type": "integer", "readOnly": true, "example": 1 }, "homeNumber": { "title": "номер дома", "type": "string", "readOnly": true, "example": "1" }, "homeCorp": { "title": "корпус дома", "type": "string", "readOnly": true, "example": "A" }, "homeFrame": { "title": "строение", "type": "string", "readOnly": true, "example": null }, "flatId": { "title": "id помещения", "type": "integer", "readOnly": true, "example": 1 }, "flatNum": { "title": "номер помещения", "type": "string", "readOnly": true, "example": "1" }, "callerId": { "title": "id строки callers - дозвонившиеся", "type": "integer", "readOnly": true, "example": 1 }, "callerFio": { "title": "ФИО дозвонившегося", "type": "string", "readOnly": true, "example": "Петров Петр Петрович" }, "callerPhone": { "title": "Телефон дозвонившегося", "type": "string", "readOnly": true, "example": "89241234343" }, "topicId": { "title": "id темы обращения", "type": "integer", "readOnly": true, "example": 1 }, "topicName": { "title": "тема обращения", "type": "string", "readOnly": true, "example": "Отсутствие ГВС" }, "subTopicId": { "title": "id подтемы", "type": "integer", "readOnly": true, "example": 1 }, "subTopicName": { "title": "подтема обращения", "type": "string", "readOnly": true, "example": "не капает вода из крана" }, "currFolderId": { "title": "id папки этого же набора папок, в которой обращение находится сейчас", "type": "integer", "readOnly": true, "example": 1 }, "currFolderName": { "title": "наименование папки, в которой обращение находится сейчас", "type": "string", "readOnly": true, "example": "отходящие" }, "currFolderType": { "title": "тип папки, в которой находится обращение в настоящий момент", "type": "integer", "readOnly": true, "example": 1 } }, "type": "object" }, "IPreviewRecentCalls": { "title": "Предпросмотр данных о последних обращениях", "description": "", "properties": { "id": { "title": "номер ресурса папки", "type": "integer", "readOnly": true, "example": 1 }, "callId": { "title": "ID самого обращения", "type": "integer", "readOnly": true, "example": 34 }, "cityPrefix": { "title": "Тип населенного пункта", "type": "string", "example": "г." }, "cityName": { "title": "Наименование нас.пункта", "type": "string", "example": "Хабаровск" }, "streetPrefix": { "title": "Тип улицы", "type": "string", "readOnly": true, "example": "ул." }, "streetName": { "title": "Наименование улицы", "type": "string", "example": "Ворошилова" }, "homeNumber": { "title": "Номер дома", "type": "string", "example": "48" }, "homeCorp": { "title": "Корпус", "type": "string", "example": "Б" }, "homeBuilding": { "title": "Строение", "type": "string", "example": null }, "flatNumber": { "title": "номер дома", "type": "string", "example": "56" }, "created": { "title": "Дата создания обращения", "type": "string", "example": "2025-10-01 16:54" }, "phone": { "title": "Телефон обратившегося", "type": "string", "example": "89247783132" }, "emergency": { "title": "Признак аварийности", "type": "boolean", "example": false } }, "type": "object" }, "IRequestCollection": { "title": "Общий список обращений", "description": "Информация о списке обращений", "properties": { "data": { "title": "Список зарегистрированных телефонных звонков", "type": "array", "items": { "$ref": "#/components/schemas/IRequest" } } }, "type": "object" }, "IRequest": { "title": "Ресурс для вывода данных о поступившем звонке", "properties": { "id": { "title": "код ресурса (ID записи Request)", "type": "integer", "readOnly": true, "example": 45 }, "requestId": { "title": "код ссылки на голосовое сообщение на АТС", "type": "string", "readOnly": true, "example": "3d25cd73-27f0-4e93-ab6d-d3d71aadacd4" }, "createDate": { "title": "Дата создания сообщения", "type": "string", "readOnly": true, "example": "2025-10-05 19:00" }, "userId": { "title": "id пользователя, принявшего звонок", "type": "integer", "readOnly": true, "example": 123 }, "userFio": { "title": "ФИО пользователя, принявшего звонок", "type": "string", "readOnly": true, "example": "Иванов П.П." }, "phoneNumber": { "title": "Номер телефона, с которого звонит житель", "type": "string", "readOnly": true, "example": "89249995566" }, "state": { "title": "Статус звонка", "type": "string", "readOnly": true, "example": "NEW" }, "callId": { "title": "код обращения", "type": "integer", "readOnly": true, "example": 123456 }, "queueId": { "title": "код очереди АТС", "type": "string", "readOnly": true, "example": "B96CE249-342C-32A9-A4A9-AAA9560814F1" }, "queueName": { "title": "Пояснение очереди", "type": "string", "readOnly": true, "example": "Очередь для приема обращений по ТКО Хабаровске" } }, "type": "object" }, "ICaller": { "title": "Список звонящего/обратившегося", "description": "Выдаем список звонящих", "properties": { "id": { "title": "ID обратившегося", "type": "integer", "readOnly": true, "example": 1 }, "fio": { "title": "ФИО обратившегося", "type": "string", "readOnly": true, "example": "Иванов Арсен Семенович" }, "phone": { "title": "Телефон", "type": "string", "readOnly": true, "example": "89099090909" }, "cityId": { "title": "ID населенного пункта", "type": "integer", "readOnly": true, "example": 3 }, "streetId": { "title": "ID улицы", "type": "integer", "readOnly": true, "example": 33 }, "addressId": { "title": "ID код адреса (home_street)", "type": "integer", "readOnly": true, "example": 55 }, "flatId": { "title": "ID квартиры", "type": "integer", "readOnly": true, "example": 345 } }, "type": "object" }, "CityHist": { "title": "CityHist - архив изменений данных по населённому пункту", "description": " ", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "city_type": { "description": "тип населенного пункта", "type": "string", "example": "город" }, "city_name": { "description": "наименование населенного пункта", "type": "string", "example": "Хабаровск" }, "city_short_name": { "description": "Сокращенное наименование нас.пункта", "type": "string", "example": "г.Хабаровск" }, "city_okato": { "description": "Код ОКАТО", "type": "string", "example": "08 224" }, "city_oktmo": { "description": "Код ОКТМО", "type": "string", "example": "08 624" }, "city_fias": { "description": "код фиас", "type": "string", "example": "9f905365-dbef-425a-9724-3db4e18dc7d9" }, "region_id": { "description": "идентификатор субъекта РФ, в котором расположен населённый пункт", "type": "string", "example": "5657" }, "outside_id": { "description": "идентификатор административного района субъекта РФ, в котором расположен населённый пункт", "type": "string", "example": "98567" }, "updated": { "description": "Дата, когда были сделаны изменения", "type": "string", "example": "2024-08-05" }, "user_id": { "description": "ФИО пользователя, сделавшего изменения", "type": "string", "example": "Иванов И.И." } }, "type": "object" }, "City": { "title": "City - описание населенного пункта", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "наименование населенного пункта", "type": "string", "example": "Хабаровск" }, "regionId": { "description": "номер ресурса субъект РФ, куда входит нас.пункт", "type": "integer", "example": "номер ресурса субъект РФ, куда входит нас.пункт" }, "regionName": { "description": "наименование субъекта РФ, куда входит нас.пункт", "type": "string", "example": "Хабаровский край" }, "regionShortName": { "description": "краткое наименование субъекта РФ, куда входит нас.пункт", "type": "string", "example": "ЕАО " }, "outsideId": { "description": "Если нас.пункт входит в адм.район, то тут будет код его ресурса", "type": "integer", "example": 2 }, "outsideName": { "description": "Если нас.пункт входит в адм.район, то тут будет его наименование", "type": "string", "example": "Хабаровский р-он" }, "typeId": { "description": "код типа населенного пункта", "type": "integer", "example": 1 }, "typeName": { "description": "тип населенного пункта", "type": "string", "example": "город" }, "typeShortName": { "description": "сокращенное именование типа населенного пункта", "type": "string", "example": "г." }, "okato": { "description": "Код ОКАТО", "type": "string", "example": "08 224" }, "oktmo": { "description": "Код ОКТМО", "type": "string", "example": "08 624" }, "fias": { "description": "код фиас", "type": "string", "example": "9f905365-dbef-425a-9724-3db4e18dc7d9" } }, "type": "object" }, "CityType": { "title": "CityType - описание модели типа населенных пунктов (CityType)", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "shortName": { "description": "сокращенное (по КЛАДРу) наименование нас.пункта с точкой в конце, если надо", "type": "string", "example": "с." }, "name": { "description": "наименование типа населенного пункта", "type": "string", "example": "село" } }, "type": "object" }, "District": { "title": "District - описание адм.района.", "description": " это может быть как район города, так и район субъекта", "properties": { "id": { "type": "", "readOnly": true, "example": 1 }, "districtName": { "description": "Полное наименование района города", "type": "string", "example": "район им.Лазо" }, "districtCode": { "description": "цифровой код для внутреннего использования. Можно не указывать", "type": "string", "example": "ИН" }, "districtOkato": { "description": "Код ОКАТО", "type": "string", "example": "08 224" }, "histKey": { "description": "уникальный ключ для поиска архива", "type": "uuid", "example": "09839042830-90283049284-2874" }, "userFio": { "description": "ФИО пользователя, которые это все ввел", "type": "string", "example": "Иванов" } }, "type": "object" }, "DivisionHist": { "title": "DivisionHist - описание модели архива изменений подразделения (Division)", "description": "", "properties": { "id": { "description": "Class DivisionHistResource - вывод данных по архиву изменений подразделения", "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Наименование подразделения", "type": "string", "example": "ПТО" }, "emrg": { "description": "true - аварийная служба, false - нет", "type": "boolean", "example": false }, "histKey": { "description": "Ключ записи", "type": "string", "example": "38409249-09908308942-f908309ed" }, "updateDate": { "description": "когда внесены изменения", "type": "string", "example": "2021-02-01 12:45:00" }, "userFIO": { "description": "фио пользователя, который внес эти данные", "type": "string", "example": "Петров И.И." }, "archDate": { "description": "когда данные перенесены в архив", "type": "string", "example": "2021-04-01 12:45:00" } }, "type": "object" }, "IDivision": { "title": "Division - Подразделение фирмы", "description": "описание модели подразделение (Division)", "properties": { "id": { "description": "Class DivisionResource - вывод данных модели Division", "type": "integer", "example": 5 }, "name": { "description": "Наименование подразделения", "type": "string", "example": "ПТО" }, "emrg": { "description": "true - аварийная служба, false - нет", "type": "boolean", "example": false }, "firm_id": { "description": "id головной организации (firms)", "type": "integer", "example": 3 }, "phones": { "title": "Телефоны подразделения/участка", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } } }, "type": "object" }, "entrancesCollection": { "title": "Получение списка подъездов дома", "properties": { "data": { "title": "Массив со списком подъездов дома", "description": "Получение списка подъездов", "type": "array", "items": { "$ref": "#/components/schemas/Entrance" } } }, "type": "object" }, "Entrance": { "title": "Подъезд дома", "description": "Вывод информации о подъезде дома", "properties": { "id": { "title": "ID", "description": "ID", "type": "integer", "readOnly": true, "example": 1 }, "nom": { "title": "номер подъезда ", "type": "string", "example": "1", "nullable": false }, "intercom": { "title": "код домофона подъезда ", "type": "string", "example": "3458", "nullable": true }, "floors": { "title": "этажность", "type": "integer", "example": 1, "nullable": true }, "trashPipe": { "title": "наличие мусоропровода", "type": "boolean", "example": false, "nullable": true }, "liftsAmount": { "title": "количество лифтов в подъезде", "type": "integer", "example": 0, "nullable": true }, "homeId": { "title": "ссылка на дом, которому принадлежит подъезд", "type": "integer", "readOnly": true, "example": 5 } }, "type": "object" }, "FirmHist": { "title": "FirmHist - описание модели Фирма (Firm)", "description": "описание модели Фирма (Firm)", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Наименование юр.лица", "type": "string", "example": "ООО Ромашка" }, "rank": { "description": "Тип организации. Значение из таблица firm_types", "type": "integer", "example": 7 }, "public_email": { "description": "E-mail для приема обращений", "type": "string", "example": "12345@mail.ru" }, "use_call_service": { "description": "Сервис “обращения жителей”", "type": "string", "example": "да" }, "accept_calls": { "description": "Прием и регистрация обращений в ЦУРОГ", "type": "string", "example": "да" }, "do_callback": { "description": "обратный обзвон выполненных обращений", "type": "string", "example": "нет" }, "san_service": { "description": "учет работ по санитарии", "type": "string", "example": "нет" }, "tech_service": { "description": "учет работ по ТО", "type": "string", "example": "нет" }, "lift_service": { "description": "учет работ по обслуживанию лифтов", "type": "string", "example": "нет" }, "user_name": { "description": "Кто внес изменения", "type": "string", "example": "Павлов Ю.С." }, "update_date": { "description": "когда внесены изменения", "type": "string", "example": "2021-02-01 12:45:00" }, "arch_date": { "description": "когда данные перенесены в архив", "type": "string", "example": "2021-04-01 12:45:00" } }, "type": "object" }, "IContractorDivision": { "title": "IContractorDivision", "description": "Получение списка подразделений подрядчика, обслуживающих дом", "properties": { "divisionHomeId": { "title": "Идентификатор связи между договором подряда по дому и подразделением подрядчика.", "type": "integer", "example": 3 }, "divisionId": { "title": "Id подразделения подрядчика", "type": "integer", "readOnly": false, "example": 4 }, "divisionName": { "title": "Наименование подрядчика.", "type": "string", "readOnly": true, "example": "Согласие" }, "phones": { "title": "Телефоны Участка", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } } }, "type": "object" }, "HomeContractor": { "title": "IHomeContractor", "description": "Получение списка домов организации", "properties": { "contractorFirmId": { "title": "id ресурса подрядчика (firms.id)", "description": "Вывод данных по подрядчикам, обслуживаемым дом", "type": "integer", "readOnly": true, "example": 3 }, "contractorFirmName": { "title": "Наименование подрядчика", "type": "string", "readOnly": true, "example": "ООО \"Подряд\"" }, "ffContractId": { "title": "id договора подряда", "type": "integer", "example": 4 }, "ffContractStateDate": { "title": "Дата начала договора подряда", "type": "string", "readOnly": true, "example": "2020-01-01" }, "ffContractEndDate": { "title": "Дата окончания договора подряда", "type": "string", "readOnly": true, "example": null }, "contractHomeId": { "title": "Id записи связи договора управления дома с договором подряда", "description": "При создании не нужен", "type": "integer", "example": 32 }, "contractHomeStartDate": { "title": "Дата начала обслуживания дома подрядчиком", "description": "При создании не нужен", "type": "string", "example": "2019-01-01" }, "contractHomeEndDate": { "title": "Дата окончания обслуживания дома подрядчиком", "description": "При создании не нужен", "type": "string", "example": null }, "divisionId": { "title": "Id участка подрядчика, который обслуживает дом", "type": "integer", "example": 4 }, "divisionName": { "title": "Наименование подрядчика, обслуживающий дом", "type": "string", "readOnly": true, "example": "ЖЭУ-5" }, "phones": { "title": "Телефоны подрядчика", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } } }, "type": "object" }, "ContractorHomesCollection": { "title": "Просмотр списка домов, обслуживаемых организацией", "properties": { "data": { "title": "массив со списком домов", "type": "array", "items": { "$ref": "#/components/schemas/ContractorHomesResource" } } }, "type": "object" }, "ContractorHomesResource": { "title": "IContractorHomes", "description": "Получение списка домов подрядчика", "properties": { "id": { "title": "Идентификатор связи между договором управления(ресурсоснабжения) по дому и договором подряда между организациями.", "description": "Вывод списка домов, обслуживаемых подрядчикам", "type": "integer", "example": 3 }, "startDate": { "title": "Дата начала действия по обслуживанию дома подрядчиком.", "type": "string", "readOnly": false, "example": "2020-01-01" }, "endDate": { "title": "Дата окончания действия по обслуживанию дома подрядчиком.", "type": "string", "readOnly": false, "example": null }, "ffContractId": { "title": "Id договора подряда.", "type": "integer", "readOnly": false, "example": 4 }, "ffCustomerFirmId": { "title": "Id организации.", "type": "integer", "readOnly": true, "example": 4 }, "ffCustomerFirmName": { "title": "Наименование организации.", "type": "string", "readOnly": true, "example": "Согласие" }, "ffStartDate": { "title": "Дата начала договора подряда.", "type": "string", "readOnly": true, "example": "2020-01-01" }, "ffEndDate": { "title": "Дата окончания договора подряда.", "type": "string", "readOnly": true, "example": null }, "firmHomeId": { "title": "Id договора управления/поставки ресурса между жилым домом и управляющей компанией.", "type": "integer", "readOnly": false, "example": 4 }, "firmStartDate": { "title": "Дата начала действия договора управления.", "type": "string", "readOnly": true, "example": "2020-01-01" }, "firmEndDate": { "title": "Дата окончания действия договора управления.", "type": "string", "readOnly": true, "example": "2020-01-01" }, "homeStreetId": { "title": "Id дома.", "type": "integer", "readOnly": true, "example": 4 }, "homeStreetNumber": { "title": "Номер дома.", "type": "string", "readOnly": true, "example": "32" }, "homeStreetCorp": { "title": "Корпус.", "type": "string", "readOnly": true, "example": "2" }, "homeStreetFrame": { "title": "Строение.", "type": "string", "readOnly": true, "example": "1" }, "homeId": { "title": "Id записи с описанием характеристик строения.", "type": "integer", "readOnly": true, "example": 4 }, "homeMaxFloors": { "title": "Этажность дома.", "type": "integer", "readOnly": true, "example": 9 }, "homeWearOut": { "title": "Износ дома в процентах, умноженное на 100.", "type": "integer", "readOnly": true, "example": 6350 }, "homeBuiltYear": { "title": "Год постройки.", "type": "integer", "readOnly": true, "example": 1976 }, "streetId": { "title": "Id улицы.", "type": "integer", "readOnly": true, "example": 4 }, "streetName": { "title": "Наименование улицы.", "type": "string", "readOnly": true, "example": "Ленина" }, "streetPrefixName": { "title": "Тип улицы.", "type": "string", "readOnly": true, "example": "улица" }, "cityId": { "title": "Id населённого пункта.", "type": "integer", "readOnly": true, "example": 4 }, "cityName": { "title": "Наименование населённого пункта.", "type": "string", "readOnly": true, "example": "Хабаровск" }, "cityTypeShortName": { "title": "Тип населённого пункта.", "type": "string", "readOnly": true, "example": "г." }, "customerPhones": { "title": "телефоны заказчика", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } }, "contractorPhones": { "title": "телефоны подрядчика", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } }, "contractorDivisions": { "type": "array", "items": { "$ref": "#/components/schemas/IContractorDivision" } } }, "type": "object" }, "FirmHomeCollection": { "title": "Просмотр списка домов, обслуживаемых организацией", "properties": { "data": { "title": "массив со списком домов", "type": "array", "items": { "$ref": "#/components/schemas/FirmHome" } } }, "type": "object" }, "FirmHome": { "title": "IFirmHome", "description": "Договор управления/ресурсоснабжения по организации и адресу", "properties": { "id": { "title": "id ресурса договора управления", "description": "Вывод данных по договору управления/ресурсоснабжения", "type": "integer", "example": 2 }, "startDate": { "title": "Дата начала действия договора управления/ресурсоснабжения", "type": "string", "example": "2020-01-01" }, "endDate": { "title": "Дата окончания действия договора управления/ресурсоснабжения", "type": "string", "example": null }, "homeStreetId": { "title": "id ресурса адреса", "type": "integer", "example": 2 }, "homeStreetNumber": { "title": "Номер дома", "type": "string", "readOnly": true, "example": "3" }, "homeStreetCorp": { "title": "Корпус дома", "type": "string", "readOnly": true, "example": "5" }, "homeStreetFrame": { "title": "Номер строения", "type": "string", "readOnly": true, "example": null }, "homeId": { "title": "id ресурса дома", "type": "integer", "readOnly": true, "example": 1 }, "homeMaxFloors": { "title": "максимальная этажность дома", "type": "integer", "readOnly": true, "example": 5 }, "homeWearOut": { "title": "процент износа", "type": "number", "format": "float", "readOnly": true, "example": 5.65 }, "homeWearOutMonth": { "title": "Месяц и год определения процента износа", "type": "string", "readOnly": true, "example": "2020-01" }, "homeBuildYear": { "title": "год постройки дома", "type": "integer", "readOnly": true, "example": 1999 }, "streetId": { "title": "id ресурса улицы", "type": "integer", "readOnly": true, "example": 2 }, "streetPrefixName": { "title": "тип улицы", "type": "string", "readOnly": true, "example": "улица" }, "streetName": { "title": "Наименование улицы", "type": "string", "readOnly": true, "example": "Ленина" }, "cityId": { "title": "id ресурса населенного пункта", "type": "integer", "readOnly": true, "example": 2 }, "cityName": { "title": "Наименование населенного пункта", "type": "string", "readOnly": true, "example": "Переясловка" }, "cityTypeShortName": { "title": "тип нас.пункта", "type": "string", "readOnly": true, "example": "с." }, "firmId": { "title": "Идентификатор организации", "type": "integer", "readOnly": true, "example": 1 }, "firmName": { "title": "Наименование организации", "type": "string", "readOnly": true, "example": "Региострой" }, "phones": { "title": "Телефоны УК/РСО", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" } }, "homeContractors": { "title": "При удалении можно не заполнять. Не нужен", "type": "array", "items": { "$ref": "#/components/schemas/HomeContractor" } } }, "type": "object" }, "HomeAddressReceiverCollection": { "title": "Просмотр правил регистрации обращений по дому", "properties": { "data": { "title": "массив со списком правил регистрации обращений", "type": "array", "items": { "$ref": "#/components/schemas/IHomeReceiver" } } }, "type": "object" }, "IHomeReceiver": { "title": "IHomeReceiver", "description": "Список правил регистрации обращений по дому (все его адреса и фирмы). На входе будут расширенная структура модели AddressReceiver", "properties": { "id": { "title": "id ресурса связной записи address_receiver", "type": "integer", "example": 2 }, "addressId": { "title": "id ресурса адреса(home_street)", "type": "integer", "example": 2 }, "firmHomeId": { "title": "id ресурса договора управления(firm_homes)", "type": "integer", "example": 2 }, "firmId": { "title": "Идентификатор организации", "type": "integer", "readOnly": true, "example": 1 }, "firmName": { "title": "Наименование организации", "type": "string", "readOnly": true, "example": "Региострой" }, "start_date": { "title": "???", "type": "string", "example": "2020-01-01" }, "end_date": { "title": "????", "type": "string", "example": null }, "cityId": { "title": "id ресурса населенного пункта", "type": "integer", "readOnly": true, "example": 2 }, "cityName": { "title": "Наименование населенного пункта", "type": "string", "readOnly": true, "example": "Переясловка" }, "cityPrefixName": { "title": "тип нас.пункта", "type": "string", "readOnly": true, "example": "с." }, "streetId": { "title": "id ресурса улицы", "type": "integer", "readOnly": true, "example": 2 }, "streetPrefixName": { "title": "тип улицы", "type": "string", "readOnly": true, "example": "улица" }, "streetName": { "title": "Наименование улицы", "type": "string", "readOnly": true, "example": "Ленина" }, "homeId": { "title": "id ресурса дома", "type": "integer", "readOnly": true, "example": 1 }, "homeNumber": { "title": "Номер дома", "type": "string", "readOnly": true, "example": "3" }, "homeCorp": { "title": "Корпус дома", "type": "string", "readOnly": true, "example": "5" }, "homeFrame": { "title": "Номер строения", "type": "string", "readOnly": true, "example": null }, "groupReceiver": { "$ref": "#/components/schemas/IGroupReceiver" } }, "type": "object" }, "IFirmPhone": { "title": "Телефон организации", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "note": { "description": "описание телефона", "type": "string", "example": "телефон приемной" }, "firmId": { "description": "ID записи таблицы firms (организация, которой принадлежит телефон)", "type": "integer", "example": 45 }, "divisionId": { "description": "ID записи таблицы divisions (участок, которому принадлежит телефон)", "type": "integer", "example": 181 }, "phone": { "description": "номер телефона", "type": "string", "example": "+79145554444" }, "internalOnly": { "description": "признак доступности телефона (false - доступен всем. true - для внутреннего использования)", "type": "boolean", "example": false } }, "type": "object" }, "FirmProperty": { "title": "FirmProperty - Описание модели свойств фирмы ", "description": "Описание модели свойств фирмы (FirmProperty)", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "main_property_id": { "description": "код свойства", "type": "integer", "example": 5 }, "main_property_code": { "description": "символьный код свойства", "type": "string", "example": "accept-calls" }, "main_property_name": { "description": "наименование свойства", "type": "string", "example": "Принимать обращения от жителей этой организации в ЦУРОГ" }, "main_property_val_id": { "description": "код значения свойства (при его наличие)", "type": "integer|null", "example": 2 }, "main_property_value": { "description": "значение свойства свойства", "type": "string", "example": "да" }, "property_value": { "description": "наименование свойства (если предыдущие два null)", "type": "string", "example": "Принимать" } }, "type": "object" }, "IFirmEdit": { "title": "Firm - описание модели Фирма", "description": "описание модели Фирма (Firm)", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Наименование юр.лица", "type": "string", "example": "ООО Ромашка" }, "rank": { "description": "Код типа организации.", "type": "integer", "example": 3 }, "rank_name": { "description": "Тип организации (наименование).", "type": "string", "example": "Управляющая организация" }, "public_email": { "description": "E-mail для приема обращений", "type": "string", "example": "12345@mail.ru" }, "use_call_service": { "description": "Сервис “обращения жителей”", "type": "string", "example": "да" }, "accept_calls": { "description": "Прием и регистрация обращений в ЦУРОГ", "type": "string", "example": "да" }, "do_callback": { "description": "обратный обзвон выполненных обращений", "type": "string", "example": "нет" }, "san_service": { "description": "учет работ по санитарии", "type": "string", "example": "нет" }, "tech_service": { "description": "учет работ по ТО", "type": "string", "example": "нет" }, "lift_service": { "description": "учет работ по обслуживанию лифтов", "type": "string", "example": "нет" }, "cityId": { "description": "населенный пункт, в котором работает организация", "type": "integer", "example": 1 }, "phones": { "title": "Телефоны организации", "type": "array", "items": { "$ref": "#/components/schemas/IFirmPhone" }, "readOnly": true }, "divisions": { "title": "Список подразделений/участков", "type": "array", "items": { "$ref": "#/components/schemas/IDivision" }, "readOnly": true } }, "type": "object" }, "FirmReceiverCollection": { "title": "Просмотр списка подрядчиков, которым мы можем передать обращение", "properties": { "data": { "title": "массив со списком договоров", "type": "array", "items": { "$ref": "#/components/schemas/IContractorFolderSet" } } }, "type": "object" }, "IContractorFolderSet": { "title": "Список организаций, кому можно будет отправить обращение", "description": "Список подрядчиков с их подразделениями, которые могут получать обращения", "properties": { "firmId": { "title": "id организации", "type": "integer", "example": 4 }, "firmName": { "title": "наименование организации", "type": "string", "example": "ООО Ромашка" }, "divisionId": { "title": "id подразделения организации", "type": "integer", "example": 3 }, "divisionName": { "title": "наименование организации", "type": "string", "example": "участок №2" }, "setId": { "title": "id набора папки", "type": "integer", "example": 3 }, "name": { "title": "совмещенное название firmName(divisionName)", "type": "string", "example": "ООО Ромашка(участок №2)" } }, "type": "object" }, "FirmToFirmCollection": { "title": "Просмотр списка договоров между предприятиями", "properties": { "data": { "title": "массив со списком договоров", "type": "array", "items": { "$ref": "#/components/schemas/IFirmToFirmContract" } } }, "type": "object" }, "IFirmToFirmContract": { "title": "Договорные отношения между организациями", "description": "Связь организаций(firms), как заказчик/подрядчик", "properties": { "id": { "title": "id ресурса сущности firm_to_firm_contracts", "type": "integer", "readOnly": true, "example": 2 }, "customerFirmId": { "title": "id ресурса заказчика", "type": "integer", "example": 5 }, "customerFirmName": { "title": "Наименование заказчика", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "customerFirmRank": { "title": "Тип организации заказчика", "type": "integer", "readOnly": true, "example": 2 }, "contractorFirmId": { "title": "id ресурса подрядчика", "type": "integer", "example": 3 }, "contractorFirmName": { "title": "Наименование подрядчика", "type": "string", "readOnly": true, "example": "ООО Василек" }, "startDate": { "title": "Дата начала договора", "type": "string", "example": "2024-11-28" }, "endDate": { "title": "Дата окончания договора(последняя дата действия). Null - бессрочный или дата неизвестна", "type": "string", "example": "2024-11-30" }, "divisions": { "type": "array", "items": { "$ref": "#/components/schemas/IDivision" } } }, "type": "object" }, "FirmType": { "title": "FirmType - описание модели типа фирм", "description": "описание модели типа фирм (FirmType)", "properties": { "id": { "type": "integer", "readOnly": true, "example": 4 }, "type_name": { "description": "наименование типа организации", "type": "string", "example": "Управляющая компания" } }, "type": "object" }, "AccountCollection": { "title": "Список лицевых счетов", "properties": { "data": { "title": "Массив со списком квартир", "type": "array", "items": { "$ref": "#/components/schemas/IAccount" } } }, "type": "object" }, "IAccount": { "title": "IAccount - данные о лицевом счете", "description": "выводим данные о лицевом счете", "properties": { "id": { "title": "id записи accounts", "type": "integer", "readOnly": true, "example": 5 }, "account": { "title": "лицевой счет", "type": "string", "example": "111234598" }, "flatId": { "title": "id квартиры", "type": "integer", "example": 55 }, "flatNum": { "title": "номер квартиры", "type": "string", "readOnly": true, "example": "1" }, "firmHomeId": { "title": "id договора управления", "type": "integer", "example": 56 }, "firmId": { "title": "id УК", "type": "integer", "readOnly": true, "example": 4 }, "firmName": { "title": "Наименование УК", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "addressId": { "title": "id записи home_street", "type": "integer", "readOnly": true, "example": 156 }, "startDate": { "title": "дата открытия лицевого счета", "type": "string", "example": "2020-01-01" }, "endDate": { "title": "дата закрытия лицевого счета", "type": "string", "example": null }, "floor": { "title": "этаж", "type": "integer", "readOnly": true, "example": 5 }, "entranceId": { "title": "id записи подъезда(entrances)", "type": "integer", "readOnly": true, "example": 16 }, "entranceNumber": { "title": "номер подъезда", "type": "string", "readOnly": true, "example": "4" }, "debt": { "$ref": "#/components/schemas/IDebt" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/IOwner" }, "readOnly": true } }, "type": "object" }, "DebtCollection": { "title": "Список лицевых счетов", "properties": { "data": { "title": "Массив со списком долгов по лицевому", "type": "array", "items": { "$ref": "#/components/schemas/IDebt" } } }, "type": "object" }, "IDebt": { "title": "IDebt - данные о задолженности по лицевому счету", "description": "Выводим данные о долгах, переданных из внешней базы", "properties": { "id": { "title": "id записи в таблице debitors", "type": "integer", "readOnly": true, "example": 1 }, "accountId": { "title": "id записи лицевого счета", "type": "integer", "readOnly": true, "example": 25 }, "account": { "title": "номер лицевого счета УК/РСО", "type": "string", "readOnly": true, "example": "345-83830-2" }, "flatId": { "title": "id квартиры, таблица flats", "type": "integer", "readOnly": true, "example": 5 }, "flatNum": { "title": "номер квартиры", "type": "string", "readOnly": true, "example": " 56" }, "firmHomeId": { "title": "код записи связи дома с договором управления ", "type": "string", "example": "2025-05-01" }, "firmName": { "title": "Наименование УК", "type": "string", "readOnly": true, "example": "УК \"Новый дом\"" }, "firmId": { "title": "id записи УК", "type": "integer", "readOnly": true, "example": 2 }, "addressId": { "title": "id адреса (home_street.id)", "type": "integer", "readOnly": true, "example": 456 }, "debtDate": { "title": "Дата выгрузки задолженности (на какое число долг)", "type": "string", "readOnly": true, "example": "2026-02-01" }, "payDate": { "title": "Дата последней оплаты", "type": "string", "readOnly": true, "example": null }, "debtAmount": { "title": "Сумма задолженности", "type": "decimal", "readOnly": true, "example": 444.65 } }, "type": "object" }, "EmailCollection": { "title": "Список электронных адресов по лицевому счету", "properties": { "data": { "title": "Массив адресов по квартире", "type": "array", "items": { "$ref": "#/components/schemas/IEmail" } } }, "type": "object" }, "IEmail": { "title": "Данные для работы с электронной почтой по квартире", "properties": { "id": { "title": "ID таблицы (emails)", "type": "integer", "example": 45 }, "email": { "title": "электронная почта", "type": "string", "example": "curog@mail.ru" }, "isDefault": { "title": "Указанная электронная почта является приоритетной", "type": "boolean", "example": false }, "flatId": { "title": "ID из таблицы flats", "type": "integer", "readOnly": true, "example": 345 } }, "type": "object" }, "FlatCollection": { "title": "Получение списка квартир", "properties": { "data": { "title": "Массив со списком квартир", "type": "array", "items": { "$ref": "#/components/schemas/IFlat" } } }, "type": "object" }, "IFlatInfo": { "title": "IFlatInfo - элемент общего интерфейса по адресу (IAddressInfo)", "description": "Выводим данные о квартире", "properties": { "id": { "title": "id записи в таблице flats", "type": "integer", "readOnly": true, "example": 1 }, "num": { "title": "номер квартиры", "type": "string", "readOnly": true, "example": "25" }, "floor": { "title": "Этаж", "type": "integer", "readOnly": true, "example": 5 }, "addressId": { "title": "id записи таблицы home_street для которой мы выводим этот лицевой", "type": "integer", "readOnly": true, "example": 3 }, "entranceId": { "title": "id записи подъезда, таблица entrances", "type": "integer", "readOnly": true, "example": 2 }, "homeId": { "title": "id записи дома", "type": "integer", "readOnly": true, "example": 2 }, "entranceNumber": { "title": "номер подъезда", "type": "integer", "readOnly": true, "example": 3 } }, "type": "object" }, "IFlat": { "title": "IFlat - Данные о квартире", "description": "Выводим данные о квартире и собственников.", "properties": { "id": { "title": "id записи в таблице flats", "type": "integer", "readOnly": true, "example": 1 }, "num": { "title": "номер квартиры", "type": "string", "example": "25" }, "floor": { "title": "Этаж", "type": "integer", "example": 5 }, "square": { "title": "Площадь помещения", "type": "decimal", "example": 120.5 }, "residential": { "title": "Признак жилого помещения. False - нежилье", "type": "boolean", "example": true }, "endDate": { "title": "Дата закрытия", "type": "string", "example": "2025-05-01" }, "addressId": { "title": "id записи таблицы home_street", "type": "integer", "readOnly": true, "example": 3 }, "entranceId": { "title": "id записи подъезда, таблица entrances", "type": "integer", "example": 2 }, "entranceNumber": { "title": "номер подъезда", "type": "string", "readOnly": true, "example": "за углом" }, "cityId": { "title": "ID населенного пункта", "type": "integer", "readOnly": true, "example": 2 }, "cityName": { "title": "наименование населенного пункта", "type": "string", "readOnly": true, "example": "Хэйхэ" }, "cityPrefixName": { "title": "Тип населенного пункта", "type": "string", "readOnly": true, "example": "пгт." }, "streetId": { "title": "ID улицы", "type": "integer", "readOnly": true, "example": 33 }, "streetName": { "title": "наименование улицы", "type": "string", "readOnly": true, "example": "Красная" }, "streetPrefixName": { "title": "название префикса улицы", "type": "string", "readOnly": true, "example": "ул." }, "homeNumber": { "title": "номер дома", "type": "string", "readOnly": true, "example": "16" }, "homeCorp": { "title": "корпус дома", "type": "string", "readOnly": true, "example": "A" }, "homeFrame": { "title": "номер строения", "type": "string", "readOnly": true, "example": "строение 5" }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/IOwner" }, "readOnly": true }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/IEmail" }, "readOnly": true } }, "type": "object" }, "OwnerCollection": { "title": "Получение списка собственников квартиры", "properties": { "data": { "title": "Массив со списком собственников квартиры", "type": "array", "items": { "$ref": "#/components/schemas/IOwner" } } }, "type": "object" }, "IOwner": { "title": "IOwner - Данные о собственнике", "description": "Выводим данные о собственнике.", "properties": { "id": { "title": "id записи в таблице owners", "type": "integer", "readOnly": true, "example": 1 }, "flat_id": { "title": "id записи помещения (flats)", "type": "integer", "readOnly": true, "example": 1 }, "first_name": { "title": "Имя собственника", "type": "string", "example": "Иван" }, "patronymic_name": { "title": "Отчество собственника", "type": "string", "example": "Иванович" }, "last_name": { "title": "Фамилия собственника", "type": "string", "example": "Иванов" }, "start_date": { "title": "Дата начала владения", "type": "string", "example": "2020-01-01" }, "end_date": { "title": "Дата окончания владения", "type": "string", "example": null } }, "type": "object" }, "IFolderSetUserConnection": { "title": "IFolderSetUserConnection - Ввод/редактирование доступа пользователя к набору папок", "properties": { "accessFolders": { "title": "Доступ к остальным папкам", "type": "string", "example": "READ" }, "folderSetId": { "title": "код набора папок. Только для ввода новых записей", "type": "integer", "example": 40 }, "employeeId": { "title": "код пользователя. Только для ввода новых записей", "type": "integer", "example": 5 } }, "type": "object" }, "IFolderSetUserAccess": { "title": "IFolderSetUserAccess - таблица доступа пользователя к наборам папок", "description": "Доступ пользователя к наборам папок", "properties": { "id": { "title": "номер ресурса таблицы folder_accesses", "type": "integer", "readOnly": true, "example": 5 }, "accessFolders": { "title": "Тип разрешения для движение обращений из папок", "type": "string", "example": "READ" }, "fsId": { "title": "номер ресурса таблицы folder_sets", "type": "integer", "example": 5 }, "fsValid": { "title": "Признак: действующая ли папка", "type": "boolean", "readOnly": true, "example": true }, "fsFirmId": { "title": "Номер ресурса записи firms, если владелец папки - фирма, подразделение, работник фирмы", "type": "integer", "readOnly": true, "example": 5 }, "fsFirmName": { "title": "Наименование фирмы, ресурса fsFirmId", "type": "string", "readOnly": true, "example": "ЦУРОГ" }, "fsDivisionId": { "title": "Номер ресурса записи divisions, если владелец папки - подразделение либо работник подразделения", "type": "integer", "readOnly": true, "example": 5 }, "fsDivisionName": { "title": "Наименование подразделения, ресурса fsDivisionId", "type": "string", "readOnly": true, "example": "ПТО" }, "fsEmployeeId": { "title": "Номер ресурса записи users, если она владелец папки", "type": "integer", "readOnly": true, "example": 5 }, "fsEmployeeName": { "title": "Логин пользователя, если он владелец папки", "type": "string", "readOnly": true, "example": "SYSTEM" }, "fsEmployeeFio": { "title": "ФИО пользователя, если он владелец папки", "type": "string", "readOnly": true, "example": "Петров И.С." }, "userId": { "title": "Номер ресурса пользователя, у которого есть разрешение работать с набором папок", "type": "integer", "example": 5 }, "userName": { "title": "Логин пользователя", "type": "string", "readOnly": true, "example": "ADMIN" }, "userFio": { "title": "ФИО пользователя", "type": "string", "readOnly": true, "example": "Иванов Иван Сидорович" } }, "type": "object" }, "IFolderSection": { "title": "FolderSection - расширение локального списка папок", "description": "Описание вывода данных из таблицы расширения списка папка (folder_sections)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование папки", "type": "string", "example": "Даны гарантии" }, "sectionValid": { "title": "Признак удаленности папки", "type": "boolean", "example": true } }, "type": "object" }, "IFolderSet": { "title": "FolderSet - набор папок", "description": "выделяю в отдельную сущность содержимое записи", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "ownerId": { "title": "номер ресурса владельца", "type": "integer", "example": 5 }, "ownerName": { "title": "Наименование владельца", "type": "string", "example": "Иванов" }, "ownerCode": { "title": "наименование типа владельца", "type": "string", "example": "user" }, "valid": { "title": "Признак действующей папки", "type": "boolean", "example": true } }, "type": "object" }, "IFirmFoldersTree": { "title": "FolderSetTree - Вывод данных в виде дерева для работы с папками", "description": "FolderSetTreeController", "properties": { "data": { "title": "Данные о рабочих папка фирмы", "properties": { "id": { "title": "firms.id", "type": "integer", "example": 1 }, "name": { "title": "наименование фирмы", "type": "string", "example": "ООО Ромашка" }, "folderSetId": { "title": "id набора папок", "type": "integer", "example": 6 }, "folderSetValid": { "title": "Признак - действующая папка или закрытая", "type": "boolean", "example": true }, "divisionNodes": { "type": "array", "items": { "$ref": "#/components/schemas/DivisionFolderNode" } }, "userNodes": { "type": "array", "items": { "$ref": "#/components/schemas/UserFolderNode" } } }, "type": "object" } }, "type": "object" }, "FolderAccessUser": { "title": "FolderAccessUser - Список пользователей, имеющих доступ к обращениям данной папки", "description": "Список пользователей, имеющих доступ к обращениям, указанного набора папок", "properties": { "employeeId": { "title": "Код пользователя, которому даны эти разрешения", "type": "integer", "example": 13 }, "employeeFio": { "title": "ФИО пользователя", "type": "string", "example": "Иванов Иван Иванович" }, "employeeName": { "title": "Логин пользователя", "type": "string", "example": "DVS_Ivanov" }, "accessId": { "title": "Код записи разрешения", "type": "integer", "example": 1 }, "accessFolderIn": { "title": "Разрешение на действия с обращениями из папок с признаком \"входящие\"", "type": "string", "example": "READ" }, "accessFolders": { "title": "Разрешение на действия с обращениями из остальных папок", "type": "string", "example": "READ" }, "firmId": { "title": "Код организации, которой принадлежит пользователь", "type": "integer", "example": 1 }, "firmName": { "title": "Наименование организации, которой принадлежит пользователь", "type": "string", "example": "ЦУРОГ-1" }, "divisionId": { "title": "Код подразделения, которому принадлежит пользователь", "type": "integer", "example": 2 }, "divisionName": { "title": "Наименование подразделения, которому принадлежит пользователь", "type": "string", "example": "ПТО" } }, "type": "object" }, "FolderCollections": { "title": "Folder - папка для движения документов", "description": "выводим данные по папке движения документа (folders)", "properties": { "data": { "title": "Список папок фирмы, с которыми она работает", "type": "array", "items": { "$ref": "#/components/schemas/IFolder" } } }, "type": "object" }, "IFolderMobileList": { "title": "Данные о папках выбранного набора папок для мобильного приложения", "description": "Выводим данные с информацией об обращениях", "properties": { "id": { "title": "номер ресурса папки", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование папки", "type": "string", "example": "Входящие" }, "valid": { "title": "состояние папки: true - папка действующая, false - архивная", "type": "boolean", "example": "true" }, "position": { "title": "порядковый номер в отчетах", "type": "integer", "readOnly": true, "example": 1 }, "masterId": { "title": "код мастер-папки", "type": "integer", "example": 12 }, "masterType": { "title": "Тип папки", "type": "string", "example": "WORK" }, "callsCount": { "title": "Количество незакрытых обращений (для папок типа не FINAL)", "type": "integer", "example": 5 }, "emergencyCallsCount": { "title": "Количество аварийных незакрытых обращений (для папок типа не FINAL)", "type": "integer", "example": 0 }, "previewRecentCalls": { "title": "предпросмотр последних трех обращений в тек.папке", "type": "array", "items": { "$ref": "#/components/schemas/IPreviewRecentCalls" } } }, "type": "object" }, "IFolderList": { "title": "Данные о папках выбранного набора папок", "description": "Выводим сокращенную информацию о папках, набора папок ", "properties": { "id": { "title": "номер ресурса папки", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование папки", "type": "string", "example": "Входящие" }, "valid": { "title": "состояние папки: true - папка действующая, false - архивная", "type": "boolean", "example": "true" }, "position": { "title": "порядковый номер в отчетах", "type": "integer", "readOnly": true, "example": 1 }, "masterId": { "title": "код мастер-папки", "type": "integer", "example": 12 }, "masterType": { "title": "Тип папки", "type": "string", "example": "WORK" } }, "type": "object" }, "IFolder": { "title": "IFolder - Вывод данных о папке сущности", "description": "Выводим информацию о папке движения документа (folders)", "properties": { "id": { "title": "номер ресурса folders", "description": "Просмотр данных о входящей папке", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Наименование папки", "type": "string", "example": "Входящая" }, "valid": { "title": "признак действующей записи", "type": "boolean", "example": true }, "needCheck": { "title": "признак необходимости проверки обращения, после его закрытия исполнителем", "type": "boolean", "example": true }, "position": { "title": "Порядковый номер", "type": "integer", "example": 1 }, "masterId": { "title": "ресурс master_folders", "type": "integer", "example": 1 }, "masterName": { "title": "Имя мастер папки", "type": "string", "readOnly": true, "example": "Входящие" }, "masterType": { "title": "Тип папок", "type": "string", "readOnly": true, "example": "start" }, "folderSetId": { "title": "Ресурс набора папок, к которой прикреплена папка", "type": "integer", "readOnly": true, "example": 1 } }, "type": "object" }, "IFoldersByOwnerId": { "title": "Данные о наборе папок и папках выбранного субъекта", "description": "Выводим информацию о владельце папки, наборе папок, списки папок ", "properties": { "ownerId": { "title": "номер ресурса владельца папок", "type": "integer", "readOnly": true, "example": 1 }, "ownerName": { "title": "Наименование владельца папки", "type": "string", "example": "ООО Ромашка" }, "ownerCode": { "title": "Тип владельца папки", "type": "string", "example": "firm" }, "folderSetId": { "title": "Ресурс набора папок", "type": "integer", "readOnly": true, "example": 1 }, "folderSetValid": { "title": "признак действующей записи", "type": "boolean", "example": true }, "folders": { "title": "Список папок для Web приложения", "type": "array", "items": { "$ref": "#/components/schemas/IFolderList" } }, "folders_": { "title": "Список папок для мобильного приложения", "type": "array", "items": { "$ref": "#/components/schemas/IFolderMobileList" } } }, "type": "object" }, "IFolderSetSelectionCollection": { "title": "Folder - папка для движения документов", "description": "выводим данные по папке движения документа (folders)", "properties": { "data": { "title": "Список папок фирмы, с которыми она работает", "type": "array", "items": { "$ref": "#/components/schemas/IFolderSetSelection" } } }, "type": "object" }, "DivisionFolderNode": { "title": "DivisionFolderNode - Данные о подразделении, его пользователей и наборов папок", "description": "FolderSetTreeController", "properties": { "id": { "title": "divisions.id", "type": "integer", "example": 1 }, "name": { "title": "наименование подразделения", "type": "string", "example": "Бухгалтерия" }, "folderSetId": { "title": "id набора папок", "type": "integer", "example": 6 }, "folderSetValid": { "title": "Признак - действующая папка или закрытая", "type": "boolean", "example": true }, "userNodes": { "type": "array", "items": { "$ref": "#/components/schemas/UserFolderNode" } } }, "type": "object" }, "IFolderSetSelection": { "title": "ISelectedFolderSet - Данные о наборе папок. Используется для работы по выборе из списка", "properties": { "id": { "title": "id набора папок", "type": "integer", "readOnly": true, "example": 5 }, "valid": { "title": "Признак: действующая ли папка", "type": "boolean", "readOnly": true, "example": true }, "firmId": { "title": "Номер ресурса записи firms, если владелец папки - фирма или подразделение", "type": "integer", "readOnly": true, "example": 5 }, "firmName": { "title": "Наименование фирмы, если она владелец папки", "type": "string", "readOnly": true, "example": "ЦУРОГ" }, "divisionId": { "title": "Номер ресурса записи divisions, если владелец папки - подразделение", "type": "integer", "readOnly": true, "example": 5 }, "divisionName": { "title": "Наименование подразделения, если оно владелец папки", "type": "string", "readOnly": true, "example": "ПТО" }, "employeeId": { "title": "Номер ресурса записи users, если она владелец папки", "type": "integer", "readOnly": true, "example": 5 }, "employeeName": { "title": "Логин пользователя, если он владелец папки", "type": "string", "readOnly": true, "example": "SYSTEM" }, "employeeFio": { "title": "ФИО пользователя, если он владелец папки", "type": "string", "readOnly": true, "example": "Петров И.С." } }, "type": "object" }, "UserFolderNode": { "title": "UserFolderNode - пользователь с признаком набора папок", "description": "выводим данные по пользователю с признаком - есть ли набор папок", "properties": { "id": { "title": "firm_users.id", "type": "integer", "example": 1 }, "name": { "title": "Логин пользователя", "type": "string", "example": "brusora01" }, "fio": { "title": "ФИО пользователя", "type": "string", "example": "Сидоров В.В." }, "folderSetId": { "title": "folder_sets.id", "type": "integer", "example": 5 }, "folderSetValid": { "title": "Признак архивности набора папок. True - набор действующий", "type": "boolean", "example": true } }, "type": "object" }, "IFolderSetUserAccessCollection": { "title": "Список папок, к которым пользователь теоретически может получить доступ", "description": "Список папок, к которым пользователь теоретически может получить доступ", "properties": { "data": { "title": "Список папок фирмы, с которыми она работает", "type": "array", "items": { "$ref": "#/components/schemas/IFolderSetUserAccess" } } }, "type": "object" }, "IClientError": { "title": "Данные для ввода обращения", "properties": { "id": { "title": "ID записи ошибки", "type": "integer", "readOnly": true, "example": 45 }, "message": { "title": "Сообщение", "type": "string", "example": "Набор папок не валидный" }, "errorType": { "title": "Тип ошибки?", "type": "string", "example": "Exception" }, "source": { "title": "Исполняющая программа ", "type": "string", "example": "ExecutorMobile" }, "appVersion": { "title": "Версия программы", "type": "string", "example": "1.0.0 (5)" }, "platform": { "title": "Операционная система", "type": "string", "example": "Android" }, "osVersion": { "title": "Версия операционной системы", "type": "string", "example": "13" }, "deviceModel": { "title": "Модель телефона", "type": "string", "example": "Google Pixel 7" }, "occurredUTCAt": { "title": "Дата возникновения ошибки, с учетом временной зоны", "type": "string", "example": "2026-02-26T02:25:56.9092762Z" }, "userId": { "title": "Код пользователя", "type": "string", "example": "22" }, "additionalData": { "title": ".", "type": "string", "example": "{}" }, "requestData": { "title": ",", "type": "string", "example": null } }, "type": "object" }, "HomeShow": { "title": "Home", "description": "Данные по дому (Home)", "properties": { "id": { "description": "Шаблон вывода данных по одному дому", "type": "integer", "readOnly": true, "example": 1 }, "number": { "title": "Номер дома", "type": "string", "example": "22" }, "building": { "title": "Корпус, строение, литера", "type": "string", "example": "б" }, "fias": { "title": "ФИАС дома", "type": "string|null", "example": null }, "floors": { "title": "Этажность дома", "type": "integer|null", "example": 1 }, "wearOut": { "title": "Износ дома", "type": "real", "example": 50.9 }, "wearOutMonth": { "title": "Месяц расчета износа дома", "type": "string", "example": "202401" }, "foundYear": { "title": "год постройки", "type": "string", "example": "2017" }, "mkd": { "title": "признак жилого фонда", "type": "string", "example": "МКД" }, "mainStreet": { "$ref": "#/components/schemas/AllStreet" }, "dopAddress": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } } }, "type": "object" }, "AddressOld": { "title": "Address", "description": "Описание модели адреса (HomeStreet)", "properties": { "id": { "description": "Шаблон вывода данных по адресу текущего дома\ndeprecate", "type": "integer", "readOnly": true, "example": 1 }, "number": { "title": "Номер дома", "type": "string", "example": "22" }, "building": { "title": "Корпус, строение, литера", "type": "string", "example": "б" }, "fias": { "title": "ФИАС дома", "type": "string|null", "example": null }, "street": { "$ref": "#/components/schemas/AllStreet" } }, "type": "object" }, "Item": { "title": "Item - Пункты главного меню и его подменю(items)", "description": "Данные о пунктах главного меню и подменю", "properties": { "id": { "description": "Код ресурсом", "type": "integer", "example": 2 }, "position": { "description": "Порядковый номер в пунктах меню", "type": "integer", "example": 5 }, "sub_position": { "description": "Относительное расположение текущего пункта меню", "type": "string", "example": "left-top" }, "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "resource_id": { "description": "ссылка на ресурс", "type": "integer", "example": 1 }, "delimiter": { "description": "Признак выделения пункта меню", "type": "boolean", "example": false }, "item_parent": { "description": "Ссылка на верхне уровневый пункт меню, если он есть", "type": "integer", "example": null }, "item_route": { "description": "служебное поле, необходимо для фронта", "type": "string", "example": "Абра, кадабра" }, "notes": { "description": "полное описание пункта меню", "type": "string", "example": "Получаем весь список пользователей системы" } }, "type": "object" }, "LoginInfo": { "title": "LoginInfo", "description": "возврат данных при аутентификации пользователя", "properties": { "userIn": { "$ref": "#/components/schemas/ILogUser" }, "token": { "description": "токен для дальнейшей работы фронта", "type": "string", "example": "2|E6sDZzwSKiaCqSnAPBDYoZ6E9HRlR9NIrrl0Xfaz" }, "tokenLifeTimeInMin": { "description": "Время жизни токена в минутах", "type": "integer", "example": 10080 }, "refreshToken": { "description": "Токен восстановления для перевыпуска токена", "type": "string", "example": "3|E6sDZzwSKiophjnAPBDYoZ6E9HRlR9NIrrl0Xfaz" }, "refreshTokenExpiresAt": { "description": "Дата истекания действия токена восстановления.(в текущей временной зоне)", "type": "string", "example": "2026-05-24 14:04:45" }, "captcha": { "description": "на будущее. для капча.", "type": "string", "example": " " } }, "type": "object" }, "ILogUserApi": { "title": "ILogUserApi", "description": "Данные пользователя, возвращаемые при входе в систему", "properties": { "logUser": { "$ref": "#/components/schemas/ILogUser" }, "logToken": { "$ref": "#/components/schemas/Token" }, "logResources": { "type": "array", "items": { "$ref": "#/components/schemas/AllUserResources" } } }, "type": "object" }, "IUserFirm": { "title": "IUserFirm - Список организаций пользователя", "description": "выводим данные о фирмах", "properties": { "id": { "title": "id записи FirmUser", "type": "integer", "example": 5 }, "userId": { "title": "код пользователя", "type": "integer", "readOnly": true, "example": 11 }, "userName": { "title": "логин пользователя", "type": "string", "readOnly": true, "example": "PoberOra6" }, "userFio": { "title": "ФИО пользователя", "type": "string", "readOnly": true, "example": "Иванов Иван Петрович" }, "userWorkPlaceId": { "title": "id рабочего места", "type": "integer", "example": 55 }, "firmId": { "title": "id УК", "type": "integer", "example": 4 }, "firmName": { "title": "Наименование УК", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "firmRank": { "title": "Тип организации", "type": "integer", "readOnly": true, "example": 2 }, "cityId": { "title": "код населенного пункта, в котором работает фирма(организация)" }, "cityName": { "title": "наименование населенного пункта, в котором работает фирма(организация)" }, "divisionId": { "title": "id подразделения", "type": "integer", "example": 14 }, "divisionName": { "title": "Наименование подразделения", "type": "string", "readOnly": true, "example": "Диспетчерская" }, "folderSetId": { "title": "ID действующего набора папки пользователя", "type": "integer", "readOnly": true, "example": 110 }, "defaultFirm": { "title": "признак того, что запись является записью по умолчанию для пользователя", "type": "boolean", "example": false }, "deletedAt": { "title": "Дата окончания подключения пользователя от фирмы", "type": "string", "example": null } }, "type": "object" }, "INextCallNumber": { "title": "INextCallNumber - вывод последнего номера сохраненного обращения", "description": " ", "properties": { "userId": { "title": "id текущего пользователя", "type": "integer", "readOnly": true, "example": 11 }, "userNextNumber": { "title": "логин пользователя", "type": "integer", "readOnly": true, "example": 124 }, "userNumber": { "title": "Номер обращения для вывода на экран", "type": "string", "example": "11-124" } }, "type": "object" }, "IBaseId": { "title": "IBaseId - Рабочая папка пользователя", "description": " ", "properties": { "id": { "title": "id рабочего набора папок", "type": "integer", "readOnly": true, "example": 11 } }, "type": "object" }, "IMagazineAddress": { "title": "Данные об адресах события оперативного журнала", "properties": { "id": { "title": "ID адреса события (magazine_home_streets.id)", "type": "integer", "example": 46 }, "streetId": { "title": "ID улицы (streets.id)", "type": "integer", "readOnly": true, "example": 14 }, "streetPrefixShortName": { "title": "префикс улицы", "type": "string", "readOnly": true, "example": "пер." }, "streetName": { "title": "Наименование улицы", "type": "string", "readOnly": true, "example": "Школьная" }, "homeNumber": { "title": "номер дома", "type": "string", "readOnly": true, "example": "5" }, "homeCorp": { "title": "корпус дома", "type": "string", "readOnly": true, "example": "а" }, "homeFrame": { "title": "строение дома", "type": "string", "readOnly": true, "example": null }, "addressId": { "title": "ID адреса (home_street.id)", "type": "integer", "example": 145 }, "firms": { "type": "array", "items": { "$ref": "#/components/schemas/IFirmAddressInfo" }, "readOnly": true }, "flats": { "title": "данные об отключенных квартирах", "type": "array", "items": { "$ref": "#/components/schemas/IMagazineFlat" } } }, "type": "object" }, "IMagazineCollection": { "title": "Список событий оперативного журнала", "description": "Оперативный журмал", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/IMagazine" } } }, "type": "object" }, "IMagazineFlat": { "title": "Данные о квартирах подключенных к событию оперативного журнала", "properties": { "id": { "title": "ID magazine_home_flat.id", "type": "integer", "example": 46 }, "flatId": { "title": "ID квартиры (flats.id)", "type": "integer", "example": 460 }, "floor": { "title": "этаж", "type": "integer", "readOnly": true, "example": 5 }, "num": { "title": "номер квартиры", "type": "string", "readOnly": true, "example": "14" }, "addressId": { "title": "ID адреса (home_street.id)", "type": "integer", "readOnly": true, "example": 145 }, "entranceId": { "title": "ID подъезда (entrances.id)", "type": "integer", "readOnly": true, "example": 15 }, "entranceNumber": { "title": "Номер подъезда", "type": "string", "readOnly": true, "example": "3-й подъезд" } }, "type": "object" }, "IMagazine": { "title": "Данные об оперативном журнале", "properties": { "id": { "title": "ID журнала (magazines.id)", "type": "integer", "readOnly": true, "example": 45 }, "planStartDate": { "title": "плановое отключение услуги", "type": "string", "example": "2026-01-01" }, "planEndDate": { "title": "плановое включение услуги", "type": "string", "example": "2026-10-01" }, "factStartDate": { "title": "Дата фактического отключение услуги", "type": "string", "example": null }, "factEndDate": { "title": "Дата фактического включение услуги", "type": "string", "example": null }, "description": { "title": "Описание события", "type": "string", "example": "Отключение ГВС по дому" }, "cityId": { "title": "ID населенного пункта (cities.id)", "type": "integer", "example": 4 }, "cityPrefixShortName": { "title": "префикс населенного пункта", "type": "string", "readOnly": true, "example": "гор." }, "cityName": { "title": "Наименование нас.пункта", "type": "string", "readOnly": true, "example": "Биробиджан" }, "utilityId": { "title": "ID услуги (utilities.id)", "type": "integer", "example": 14 }, "utilityName": { "title": "Наименование услуги", "type": "string", "readOnly": true, "example": "ГВС" }, "autoLoad": { "title": "Признак автоматической загрузки", "type": "boolean", "readOnly": true, "example": false }, "callId": { "title": "ID записи calls", "type": "integer", "example": 99 }, "folderSetId": { "title": "ID записи folder_sets. Набор папок, в котором произошло соединение Magazine & Call", "type": "integer", "example": 99 }, "createdAt": { "title": "Дата и время создания строки оперативного журнала", "type": "string", "readOnly": true, "example": "2026-06-01 17:23" }, "createdFIO": { "title": "ФИО пользователя, который создал запись оперативного журнала", "type": "string", "readOnly": true, "example": "Иванов Петр Семёнович" }, "addresses": { "title": "данные об отключенных домах", "type": "array", "items": { "$ref": "#/components/schemas/IMagazineAddress" } } }, "type": "object" }, "MasterFolderHist": { "title": "MasterFolderHist - Архив изменений мастер-папки", "description": "Описание вывода данных из таблицы архив изменений мастер-папок (master_folder_hists)", "properties": { "hist_master_id": { "description": "", "type": "integer", "example": 1 }, "hist_master_name": { "description": "Наименование мастер папки", "type": "string", "example": "Входящие\"" }, "hist_master_type": { "description": "тип папки", "type": "string", "example": "start" }, "hist_master_ext": { "description": "Признак расширяемости папки: ext - можно расширять, noext - нельзя", "type": "string", "example": "true" }, "hist_master_position": { "description": "Порядковый номер папки в отчетах", "type": "integer", "example": 5 }, "hist_update": { "description": "дата внесения текущего изменения в базу", "type": "string", "example": "23-08-2022" }, "hist_create": { "description": "дата перемещения данных в ахрив", "type": "string", "example": "23-10-2022" }, "hist_user_id": { "description": "код пользователя, который внес данные изменения", "type": "integer", "example": 1 }, "hist_own_id": { "description": "код записи-владельца", "type": "integer", "example": 1 } }, "type": "object" }, "MasterFolder": { "title": "MasterFolder - мастер-папки", "description": "Описание вывода данных из таблицы мастер-папок (master_folders)", "properties": { "master_id": { "description": "номер ресурса", "type": "integer", "example": 1 }, "master_name": { "description": "Наименование мастер папки", "type": "string", "example": "Входящие" }, "master_type": { "description": "тип папки", "type": "string", "example": "start" }, "master_position": { "description": "порядковый номер в отчете", "type": "integer", "example": 2 } }, "type": "object" }, "MenuItems": { "title": "MenuItem - Пункты меню рабочего места", "description": "Пункты ", "properties": { "id": { "description": "Код ресурсом", "type": "integer", "example": 2 }, "name": { "description": "Наименование пункта меню", "type": "string", "example": "Список пользователей" }, "parentId": { "description": "Ссылка на верхне уровневый пункт меню, если он есть", "type": "integer", "example": null }, "position": { "description": "Порядковый номер в пунктах меню одного уровня", "type": "integer", "example": 5 }, "subPosition": { "description": "Расположение подменю, относительно текущего пункта", "type": "string", "example": "left-top" }, "itemCover": { "description": "Диапазон покрытия", "type": "string", "example": "firm" }, "delimiter": { "description": "Линия-разделитель НАД пунктом меню", "type": "boolean", "example": false }, "actionItem": { "$ref": "#/components/schemas/ActionItems" }, "workPlace": { "$ref": "#/components/schemas/WorkPlace" } }, "type": "object" }, "OutsideHist": { "title": "OutsideHist - архив изменений данных по административному району субъекта РФ", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "Полное наименование района", "type": "string", "example": "Хабаровский район" }, "fias": { "title": "Код района в ФИАС", "type": "UUID", "example": "7d468f39-1afa-41fb-8c4f-9738603cb3d4" }, "regionId": { "title": "Ссылка на субъект федерации", "type": "integer", "example": 1 }, "userFio": { "title": "ФИО пользователя, внесшего изменения", "type": "string", "example": "Иванов И.И." }, "histKey": { "title": "Ключ, соединяющий записи истории редактирования", "type": "UUID", "example": "7d468f39-1afa-41fb-ac4f-9738603cb3d4" }, "updated": { "title": "Дата внесения изменения", "type": "UUID", "example": "7d468f39-1afa-41fb-ac4f-9738603cb3d4" } }, "type": "object" }, "Outside": { "title": "Outside - Административные районы субъекта федерации", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Полное наименование района", "type": "string", "example": "Хабаровский район" }, "regionId": { "description": "Ссылка на субъект федерации", "type": "integer", "example": 2 }, "regionName": { "description": "Наименование субъекта РФ", "type": "string", "example": "Хабаровский край" }, "fias": { "description": "Код района в ФИАС", "type": "UUID", "example": "7d468f39-1afa-41fb-8c4f-9738603cb3d4" }, "oktmo": { "description": "Код по ОКТМО", "type": "string", "example": "01" }, "okato": { "description": "Код по ОКАТО", "type": "string", "example": "01" } }, "type": "object" }, "PipeCollection": { "title": "Список стояков по дому", "properties": { "data": { "title": "Массив стояков по дому", "type": "array", "items": { "$ref": "#/components/schemas/IPipe" } } }, "type": "object" }, "IPipe": { "title": "Данные о вертикальной разводке труб по дому (стояки)", "properties": { "homeId": { "title": "ID дома", "type": "integer", "readOnly": true, "example": 45 }, "id": { "title": "ID стояка", "type": "integer", "readOnly": true, "example": 5 }, "nom": { "title": "Номер стояка", "type": "string", "example": "г1" }, "utilityId": { "title": "ID услуги", "type": "integer", "example": 3 }, "utilityName": { "title": "Наименование услуги", "type": "string", "readOnly": true, "example": "Горячее водоснабжение" }, "note": { "title": "Примечание", "type": "string", "example": "Сдвоен с 2" }, "flats": { "$ref": "#/components/schemas/IFlatInfo" } }, "type": "object" }, "IAddressGroupReceiver": { "title": "Группа правил регистрации обращений при просмотре через адрес", "description": "Вывод информации по группам дома", "properties": { "id": { "title": "id ресурса сущности group_receivers", "type": "integer", "readOnly": true, "example": 2 }, "note": { "title": "наименование группы", "type": "string", "example": "аварийные обращения" }, "firmId": { "title": "id ресурса firms, которой принадлежит группа регистрации обращений", "type": "integer", "example": 5 }, "firmName": { "title": "наименование организации firms.firm_name, которой принадлежит группа регистрации обращений", "type": "string", "example": "ООО Ромашка" }, "startDate": { "title": "дата начала, с которой адрес подключен к группе правил регистрации обращений", "type": "string", "example": "2025-05-01" }, "endDate": { "title": "дата окончания, по которую адрес подключен к группе правил регистрации обращений", "type": "string", "example": null }, "addressReceiverId": { "title": "id ресурса связной таблицы (address_receiver)", "type": "integer", "example": 15 } }, "type": "object" }, "IAddressReceiverCollection": { "title": "Ресурс для просмотра списка адресов с группой правил регистрации обращений", "properties": { "data": { "title": "массив со списком адресов", "type": "array", "items": { "$ref": "#/components/schemas/IAddressReceiver" } } }, "type": "object" }, "IAddressReceiver": { "title": "Адреса с группами правил регистрации обращений граждан", "description": "Вывод информации по адресам и группам правил обращений", "properties": { "id": { "title": "id ресурса сущности address_receivers", "type": "integer", "example": 2 }, "groupReceiverId": { "title": "id ресурса сущности group_receivers", "type": "integer", "readOnly": true, "example": 2 }, "groupReceiverNote": { "title": "наименование группы", "type": "string", "readOnly": true, "example": "аварийные обращения" }, "addressId": { "title": "id ресурса сущности home_street (адрес)", "type": "integer", "readOnly": true, "example": 2 }, "firmHomeId": { "title": "id ресурса home_firm, договор управления дома", "type": "integer", "example": 5 }, "firmId": { "title": "id ресурса firms, которой принадлежит адрес", "type": "integer", "readOnly": true, "example": 5 }, "firmName": { "title": "наименование организации firms.firm_name, которой принадлежит адрес", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "start_date": { "title": "дата начала, с которой адрес подключен к группе правил регистрации обращений", "type": "string", "example": "2025-05-01" }, "end_date": { "title": "дата окончания, по которую адрес подключен к группе правил регистрации обращений", "type": "string", "example": null }, "cityId": { "title": "id ресурса населенного пункта (cities)", "type": "integer", "readOnly": true, "example": 15 }, "cityPrefixName": { "title": "Префикс населенного пункта", "type": "string", "readOnly": true, "example": "город" }, "cityName": { "title": "Наименование населенного пункта", "type": "string", "readOnly": true, "example": "Находка" }, "streetId": { "title": "id ресурса улицы (streets)", "type": "integer", "readOnly": true, "example": 15 }, "streetPrefixName": { "title": "Префикс улицы", "type": "string", "readOnly": true, "example": "тупик" }, "streetName": { "title": "Наименование улицы", "type": "string", "readOnly": true, "example": "Коммунистический" }, "homeId": { "title": "id ресурса здания (homes)", "type": "integer", "readOnly": true, "example": 13 }, "homeNumber": { "title": "Номер дома", "type": "string", "readOnly": true, "example": "6" }, "homeCorp": { "title": "корпус дома", "type": "string", "readOnly": true, "example": "a" }, "homeFrame": { "title": "Строение дома", "type": "string", "readOnly": true, "example": null }, "callReceivers": { "type": "array", "items": { "$ref": "#/components/schemas/ICallReceiver" }, "readOnly": true } }, "type": "object" }, "ICallController": { "title": "Контролёр обращения", "description": "Данные по пользователю-контролёру обращения", "properties": { "id": { "title": "id ресурса сущности controllers. Мне он не нужен, но пусть будет", "type": "integer", "readOnly": true, "example": 2 }, "callReceiverId": { "title": "id ресурса получателя обращения (call_receivers)", "type": "integer", "readOnly": true, "example": 55 }, "userId": { "title": "id пользователя (users.id)", "type": "integer", "example": 5 }, "userName": { "title": "логин пользователя-контролёра", "type": "string", "readOnly": true, "example": "DebetOra02" }, "userFIO": { "title": "ФИО пользователя-контролёра", "type": "string", "readOnly": true, "example": "Иванов И.И." }, "controllerStatus": { "title": "Ненужная мне переменная, но очень ее хочет фронт. Наверное для связки", "type": "string", "example": "NORMAL" } }, "type": "object" }, "ICallReceiver": { "title": "Получатели обращений", "description": "Список получателей обращений", "properties": { "id": { "title": "id ресурса сущности call_receiver", "type": "integer", "example": 2 }, "timing": { "title": "координатор обращений по времени", "type": "string", "example": "ANY_TIME" }, "startEmergencyTime1": { "title": "время начала аварийного времени в рабочий день", "type": "string", "example": "18:00" }, "startEmergencyTime2": { "title": "время начала аварийного времени в предпраздничный день", "type": "string", "example": "17:00" }, "stopEmergencyTime": { "title": "время окончания аварийного времени в рабочий день", "type": "string", "example": "08:59" }, "setId": { "title": "id набора папок(folder_sets)", "type": "integer", "example": 5 }, "firmId": { "title": "id записи firms, которой будет направлено обращение", "type": "integer", "readOnly": true, "example": 3 }, "firmName": { "title": "Наименование записи firms, которой будет направлено обращение", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "divisionId": { "title": "id записи divisions, которой будет направлено обращение, если setId принадлежит divisions", "type": "integer", "readOnly": true, "example": 3 }, "divisionName": { "title": "Наименование записи divisions, которой будет направлено обращение, если setId принадлежит divisions", "type": "string", "readOnly": true, "example": "Участок-2" }, "receiverStatus": { "title": "Ненужная мне переменная, но очень ее хочет фронт. Наверное для связки", "type": "string", "example": "NORMAL" }, "controllers": { "type": "array", "items": { "$ref": "#/components/schemas/ICallController" } } }, "type": "object" }, "IFirmGroupReceiver": { "title": "Группа правил регистрации обращений", "description": "Вывод информации по группам фирмы", "properties": { "id": { "title": "id ресурса сущности firm_to_firm_contracts", "type": "integer", "readOnly": true, "example": 2 }, "note": { "title": "Наименование группы правил", "type": "integer", "example": 5 } }, "type": "object" }, "GroupReceiverCollection": { "title": "Ресурс для просмотра списка групп регистрации обращений", "properties": { "data": { "title": "массив со списком групп", "type": "array", "items": { "$ref": "#/components/schemas/IGroupReceiver" } } }, "type": "object" }, "IGroupReceiver": { "title": "Группа правил регистрации обращений", "description": "Вывод информации по группе правил с подчиненной структурой", "properties": { "id": { "title": "id ресурса сущности firm_to_firm_contracts", "type": "integer", "readOnly": true, "example": 2 }, "note": { "title": "id ресурса заказчика", "type": "integer", "example": 5 }, "firmId": { "title": "Наименование заказчика", "type": "string", "example": 3 }, "firmName": { "title": "id ресурса подрядчика", "type": "integer", "readOnly": true, "example": "ООО Ромашка" }, "groupTopics": { "type": "array", "items": { "$ref": "#/components/schemas/IGroupTopic" } }, "callReceivers": { "type": "array", "items": { "$ref": "#/components/schemas/ICallReceiver" } } }, "type": "object" }, "IGroupTopic": { "title": "Тема для группы получателей обращений", "description": "Вывод информации по теме обращения для группы правил", "properties": { "id": { "title": "id линковой записи. Мне не нужная хрень, но пусть будет", "type": "integer", "readOnly": true, "example": 2 }, "topicId": { "title": "id ресурса темы обращения", "type": "integer", "example": 5 }, "topicName": { "title": "Наименование темы обращения", "type": "string", "readOnly": true, "example": "Отопление в жопе" }, "topicStatus": { "title": "Состояние записи (NORMAL, CREATED, UPDATED, DELETED)", "type": "string", "example": "NORMAL" } }, "type": "object" }, "IHomeGroupReceiver": { "title": "Группа правил регистрации обращений при просмотре через дом", "description": "Вывод информации по правил приема обращения со стороны дома", "properties": { "id": { "title": "id ресурса сущности group_receivers", "type": "integer", "readOnly": true, "example": 2 }, "note": { "title": "наименование группы", "type": "string", "example": "аварийные обращения" }, "firmId": { "title": "id ресурса firms, которой принадлежит группа регистрации обращений", "type": "integer", "example": 5 }, "firmName": { "title": "наименование организации firms.firm_name, которой принадлежит группа регистрации обращений", "type": "string", "example": "ООО Ромашка" }, "startDate": { "title": "дата начала, с которой адрес подключен к группе правил регистрации обращений", "type": "string", "example": "2025-05-01" }, "endDate": { "title": "дата окончания, по которую адрес подключен к группе правил регистрации обращений", "type": "string", "example": null }, "homeReceiverId": { "title": "id ресурса связной таблицы (address_receiver)", "type": "integer", "readOnly": true, "example": 2 }, "homeId": { "title": "ID дома", "type": "integer", "readOnly": true, "example": 3 }, "streetPrefixName": { "title": "тип улицы", "type": "string", "readOnly": true, "example": "улица" }, "streetName": { "title": "наименование улицы", "type": "string", "readOnly": true, "example": "Ворошилова" }, "homeNumber": { "title": "номер дома", "type": "string", "readOnly": true, "example": "12" }, "homeCorp": { "title": "корпус дома", "type": "string", "readOnly": true, "example": null }, "homeFrame": { "title": "строение дома", "type": "string", "readOnly": true, "example": null }, "homeStreetId": { "title": "ID адреса (home_street.id)", "type": "integer", "readOnly": true, "example": 1 } }, "type": "object" }, "INewCallReceiver": { "title": "Получатели обращений по указанному адресу и теме", "description": "Список получателей обращений по адерсу и теме", "properties": { "id": { "title": "id ресурса сущности call_receiver", "type": "integer", "example": 2 }, "groupId": { "title": "ID ресурса группы правил регистрации обращений (group_receivers.id)" }, "folderSetId": { "title": "id набора папок (таблица folder_sets), в которую надо отправить обращение", "type": "integer", "example": 5 }, "mainFirmId": { "title": "id УК/РСО обслуживающей адрес (определяется из firmHomeId)", "type": "integer", "example": 5 }, "firmId": { "title": "id записи firms, которой будет направлено обращение", "type": "integer", "readOnly": true, "example": 3 }, "firmName": { "title": "Наименование записи firms, которой будет направлено обращение", "type": "string", "readOnly": true, "example": "ООО Ромашка" }, "divisionId": { "title": "id записи divisions, которой будет направлено обращение, если setId принадлежит divisions", "type": "integer", "readOnly": true, "example": 3 }, "divisionName": { "title": "Наименование записи divisions, которой будет направлено обращение, если setId принадлежит divisions", "type": "string", "readOnly": true, "example": "Участок-2" }, "emergency": { "title": "Признак аварийности: true - для заявок в нерабочее время", "type": "boolean", "example": false }, "firmHomeId": { "title": "ID записи договора-управления (firm_homes.id)", "type": "integer", "example": 3 }, "contractorHomeId": { "title": "ID связной записи договора-управления и подрядчика(contractor_homes.id)", "type": "integer", "example": 3 } }, "type": "object" }, "ICallReceiverSelectable": { "title": "Ресурс о выводе потенциального получателя обращения", "description": "Вывод информации по теме обращения для группы правил", "properties": { "firmId": { "title": "id УК/РСО или подрядчика ", "type": "integer", "example": 2 }, "firmName": { "title": "Наименование УК/РСО или подрядчика", "type": "string", "readOnly": true, "example": "ООО \"Ромашка\"" }, "divisionId": { "title": "ID участка подрядчика", "type": "integer", "example": 555 }, "divisionName": { "title": "Наименование участка подрядчика", "type": "string", "readOnly": true, "example": "участок - 1" }, "mainFirmId": { "title": "ID УК/РСО обслуживающей этот дом (firm_homes.firm_id)", "type": "integer", "example": 666 }, "firmHomeId": { "title": "ID договора управления по адресу", "type": "integer", "readOnly": true, "example": 666 }, "contractorHomeId": { "title": "ID договора подрядной организации по адресу", "type": "integer", "readOnly": true, "example": 666 }, "folderSetId": { "title": "ID набора папок полученного предприятия", "type": "integer", "example": 777 } }, "type": "object" }, "RegionHist": { "title": "RegionHist - архив изменения данных в модели Region", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "region_name": { "title": "Полное наименование субъекта", "type": "string", "example": "Еврейская автономная область" }, "region_short_name": { "title": "Сокращенное наименование субъекта", "type": "string", "example": "ЕАО" }, "region_code": { "title": "цифровой код региона (ГИБДД, ФНС) можно не указывать", "type": "string", "example": "79" }, "region_iso_code": { "title": "Оказывается есть код в ISO у каждого региона. можно не указывать", "type": "string", "example": "RU-YEV" }, "region_gost_code": { "title": "так же существует код по ГОСТу", "type": "string", "example": "RU-JEW" }, "region_fias": { "title": "1b507b09-48c9-434f-bf6f-65066211c73e", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "region_okato": { "title": "Код ОКАТО", "type": "string", "example": "99000000000" }, "userFio": { "title": "ФИО пользователя, который эти данные занес", "type": "string", "example": "Петров" }, "updated": { "title": "дата когда эти изменения появились в базе", "type": "string", "example": "2022-11-11" }, "archDate": { "title": "Дата и время удаления записи", "type": "string", "example": null } }, "type": "object" }, "Region": { "title": "Region - описание субъекта РФ", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Полное наименование субъекта", "type": "string", "example": "Еврейская автономная область" }, "shortName": { "description": "Сокращенное наименование субъекта", "type": "string", "example": "ЕАО" }, "code": { "description": "цифровой код региона (ГИБДД, ФНС) можно не указывать", "type": "string", "example": "79" }, "isoCode": { "description": "Оказывается есть код в ISO у каждого региона. можно не указывать", "type": "string", "example": "RU-YEV" }, "gostCode": { "description": "так же существует код по ГОСТу", "type": "string", "example": "RU-JEW" }, "fias": { "description": "код фиас", "type": "string", "example": "1b507b09-48c9-434f-bf6f-65066211c73e" }, "okato": { "description": "Код ОКАТО", "type": "string", "example": "99000000000" } }, "type": "object" }, "ICallByFirmReportRequest": { "title": "Параметры запроса для отчета \"Сводный отчет по обращениям\"", "properties": { "emergency": { "title": "Какие обращения по признаку аварийности выводить(null-все, true-аварийные; false-не аварийные", "type": "null|boolean", "example": null }, "breakdown": { "title": "тип отчета: \"folder\", \"topic\", \"subtopic\"", "type": "string", "example": "folder" }, "startDate": { "title": "Дата начала интервала отчета", "type": "string", "example": "2026-07-01" }, "endDate": { "title": "Дата окончания интервала отчета", "type": "string", "example": "2026-07-31" }, "customerId": { "title": "ID УК/РСО по которой делается отчет", "type": "integer", "example": 45 }, "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/IFirmToFirmContract" } }, "topics": { "type": "array", "items": { "$ref": "#/components/schemas/CallTopic" } } }, "type": "object" }, "ICallsRegistryReportRequest": { "title": "Параметры запроса для отчета 'Реестр обращений'", "properties": { "firmId": { "title": "ID организации по договору (УК/РСО)", "type": "integer", "example": null }, "contractorFirmId": { "title": "ID подрядной организации-получателя", "type": "integer", "example": null }, "contractorDivisionId": { "title": "ID подразделения/участка подрядной организации-получателя", "type": "integer", "example": null }, "workPlaceId": { "title": "ID рабочего места, где было принято обращение", "type": "integer", "example": null }, "callNumber": { "title": "Номер обращения", "type": "string", "example": null }, "callId": { "title": "ID обращения", "type": "integer", "example": null }, "fio": { "title": "ФИО заявителя", "type": "string", "example": null }, "cityId": { "title": "ID населенного пункта", "type": "integer", "example": null }, "streetId": { "title": "ID улицы", "type": "integer", "example": null }, "addressId": { "title": "ID адреса", "type": "integer", "example": null }, "flatId": { "title": "ID квартиры", "type": "integer", "example": null }, "topicId": { "title": "ID темы", "type": "integer", "example": null }, "subtopicId": { "title": "ID подтемы", "type": "integer", "example": null }, "emergency": { "title": "Признак аварийности", "type": "boolean", "example": null }, "callerPhone": { "title": "Телефон жителя", "type": "string", "example": null }, "dateStart": { "title": "Дата начала периода", "type": "string", "example": null }, "dateEnd": { "title": "Дата окончания периода", "type": "string", "example": null }, "folderId": { "title": "Идентификатор папки", "type": "integer", "example": null }, "isActive": { "title": "Признак активности (true - активные; false|null - все)", "type": "boolean", "example": null }, "controlUserId": { "title": "ID пользователя, у которого обращение находится/находилось на контроле", "type": "integer", "example": null }, "finished": { "title": "true - полностью завершенные; false - не завершенные; null - все", "type": "boolean", "example": null }, "underControl": { "title": "true - находящиеся на контроле; false - сняты с контроля; null - все", "type": "boolean", "example": null }, "folderSetId": { "title": "Идентификатор набора папок", "type": "integer", "example": null }, "folderSetValid": { "title": "Признак действительности набора папок", "type": "boolean", "example": null }, "format": { "title": "Формат экспорта отчета", "type": "string", "example": "pdf" } }, "type": "object" }, "IReportResponse": { "title": "Ответ на запуск отчета (теоретически любого)", "properties": { "id": { "title": "ID записи report_results", "type": "integer", "readOnly": true, "example": 425 }, "status": { "title": "Статус генерации отчета", "type": "string", "readOnly": true, "example": "completed" }, "progress": { "title": "Прогресс генерации (0-100)", "type": "integer", "readOnly": true, "example": 100 }, "error": { "title": "Сообщение об ошибке (если есть)", "type": "string", "readOnly": true, "example": null }, "createdAt": { "title": "Дата создания", "type": "string", "readOnly": true, "example": "2025-10-20 11:12" }, "completedAt": { "title": "Дата завершения", "type": "string", "readOnly": true, "example": "2025-10-20 11:15" }, "header": { "title": "Заголовок отчета", "type": "string", "readOnly": true, "example": "Отчет по обращениям" } }, "type": "object" }, "IMagazineRegistryReportRequest": { "title": "Параметры запроса для отчета 'Оперативный журнал'", "properties": { "cityId": { "title": "ID населенного пункта", "type": "integer", "example": null }, "streetId": { "title": "ID улицы", "type": "integer", "example": null }, "addressId": { "title": "ID адреса", "type": "integer", "example": null }, "factDate": { "title": "На какую дату. Фильтр по дате фактического отсутствия услуги.", "type": "string", "example": null }, "utilityId": { "title": "ID услуги", "type": "integer", "example": null }, "format": { "title": "формат отчета", "type": "string", "example": "xlsx" } }, "type": "object" }, "Resource": { "title": "Resource - таблица ресурсов системы", "description": "Список сущностей (объектов), к которым можно применять различные права доступа пользователей", "properties": { "id": { "description": "Идентификатор ресурса", "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Наименование ресурса", "type": "string", "example": "FIRM" }, "description": { "description": "Описание ресурса", "type": "string", "example": "Ресурс для модели \"Организации\"" } }, "type": "object" }, "ResourceTemplate": { "title": "ResourceTemplate - Шаблонные разрешения для выбранного ресурса, у данного шаблона.", "description": "Информация, описывающая шаблон: какие разрешения и для каких ресурсов", "properties": { "id": { "description": "Идентификатор записи в таблице resource_templates", "type": "integer", "readOnly": true, "example": 1 }, "resource_id": { "description": "Идентификатор ресурса в таблице resources", "type": "integer", "example": 2 }, "template_id": { "description": "Идентификатор шаблона в таблице templates", "type": "integer", "example": 5 }, "temp_access": { "description": "Шаблон доступа к ресурсу", "type": "string", "example": "C0R0U0D0X0" }, "owner_name": { "description": "Наименование владельца - шаблона или ресурса", "type": "string", "example": "SYSTEM" } }, "type": "object" }, "ResourceTemplateShow": { "title": "ResourceTemplateShow - Просмотр строки из таблицы resource_templates", "description": "строка из таблицы resource_templates", "properties": { "id": { "description": "Идентификатор записи в таблице resource_templates", "type": "integer", "readOnly": true, "example": 1 }, "resource_id": { "description": "Идентификатор ресурса в таблице resources", "type": "integer", "example": 2 }, "template_id": { "description": "Идентификатор шаблона в таблице templates", "type": "integer", "example": 5 }, "temp_access": { "description": "Шаблон доступа к ресурс", "type": "string", "example": "C0R0U0D0" }, "resource_name": { "description": "Наименование ресурса", "type": "string", "example": "ITEM" }, "template_name": { "description": "Наименование шаблона", "type": "string", "example": "SYSTEM" } }, "type": "object" }, "StreetHist": { "title": "StreetHist - архив изменений улицы", "description": "Описание вывода данных из таблицы архива изменений улицы (street_hists)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "shortType": { "title": "тип улицы", "type": "string", "example": "ул." }, "name": { "title": "Наименование улицы", "type": "string", "example": "Оборонная" }, "fias": { "title": "ФИАС улицы", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "streetTypeId": { "title": "Ссылка на ресурс типа улицы (street_type)", "type": "integer", "example": 1 }, "updated": { "title": "Когда внесли указанные данные", "type": "string", "example": "20-11-2020 11:34" }, "userFio": { "title": "Имя пользователя", "type": "string", "example": "Иванов" }, "archDate": { "title": "Дата и время удаления записи", "type": "string", "example": null }, "city": { "$ref": "#/components/schemas/City" } }, "type": "object" }, "Street": { "title": "Street - улицы", "description": "Описание вывода данных из таблицы улиц (streets)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "readOnly": true, "example": 1 }, "shortType": { "title": "тип улицы", "type": "string", "example": "ул." }, "name": { "title": "Наименование улицы", "type": "string", "example": "Оборонная" }, "fias": { "title": "ФИАС улицы", "type": "string", "example": "92082bf1-40e5-41a0-9304-e3bf74c24e7b" }, "user_fio": { "title": "Пользователь, внесший изменения", "type": "string", "example": "Иванов Иван Иванович" }, "streetTypeId": { "title": "Ссылка на ресурс типа улицы (street_type)", "type": "integer", "example": 1 }, "city": { "$ref": "#/components/schemas/City" } }, "type": "object" }, "StreetTypeHist": { "title": "StreetTypeHist - архив улиц типов улиц", "description": "описание модели типа улиц (StreetTypeHist)", "properties": { "id": { "description": "Ресурсный класс для работы с моделью StreetType", "type": "integer", "readOnly": true, "example": 1 }, "full_type": { "description": "Наименование типа улицы", "type": "string", "example": "переулок" }, "short_type": { "description": "сокращенное наименование типа улицы", "type": "string", "example": "пер." }, "updated": { "description": "Когда внесли указанные данные", "type": "string", "example": "20-11-2020 11:34" }, "user_fio": { "description": "Имя пользователя", "type": "string", "example": "Иванов" }, "arch_date": { "description": "Дата и время удаления записи", "type": "string", "example": null } }, "type": "object" }, "StreetType": { "title": "StreetType - типы улиц.", "description": "описание модели типа улиц (StreetType)", "properties": { "id": { "description": "Ресурсный класс для работы с моделью StreetType", "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "Наименование типа улицы", "type": "string", "example": "переулок" }, "shortName": { "description": "сокращенное наименование типа улицы", "type": "string", "example": "пер." } }, "type": "object" }, "Template": { "title": "Template - Шаблоны рабочего места", "description": "Данные о шаблонах рабочего места", "properties": { "id": { "description": "Идентификатор записи в таблице templates", "type": "integer", "readOnly": true, "example": 23 }, "name": { "description": "Шаблон рабочего места системного администратора", "type": "string", "example": "SYSTEM" }, "description": { "description": "string|null", "type": "Описание шаблона рабочего места", "example": "Данный шаблон даёт полный доступ ко всем объектам программы" } }, "type": "object" }, "TemplateUserCollection": { "title": "Получение списка шаблонов пользователя", "properties": { "data": { "title": "Массив со списком шаблонов пользователя", "type": "array", "items": { "$ref": "#/components/schemas/TemplateUserIndex" } } }, "type": "object" }, "TemplateUserIndex": { "title": "TemplateUser - Список пользователей и их шаблоны", "description": "Информация, описывающая какие пользователи к каким шаблонам привязаны.", "properties": { "id": { "title": "ресурс записи template_users", "type": "integer", "readOnly": true, "example": 11 }, "userId": { "title": "Идентификатор пользователя в таблице users", "type": "integer", "example": 11 }, "userName": { "title": "Логин пользователя из таблице users", "type": "string", "example": "Admin" }, "userFio": { "title": "ФИО пользователя из таблице users", "type": "string", "example": "Иванов Иван Иванович" }, "templateId": { "title": "Идентификатор шаблона в таблице templates", "type": "integer", "example": 5 }, "templateName": { "title": "Наименование шаблона", "type": "string", "example": "Администратор базы данных" }, "templateDescr": { "title": "Описание шаблона", "type": "string", "example": "Про шаблон в двух словах" }, "userFirms": { "title": "список организаций пользователя", "type": "array", "items": { "$ref": "#/components/schemas/IUserFirm" } } }, "type": "object" }, "TemplateUser": { "title": "TemplateUser - Список пользователей, владеющих данным шаблоном рабочего места.", "description": "Информация, описывающая какие пользователи к каким шаблонам привязаны.", "properties": { "user_id": { "description": "Идентификатор пользователя в таблице users", "type": "integer", "example": 11 }, "template_id": { "description": "Идентификатор шаблона в таблице templates", "type": "integer", "example": 5 }, "owner_name": { "description": "ФИО пользователя", "type": "string", "example": "Иванов И.И." } }, "type": "object" }, "Token": { "title": "Token - Данные о токене пользователя", "properties": { "token": { "title": "Вновь сформированный токен для работы пользователя", "type": "string", "example": "2|E6sDZzwSKiaCqSnAPBDYoZ6E9HRlR9NIrrl0Xfaz" }, "tokenLifeTimeInMin": { "title": "Время жизни токена в минутах", "type": "integer", "example": 10080 }, "tokenCreatedDate": { "title": "Для использования фронтом", "type": "Date|null", "example": null }, "tokenExpirationDate": { "title": "Для использования фронтом", "type": "Date|null", "example": null }, "tokenExpirationTime": { "title": "Для использования фронтом", "type": "integer|null", "example": null }, "refreshToken": { "title": "refresh token", "type": "string", "example": "3|E6sDZzwSKiophjnAPBDYoZ6E9HRlR9NIrrl0Xfaz" }, "refreshTokenExpiresAt": { "title": "дата истечения refresh tokens", "type": "Date|null", "example": "2026-05-24 14:04:45" } }, "type": "object" }, "CallSubTopic": { "title": "CallSubTopic - подтемы.", "description": "Вывод данных для описания таблицы подтем(sub_topics)", "properties": { "id": { "title": "номер ресурса", "description": "Ресурсный класс для вывода данных по подтеме.", "type": "integer", "example": 1 }, "topicId": { "title": "ресурс темы-владельца", "type": "integer", "example": 1 }, "name": { "title": "Наименование подтемы", "type": "string", "example": "Протекание трубы" }, "reportOrder": { "schema": "integer|null", "title": "номер в отчете по-порядку", "type": "integer|null", "example": 2 }, "canBeCrash": { "title": "Признак аварийности для подтемы", "type": "boolean", "example": false }, "crashHours": { "schema": "integer|null", "title": "Лимит часов для ликвидации аварийной ситуации", "type": "integer|null", "example": null }, "subTopicState": { "title": "Служебное поле (для использования фронтом)", "type": "string", "example": "NORMAL" }, "forTenant": { "title": "Служебное поле. True - доступно населению для самостоятельного выбора", "type": "boolean", "example": true }, "utilityId": { "title": "Код жилищно-коммунальной услуги", "type": "integer|null", "example": 1 }, "utilityName": { "title": "Наименование жилищно-коммунальной услуги", "type": "string", "readOnly": true, "example": "горячая вода" }, "questionnairesId": { "title": "ссылка на файл с опросником для подтемы", "type": "integer|null", "example": 1 }, "questionnairesFileName": { "title": "имя файла с опросником для подтемы", "type": "string|null", "example": "for_themeOne.pdf" }, "gisThemaId": { "title": "код записи справочника тем из ГИС ЖКХ", "type": "integer|null", "example": 44 }, "gisThemaCode": { "title": "кодировка их справочника тем ГИС ЖКХ", "type": "string|null", "readOnly": true, "example": "10.1" }, "gisThemaActualName": { "title": "наименование темы обращения из справочника ГИС ЖКХ", "type": "string|null", "readOnly": true, "example": "Проблемы с вывозом мусора" }, "gisThemaGuid": { "title": "уникальный код из справочника ГИС ЖКХ у наименования темы в ГИС ЖКХ", "type": "string|null", "readOnly": true, "example": "dcde5a73-2b4f-3e09-83a1-6691640933eb" } }, "type": "object" }, "TopicCollection": { "title": "Call Topics - вывод всех действующих тем и их подтем", "properties": { "data": { "title": "массив в выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/CallTopic" } } }, "type": "object" }, "CallTopic": { "title": "CallTopic - темы.", "description": "Вывод данных для описания таблицы тем обращений(call_topics)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "name": { "title": "Наименование темы", "type": "string", "example": "Электроснабжение" }, "reportOrder": { "schema": "integer|null", "title": "номер в отчете по-порядку", "type": "integer|null", "example": 2 }, "topicState": { "title": "Служебное поле (для использования фронтом)", "type": "string", "example": "NORMAL" }, "forTenant": { "title": "Служебное поле. True - доступно населению для самостоятельного выбора", "type": "boolean", "example": true }, "virtual": { "title": "Признак темы виртуального оператора. Пока, теоретически, эта тема должна быть одна", "type": "boolean", "example": false }, "subTopics": { "type": "array", "items": { "$ref": "#/components/schemas/CallSubTopic" } } }, "type": "object" }, "IGisThemaCollection": { "title": "Общий список тем, выгруженных из ГИС ЖКХ", "description": "Информация о списке обращений ГИС ЖКХ", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/IGisThema" } } }, "type": "object" }, "IGisThemaName": { "title": "GisThemaName - архив изменения наименования темы с ГИС ЖКХ.", "description": "Просмотр данных записи GisThemaName", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "name": { "title": "Наименование темы/подтемы", "type": "string", "example": "Комфортная городская среда" }, "isActual": { "title": "Признак действующей записи", "type": "boolean", "example": true }, "guid": { "title": "GUID записи темы обращения", "type": "string", "example": "da6b80ed-9ad3-4739-a0c5-00dc6b942aef" }, "modifyDate": { "title": "Дата и время изменения записи в ГИС ЖКХ", "type": "string", "example": "2022-04-29T13:57:26.437+03:00" } }, "type": "object" }, "IGisThema": { "title": "GisThema - темы выгруженные с ГИС ЖКХ.", "description": "Вывод данных о теме с ГИС ЖКХ", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "gisCode": { "title": "Код темы из ГИС ЖКХ", "type": "string", "example": "16.4" }, "level": { "title": "Уровень вложенности иерархии", "type": "integer", "example": 2 }, "parentId": { "title": "Id записи владельца текущей иерархии. ", "type": "integer|null", "example": 5 }, "actualName": { "title": "Текущее наименование темы обращения и ГИС ЖКХ", "type": "string", "example": "Проблемы внутри квартиры" }, "actualGuid": { "title": "уникальный id из базы ГИС ЖКХ для актуальной темы обращения", "type": "string", "example": "da6b80ed-9ad3-4739-a0c5-00dc6b942aef" }, "gisNames": { "type": "array", "items": { "$ref": "#/components/schemas/IGisThemaName" } } }, "type": "object" }, "ILogUser": { "title": "User - вывод данных пользователя при его входе в систему", "description": "описание модели Пользователь (User) при аутентификации", "properties": { "id": { "description": "Сюда теперь прилетает не модель (Eloquent\\Builder), а просто данные из запроса. Поэтому первым делом читаем данные по пользователю.", "type": "integer", "readOnly": true, "example": 1 }, "name": { "description": "логин пользователя", "type": "string", "example": "pavlov" }, "fio": { "description": "ФИО пользователя", "type": "string", "example": "Павлов Ю.С." }, "phone": { "description": "Телефон пользователя", "type": "string", "example": "(890)-948-99-00" }, "email": { "description": "Email пользователя", "type": "string", "example": "mygod@skyline.god" }, "defaultUserFirmId": { "description": "Ресурс firm_users основного предприятия", "type": "integer", "example": 45 }, "currentUserFirmId": { "description": "текущее предприятие. Используется только фронтом", "type": "integer", "example": 45 }, "userWorkPlaceId": { "description": "идентификатор рабочего места", "type": "integer", "example": 1 }, "firmId": { "description": "ресурс фирмы, которой принадлежит пользователь", "type": "integer", "example": 5 }, "firmName": { "description": "наименование фирмы, которой принадлежит пользователь", "type": "string", "readOnly": true, "example": "ООО \"Ромашка\"" }, "firmRank": { "description": "тип организации", "type": "integer", "readOnly": true, "example": 1 }, "cityId": { "title": "код населенного пункта, в котором работает фирма(организация)" }, "cityName": { "title": "наименование населенного пункта, в котором работает фирма(организация)" }, "divisionId": { "description": "ресурс подразделения пользователя", "type": "integer", "example": null }, "divisionName": { "description": "наименование подразделения", "type": "string", "readOnly": true, "example": "ПТО" }, "emrg": { "description": "Признак АДС: true - участок является АДС", "type": "boolean", "readOnly": true, "example": false }, "deletedAt": { "description": "Дата окончания работы пользователя с организацией по умолчанию", "type": "string|null", "example": null }, "userFirms": { "title": "список организаций пользователя", "type": "array", "items": { "$ref": "#/components/schemas/IUserFirm" } } }, "type": "object" }, "IUser": { "title": "Вывод данных о пользователе", "description": "Выводим данные пользователе при CRUD работе", "properties": { "id": { "title": "код ресурса пользователя", "type": "integer", "readOnly": true, "example": 1 }, "name": { "title": "логин пользователя", "type": "string", "example": "pavlov" }, "fio": { "title": "ФИО пользователя", "type": "string", "example": "Павлов Ю.С." }, "phone": { "title": "телефон пользователя", "type": "string", "example": "8-914-888-88-88" }, "email": { "title": "email пользователя", "type": "string", "example": "lk@mail.ru" }, "password": { "title": "password пользователя (только для ввода)", "type": "string", "example": "123456_GOD" }, "templateUserId": { "title": "ID пользователя, с которого копируем шаблоны для текущего пользователя.", "type": "integer", "example": 45 }, "userFirms": { "title": "список организаций пользователя", "type": "array", "items": { "$ref": "#/components/schemas/IUserFirm" } } }, "type": "object" }, "UserTemplate": { "title": "UserTemplate - Список шаблонов рабочего места у пользователя.", "description": "Информация, описывающая какими шаблоны подключены к пользователю.", "properties": { "user_id": { "description": "Идентификатор пользователя в таблице users", "type": "integer", "example": 11 }, "template_id": { "description": "Идентификатор шаблона в таблице templates", "type": "integer", "example": 5 }, "owner_name": { "description": "ФИО пользователя", "type": "string", "example": "Иванов И.И." } }, "type": "object" }, "IUtilityCollection": { "title": "Список услуг", "description": "Информация о списке жилищно-коммунальных услуг", "properties": { "data": { "title": "Собственно сам список", "type": "array", "items": { "$ref": "#/components/schemas/IUtility" } } }, "type": "object" }, "IUtility": { "title": "Данные для ввода жилищно-коммунальных услуг", "properties": { "id": { "title": "ID услуги (utilities.id)", "type": "integer", "readOnly": true, "example": 45 }, "name": { "title": "наименование услуги", "type": "string", "example": "Отопление" } }, "type": "object" }, "WorkPlace": { "title": "WorkPlace - рабочее место пользователя", "description": "Это структура для обработки пунктов меню", "properties": { "id": { "description": "код ресурса в таблице work_places", "type": "integer", "example": 11 }, "name": { "description": "наименование рабочего места", "type": "string", "example": "Операторы" } }, "type": "object" }, "SubWorkTypeCollection": { "title": "SubWorkType - Список всех подвидов работ у вида работ с их структурой", "properties": { "data": { "title": "массив в выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/SubWorkType" } } }, "type": "object" }, "SubWorkType": { "title": "SubWorkType - подвиды работ.", "description": "Вывод данных для сущности подвиды работ (sub_work_types)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "workTypeId": { "title": "ресурс ", "type": "integer", "example": 1 }, "name": { "title": "Наименование вида работ", "type": "string", "example": "Электроснабжение" }, "reportOrder": { "title": "номер в отчете по-порядку", "type": "integer", "example": 2 }, "subState": { "title": "Служебное поле (для использования фронтом)", "type": "string", "example": "NORMAL" }, "subWorkSections": { "type": "array", "items": { "$ref": "#/components/schemas/SubWorkTypeSection" } } }, "type": "object" }, "SubWorkTypeSectionCollection": { "title": "SubWorkTypeSection - Список всех разделов у подвида работ с их структурой", "properties": { "data": { "title": "массив в выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/SubWorkTypeSection" } } }, "type": "object" }, "SubWorkTypeSection": { "title": "SubWorkTypeSection - раздел видов работ.", "description": "Вывод данных для сущности раздел видов работ (sub_work_type_sections)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "subWorkId": { "title": "ресурс владельца ", "type": "integer", "example": 1 }, "workId": { "title": "ресурс вида работ", "type": "integer", "example": 1 }, "name": { "title": "Наименование вида работ", "type": "string", "example": "Электроснабжение" }, "reportOrder": { "title": "номер в отчете по-порядку", "type": "integer", "example": 2 }, "sectionState": { "title": "Служебное поле (для использования фронтом)", "type": "string", "example": "NORMAL" } }, "type": "object" }, "WorkTypeCollection": { "title": "WorkType - Список вывод всех действующих видов работ с их структурой", "properties": { "data": { "title": "массив в выходными данными", "type": "array", "items": { "$ref": "#/components/schemas/WorkType" } } }, "type": "object" }, "WorkType": { "title": "WorkType - виды работ.", "description": "Вывод данных для сущности виды работ (work_types)", "properties": { "id": { "title": "номер ресурса", "type": "integer", "example": 1 }, "name": { "title": "Наименование вида работ", "type": "string", "example": "Электроснабжение" }, "reportOrder": { "title": "номер в отчете по-порядку", "type": "integer", "example": 2 }, "typeState": { "title": "Служебное поле (для использования фронтом)", "type": "string", "example": "NORMAL" }, "subTypes": { "type": "array", "items": { "$ref": "#/components/schemas/SubWorkType" } } }, "type": "object" } }, "securitySchemes": { "Token": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "tags": [ { "name": "Login", "description": "Работа с аутентификацией и пользователями" }, { "name": "Authorization", "description": "Управление авторизацией пользователей" }, { "name": "Menu", "description": "Работа с главным меню" }, { "name": "Properties", "description": "Работа со свойствами" }, { "name": "Firm", "description": "Обслуживающие организации и их структура" }, { "name": "Address", "description": "Справочники адресов" }, { "name": "Folders", "description": "Работа с папками движения обращений" }, { "name": "Catalog", "description": "Общие справочники" }, { "name": "Receiver", "description": "Получатели обращений" }, { "name": "Calls", "description": "Работа с обращениями" }, { "name": "Magazine", "description": "Оперативный журнал" }, { "name": "Reports", "description": "Отчеты" } ] }