Регламент - Реформа ЖКХ

реклама
ГК - Фонд содействия реформированию ЖКХ
РЕГЛАМЕНТ ЭЛЕКТРОННОГО ВЗАИМОДЕЙСТВИЯ С
ИНФОРМАЦИОННЫМИ СИСТЕМАМИ РЕГИОНАЛЬНОГО И
МУНИЦИПАЛЬНОГО УРОВНЯ В РАМКАХ ОБМЕНА ИНФОРМАЦИИ ПО
ПОСТАНОВЛЕНИЮ ПРАВИТЕЛЬСТВА РОССИЙСКОЙ ФЕДЕРАЦИИ ОТ
23 СЕНТЯБРЯ 2010 ГОДА №731
Версия 1.0.32
Москва 2016
СОДЕРЖАНИЕ
СОДЕРЖАНИЕ ..............................................................................................................................2
1
ОБЩИЕ СВЕДЕНИЯ ............................................................................................................4
2
СТРУКТУРА XML-ДОКУМЕНТОВ ...................................................................................5
3
ПЕРЕЧЕНЬ МЕТОДОВ.........................................................................................................6
4
СХЕМА ВЫЗОВА МЕТОДОВ ...........................................................................................10
5
ОПИСАНИЕ МЕТОДОВ.....................................................................................................16
5.1
Метод Logout .................................................................................................................20
5.2
Метод SetRequestForSubmit .........................................................................................21
5.3
Метод GetRequestList ....................................................................................................23
5.4
Метод GetReportingPeriodList ......................................................................................25
5.5
Метод SetCompanyProfile .............................................................................................27
5.6
Метод SetNewCompany ................................................................................................58
5.7
Метод GetHouseList ......................................................................................................62
5.8
Метод SetUnlinkFromOrganization ...............................................................................66
5.9
Метод SetHouseLinkToOrganization .............................................................................69
5.10 Метод SetHouseProfile ..................................................................................................71
5.11 Метод SetNewHouse ....................................................................................................100
5.12 Метод GetHouseInfo ....................................................................................................102
5.13 Метод SetUploadFile ...................................................................................................105
5.14 Метод GetFileByID ......................................................................................................107
5.15 Метод GetCompanyProfile .......................................................................................... 110
5.16 Метод GetHouseProfile ................................................................................................ 112
5.17 Метод GetCompanyProfileSF ...................................................................................... 115
5.18 Метод GetHouseProfileSF ........................................................................................... 118
5.19 Метод GetCompanyProfileSF988 ................................................................................121
5.20 Метод GetCompanyProfile988 ....................................................................................133
5.21 Метод GetHouseProfileSF988 .....................................................................................135
5.22 Метод GetHouseProfile988 ..........................................................................................180
5.23 Метод SetCompanyProfile988 .....................................................................................182
5.24 Метод SetHouseProfile988 ..........................................................................................187
6 СОСТАВ ПОКАЗАТЕЛЕЙ АНКЕТ, СОГЛАСНО ПОСТАНОВЛЕНИЮ
ПРАВИТЕЛЬСТВА РФ №731 от 23.09.2010, КОТОРЫЕ НЕ МОГУТ ПРИНИМАТЬ
ЗНАЧЕНИЕ «0» ..........................................................................................................................196
7
СПИСОК ОШИБОК ПЕРЕДАЧИ ИНФОРМАЦИИ ......................................................199
8
ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ .......................................................................................204
Лист регистрации изменений ...................................................................................................206
2
3
1
ОБЩИЕ СВЕДЕНИЯ
Настоящий документ определяет форматы XML-документов, передаваемых в
электронной форме по телекоммуникационным каналам связи для обеспечения
интеграции системы «Реформа ЖКХ» с внешними системами.
В системе «Реформа ЖКХ» для взаимодействия с внешними системами реализован
API-сервис. API-сервис предоставляет возможность, внешним системам, раскрывать
информацию по управляющим организациям, которые дали на то разрешение, а также по
домам, находящимся в управлении.
API позволяет:
1)
авторизоваться для получения доступа к использованию API-методов;
2)
получить данные организаций, раскрывших сведения о своей деятельности
согласно Постановлению Правительства РФ № 731 от 23.09.2010 в «Реформа
ЖКХ», и данные обслуживаемых ими домов;
3)
получить данные организаций, раскрывших сведения о своей деятельности
согласно Постановлению Правительства РФ № 988 от 27.09.2014 в «Реформа
ЖКХ», и данные обслуживаемых ими домов;
4)
загрузить (обновить) данные организаций, зарегистрированных в «Реформа
ЖКХ», отредактировать список обслуживаемых ими домов, загрузить данные об
обслуживаемых ими домах на «Реформа ЖКХ».
Для начала работы:
1)
внешняя система должна предварительно подать заявку в Фонд, после
рассмотрения, которой она (внешняя система) будет зарегистрирована в «Реформа
ЖКХ» и ей будут выданы соответствующие права на внешнее взаимодействие;
2)
внешняя система, с помощью вызова метода SetRequestForSubmit, должна
подать запрос на раскрытие управляющей организации. После одобрения заявки,
администратором организации, внешняя система может начать раскрытие данных
по анкете организации и анкетам домов в управлении.
Входные структуры данных GET и SET - методов передаются в теле запроса. API
«Реформа ЖКХ» поддерживает протокол SOAP (Simple Object Access Protocol). Обмен
данными по этому протоколу ведется посредством XML-сообщений.
При SOAP-протоколе генерируется WSDL-документ, описывающий формат
данных для взаимодействия.
4
2
СТРУКТУРА XML-ДОКУМЕНТОВ
XML-документ состоит из строк, содержащих элементы и атрибуты, а также их
значения. Реквизиты XML-документа могут быть элементами или атрибутами. Элемент
является составной частью XML-документа, обычно представляющую собой некоторую
законченную смысловую единицу. Элемент может содержать один или несколько
вложенных элементов и/или атрибутов. Атрибут представляет собой составную часть
элемента, задающую его параметры. В XML-документе описывается пролог с указанием
кодировки UTF-8: <?xml version = “1.0” encoding = “UTF-8”?>.
Описание типов данных, используемых при определении полей документов.
Описание приведено в разделе описания методов. В графе "Категория" записывается
условное обозначение элемента сообщения. В графе "Параметр" записывается условное
обозначение атрибута или другого элемента, входящего в состав элемента. В графе "Тип"
для каждого атрибута указывается тип параметра. В графе "Max символов" указывается
длина атрибута. В графе "Обязательность" указывается обязательность поля на ввод.
"Обязательность" имеет следующие обозначения:
1) «Да» - обязательный атрибут;
2) « » - необязательный атрибут.
Обязательный атрибут – это атрибут, который должен обязательно присутствовать
в XML-документе. Необязательный атрибут – это атрибут, который может, как
присутствовать, так и отсутствовать в XML-документе.
В графе "Описание" указывается описание элемента или атрибута.
5
ПЕРЕЧЕНЬ МЕТОДОВ
3
Красным цветом выделены методы, которые на данный момент не доступны для работы.
Таблица 1– Описание методов API
Метод
Авторизация
Данные по API
взаимодействию
Тип
Общий
Login
Название
Общий
Logout
Импорт
SetRequestForSubmit
Экспорт GetRequestList
Справочники
Экспорт GetReportingPeriodList
Управляющая
организация
Экспорт GetCompanyProfile
Экспорт GetCompanyProfile988
Экспорт GetCompanyProfileSF
Назначение
Выполняет авторизацию
внешней системы и
открывает сеанс работы
Завершает авторизованный
сеанс работы внешней
системы
Подача запроса на
подписку (по списку ИНН)
Возвращает список
запросов подписки
внешней системы на
раскрытие данных,
поданных внешней
системой (с детализацией
статуса запроса)
Возвращает список
отчетных периодов
системы
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
с соответствующим
ИНН,согласно
Постановлению
Правительства РФ №731
от 27.09.2010
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
с соответствующим
ИНН,cогласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
по указанному субъекту
федерации за указанный
Метод
Тип
Название
Экспорт GetCompanyProfileSF988
Импорт
SetCompanyProfile
Импорт
SetCompanyProfile988
Импорт
SetNewCompany
Экспорт GetHouseList
7
Назначение
период,согласно
Постановлению
Правительства РФ №731
от 27.09.2010
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
по указанному субъекту
федерации за указанный
период,согласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Изменяет данные по
текущей/архивной анкете
организации с
соответствующим ИНН за
указанный отчетный
период,согласно
Постановлению
Правительства РФ №731
от 27.09.2010
Изменяет данные по
текущей/архивной анкете
организации с
соответствующим ИНН за
указанный отчетный
период,cогласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Подает заявку на
регистрацию новой
управляющей организации
в системе
Возвращает список домов,
находящихся в управлении
организации с
соответствующим ИНН.
(по каждому дому
возвращается
идентификатор дома и
адрес по ФИАС)
Метод
Договора
Тип
Импорт
Название
SetUnlinkFromOrganization
Назначение
Прекращает управление
домом с соответствующим
идентификатором
Импорт
SetHouseLinkToOrganization
Добавляет дом с
соответствующим
идентификатором в
управление организации с
соответствующим ИНН
Возвращает данные анкеты
(текущей) дома с
соответствующим
идентификатором
дома,согласно
Постановлению
Правительства РФ №731
от 27.09.2010
Возвращает данные анкеты
(текущей) дома с
соответствующим
идентификатором
дома,согласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Возвращает данные анкеты
(текущей) дома по
указанному субъекту
федерации,согласно
Постановлению
Правительства РФ №731
от 27.09.2010
Возвращает данные анкеты
(текущей) дома по
указанному субъекту
федерации,согласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Изменяет данные текущей
анкеты дома с
соответствующим
идентификатором
дома,согласно
Постановлению
Многоквартирный Экспорт GetHouseProfile
дом
Экспорт GetHouseProfile988
Экспорт GetHouseProfileSF
Экспорт GetHouseProfileSF988
Импорт
SetHouseProfile
8
Метод
Тип
Название
Импорт
SetHouseProfile988
Импорт
SetNewHouse
Экспорт GetHouseInfo
Файлы
Импорт
SetUploadFile
Экспорт GetFileById
Назначение
Правительства РФ №731
от 27.09.2010
Изменяет данные текущей
анкеты дома с
соответствующим
идентификатором
дома,согласно
Постановлению
Правительства РФ № 988
от 27.09.2014
Добавляет новый дом в
систему с
соответствующим адресом
по ФИАС
Возвращает
идентификатор дома с
соответствующим адресом
по ФИАС
Загружает файл в систему
Возвращает файл с
соответствующим
идентификатором
9
СХЕМА ВЫЗОВА МЕТОДОВ
4
Ниже описаны уровни зависимости методов. Уровни зависимости методов – это
порядок вызова методов. Невозможно выполнить методы со второго уровня, пока не
выполнены методы первого уровня. Например, без авторизации нельзя вызвать ни один из
методов, без подачи запроса на раскрытие невозможно выполнить раскрытие данных по
анкете организации. При вызове метода из уровня ниже, если метод уровня выше был
выполнен ранее, то вызов этого метода пропускается.
Ниже представлена ситуация, когда: управляющая организация не создана, заявка
на раскрытие от внешней системы не подана, дом не добавлен в систему, дом не добавлен
в управление, отчетные периоды не получены, название разделов анкет не получены, файл
не добавлен.
УРОВЕНЬ №1
1.1 Авторизация(Login)
УРОВЕНЬ №2
2.1
Создание
заявки
на
регистрацию
новой
управляющей
организации
(SetNewCompany) не может быть выполнено, пока не выполнена авторизация (1.1).
2.2 Подача запроса (SetRequestForSubmit) не может быть выполнена, пока не
выполнена авторизация (1.1).
2.3
Получение списка запросов (GetRequestList) не может быть выполнено, пока
не выполнена авторизация (1.1).
2.4 Получение списка отчетных периодов (GetReportingPeriodList) не может быть
выполнено, пока не выполнена авторизация (1.1).
2.5
Создание нового дома (SetNewHouse) не может быть выполнено, пока не
выполнена авторизация (1.1).
2.6 Получение информации о доме (GetHouseInfo) не может быть выполнено, пока
не выполнена авторизация (1.1).
2.7
Создание
заявки
для
регистрации
новой
управляющей
организации
(SetNewCompany) не может быть выполнено, пока не выполнена авторизация (1.1).
2.8 Получение данных анкеты (текущей и архивной) управляющей организации с
соответствующим ИНН за указанный отчетный период (1.1).
10
2.9 Получение данных анкеты (текущей и архивной) дома с соответствующим
идентификатором дома (1.1).
2.10 Получение данных анкеты (текущей и архивной) управляющей организации
по указанному субъекту федерации за указанный отчетный период (1.1).
2.11 Получение данных анкеты (текущей и архивной) дома по указанному субъекту
федерации (1.1).
УРОВЕНЬ №3
3.1
Раскрытие
по
анкете
управляющей
организации
(SetCompanyProfile,
SetCompanyProfile988) не может быть выполнено, пока не выполнены следующие методы:
(1.1), (2.1), (2.2), (2.4), (2.6), (2.7), (2.8), (2.10).
3.2 Получение списка домов в управлении (GetHouseList) не может быть
выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2).
УРОВЕНЬ №4
4.1 Добавление дома в управление (SetHouseLinkToOrganization) не может быть
выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (3.2).
УРОВЕНЬ №5
5.1 Прекращение управления домом (SetUnlinkFromOrganization) не может быть
выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (3.2), (4.1).
УРОВЕНЬ №6
6.1 Раскрытие данных по анкете дома (SetHouseProfile, SetHouseProfile988) не
может быть выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5),
(2.9), (2.10), (4.1).
УРОВЕНЬ №7
7.2 Загрузка файла в систему не может быть выполнено, пока не выполнены
следующие методы: (1.1).
7.1 Получение файла с соответствующим идентификатором (GetFileByID) не может
быть выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (4.1),
(3.1), (6.1), (7.2).
УРОВЕНЬ № 8
8.1. Завершение сеанса(Logout)
11
Рисунок 1 - Схема взаимодействия системы «Реформа ЖКХ» с внешней системой.
Часть 1
12
Рисунок 2– Схема взаимодействия системы «Реформа ЖКХ» с внешней
системой. Часть 2
13
Рисунок 3– Схема порядка вызова методов для раскрытия данных по анкеты
управляющей организации
14
Рисунок 4– Схема порядка вызова методов для раскрытия данных по анкеты
многоквартирного дома
15
ОПИСАНИЕ МЕТОДОВ
5
Для тестирования выполненности методов API развернут тестовый контур.
Переданные данные будут доступны для просмотра на Портале по раскрытию
информации по адресу https://p-api-beta.reformagkh.ru/
Доступны два стиля WSDL- документа:
1.
PC\ encoded
•
Внешним системам, которые проходят бета-тестирование API, доступен
WSDL – документ по адресу https://api-beta.reformagkh.ru/api/wsdl.
•
Внешние системы, которые прошли бета-тестирование API сайта Реформа
ЖКХ, могут начать работу с боевым контуром (адрес WSDL – документа
боевого контура: https://api.reformagkh.ru/api/wsdl).
2.
Document\ literal
•
Внешним системам, которые проходят бета-тестирование API, доступен
WSDL
–
документ
по
адресу
https://api-
beta.reformagkh.ru/api_document_literal/wsdl.
•
Внешние системы, которые прошли бета-тестирование API сайта Реформа
ЖКХ, могут начать работу с боевым контуром (адрес WSDL – документа
боевого контура: https://api.reformagkh.ru/api_document_literal/wsdl)
Во всех методах, кроме метода «Login», необходимо передавать ключ авторизации.
Ключ передается в заголовке метода <soapenv:Header/>, в теге <authenticate>
</authenticate>.
Время жизни ключа авторизации 10 минут. По истечению 10 минут
необходимо снова вызвать метод «Login» и получить новый ключ для продолжения
работы.
Категория
Параметр
Authenticate
session_guid
Тип
character
varying
Max
Обязател
символов
ьность
36
Да
Описание
Уникальный ключ
сеанса
(идентификатор сессии)
Пример передачи авторизационного ключа в методе «SetRequestForSubmit»:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header>
16
<authenticate>meulr41c6up5uoc2ehufeslc14</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetRequestForSubmit
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inns xsi:type="api:ArrayOfString"
soapenc:arrayType="xsd:string[2]">
<inn xsi:type="xsd:string">7842311056</inn>
</inns>
</api:SetRequestForSubmit>
</soapenv:Body>
</soapenv:Envelope>
Есть возможность прямой авторизации, указав логин и пароль в заголовке запроса:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="https://api-beta.reformagkh.ru/api_document_literal"
xmlns:xsi="xsi">
<soapenv:Header>
<api:Login
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<login xsi:type="xsd:string">diana.nizamova</login>
<password xsi:type="xsd:string">WAFqy1hk</password>
</api:Login>
</soapenv:Header>
...
В методах раскрытия данных по анкетам (текущим и архивным) управляющей
организации и анкетам (текущим) домов в ее управлении передаются все значения
входных параметров, а не только те значения параметров, которые были изменены. В
случае, если значение поля не указано, система воспринимает это как поле на удаление, и
ранее введенное значение удалится.
Во избежании затирания данных на сайте "Реформа ЖКХ" необходимо прочитать
данные анкеты управляющей организации и анкет домов в ее управлении с помощью
методов GetCompanyProfile/GetCompanyProfile988 и GetHouseProfile/GetHouseProfile988.
После этого данные в анкетах, не соответствующие данным на сайте "Реформа ЖКХ",
необходимо изменить с помощью методов SetCompanyProfile/SetCompanyProfile988 и
SetHouseProfile/ SetHouseProfile988.
Для безошибочного выполнения запроса необходимо строго соблюдать порядок
следования параметров в тексте запроса.
17
Метод Login
1) Описание метода
Метод выполняет авторизацию внешней системы и открывает сеанс работы. Перед
началом работы должна быть проверка, что учетные данные пользователя существуют в
системе “Реформа ЖКХ”, не заблокированы и соответствуют внешней системе.
Есть возможность авторизации не вызывая метод “Login”. В заголовке каждого
метода можно указать учетные данные и тем самым авторизовываться. Пример вызова
метода:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header>
<api:Login
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<login xsi:type="xsd:string">diana.nizamova</login>
<password xsi:type="xsd:string">WAFqy1hk</password>
</api:Login>
</soapenv:Header>
<soapenv:Body>
<api:SetCompanyProfile988
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
…
</api:SetCompanyProfile988>
</soapenv:Body>
</soapenv:Envelope>
2) Входные данные
В таблице представлены входные параметры метода (Таблица 2).
Таблица 2 – Входные параметры метода Login
Категория
LoginIn
Параметр
login
password
Тип
character
varying
character
varying
Max
Обязател
символов
ьность
255
Да
255
Да
Описание
Имя пользователя, для
ввода в систему.
Набор символов, для
подтверждения
личности или
полномочий.
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 3).
Таблица 3– Выходные параметры метода Login
Категория
Параметр
Тип
Max
символов
18
Обязател
ьность
Описание
LoginOut
session_guid
character
varying
Получение временного
ключа для работы с API
36
Таблица 4– Выходные параметры метода Login в случае ошибочного выполнения
SoapFault
code
name
description
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header/>
<soapenv:Body>
<api:Login>
<login>?</login>
<password>?</password>
</api:Login>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «login» не заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 5 – Результаты вызова метода Login
Code
(Код результата
запроса)
1002
Name
(Наименование)
Description
(Описание)
Логин не найден или логин не
соответствует паролю.
Authentication failed
19
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1003
User is blocked
Пользователь заблокирован
1006
User doesn't conform to
external system
Пользователь не соответствует
внешней системе
1016
No interaction
Взаимодействие с системой "Реформа
ЖКХ" запрещено
1025
Technical works in the
system
Ведутся технические работы.
Попробуйте обратиться позже
5.1
Метод Logout
1) Описание метода
Метод завершает авторизованный сеанс работы внешней системы.
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 6).
Таблица 6– Выходные параметры метода Logout в случае ошибочного выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
3) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">9gm0m3ntqrqf0sf24egvcqls66</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:Logout
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
20
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
4) Ошибки
Таблица 7 – Результаты вызова метода Logout
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Authorization failed
Неавторизованный запрос
1009
Unauthorized
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
5.2
Метод SetRequestForSubmit
1) Описание метода
Метод подачи запроса на раскрытие данных. Внешняя система подает на вход
список ИНН управляющих организаций, по которым собирается раскрывать данные.
При условии, что Вы администратор УО подтверждение запроса на раскрытие
информации проставиться автоматически.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 8).
Таблица 8 – Входные параметры метода SetRequestForSubmit
Категория
SetRequest
ForSubmitI
n
Параметр
inns
Тип
ArrayOfStri
ng
Max
Обязател
символов
ьность
12
Да
21
Описание
На вход передается
список ИНН
управляющих
организаций, с
запросом о разрешении
раскрытия информации
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
по указанной
организации
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 9).
Таблица 9– Выходные параметры метода SetRequestForSubmit
Категория
SetRequest
ForSubmitI
nnStatus
Параметр
inn
Тип
character
varying
SetRequest
ForSubmitI
nnStatusEn
um
status
Max
символов
12
Обязател
ьность
Описание
ИНН управляющей
организации
Идентификатор статуса
запроса внешней
системы. (Возможные
значения в Таблица 11)
Таблица 10– Выходные параметры метода SetRequestForSubmit в случае ошибочного
выполнения
SoapFault
code
name
description
Код результата запроса
Наименование
Описание
integer
text
text
Таблица 11– Возможные значения SetRequestForSubmitInnStatusEnum
Тип
SetRequestForSubmitIn
nStatusEnum
Идентификатор
Значения
Success. (Ошибок нет. Заявка подана)
Missing INN
INN is not valid (Указан некорректный
ИНН)
Request have been already submitted
(Запрос на подписку был уже подан
ранее)
0
1
2
3
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>o0tnkvsrs9c79hrhmdslqrg3b0</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetRequestForSubmit>
<inns>
<!--Zero or more repetitions:-->
<item>7702707386</item>
</inns>
22
</api:SetRequestForSubmit>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Unauthorized</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>401</code>
<name>Unauthorized</name>
<description>Неавторизованный запрос</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 12 – Результаты вызова метода SetRequestForSubmit
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1012
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.3
Метод GetRequestList
1) Описание метода
Метод возвращает список запросов подписки на управляющую организацию,
поданных внешней системой (с детализацией статуса запроса).
23
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 13).
Таблица 13– Выходные параметры метода GetRequestList
Категория
RequestStat
e
Параметр
inn
date_created
status
update_date
Тип
character
varying
timestamp(0
)
RequestStat
us
Max
Обязател
символов
ьность
12
Да
Да
Да
Да
timestamp(0
)
Описание
ИНН управляющей
организации
Дата подачи запроса
внешней системой
Идентификатор статуса
запроса
(Возможные значения в
Таблица 15)
Дата обработки заявки
Таблица 14– Выходные параметры метода GetRequestList в случае ошибочного
выполнения
SoapFault
code
name
description
Код результата запроса
Наименование
Описание
integer
text
text
Таблица 15– Возможные значения GetRequestList
Тип
RequestStatus
Идентификатор
Значения
approved(Заявка подтверждена)
declined(Заявка отклонена)
pending(В ожидании рассмотрения)
1
2
3
3) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>nteu389j2k4d76c9p6fl0oal93</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetRequestList/>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
24
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
4) Ошибки
Таблица 16 – Результаты вызова метода GetRequestList
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
5.4
Метод GetReportingPeriodList
1) Описание метода
Метод возвращает список отчетных периодов системы.
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 17).
Таблица 17– Выходные параметры метода GetReportingPeriodList
Категория
Параметр
ReportingPe id
riod
date_start
date_end
name
state
Тип
Max
символов
bigint
date
date
character
255
varying
ReportingPe
25
Обязател
ьность
Да
Описание
Да
Да
Да
Идентификатор
отчетного периода
Дата начала
Дата окончания
Наименование
Да
Текущее состояние.
riodStateEn
um
boolean
is_988
Да
(Возможные значения в
Таблица 19)
Признак, отчетный
период относится к
старым формам
(Постановление №731)
(is_988 is true) или к
новым формам
(Постановление №988)
(is_988 is false)
Таблица 18– Выходные параметры метода GetReportingPeriodList в случае ошибочного
выполнения
SoapFault
code
name
description
Код результата запроса
Наименование
Описание
integer
text
text
Таблица 19– Возможные значения ReportingPeriodStateEnum
Тип
ReportingPeriodStateE
num
Идентификатор
Значения
current (текущий)
1
2
archive (архивный)
3) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>fl205gaavfncd3rplkllrv8rj1</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetReportingPeriodList/>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
26
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
4) Ошибки
Таблица 20 – Результаты вызова метода GetReportingPeriodList
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
5.5
Метод SetCompanyProfile
1) Описание метода
Метод изменяет данные по текущей/архивной анкете управляющей организации с
соответствующим ИНН за указанный отчетный период. Внешняя система может
обновлять анкеты только тех организаций, по которым разрешена подписка.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 21).
Таблица 21 – Входные параметры метода SetCompanyProfile
Категор
Параметр
ия
SetComp inn
anyProfil
eIn
reporting_period_
id
data
Тип
character
varying
bigint
Max
символов
12
Обязательн
ость
Да
Да
Да
CompanyProfi
leData
Описание типа CompanyProfileData:
27
Описание
ИНН
Идентификатор
отчетного
периода
Массив данных
(Описано в
Таблица 22)
Таблица 22– Массив данных(CompanyProfileData) метода SetCompanyProfile
Категория
CompanyPr
ofileData
Параметр
Тип
okopf
Okopf
surname
character
varying
character
varying
character
varying
character
varying
character
varying
date
middlename
firstname
position
ogrn
Max
символов
Обязател
ьность
Да
Описание
255
Да
ОКОПФ. Передается
код всероссийского
справочника ОКОПФ в
формате «2 80 17».
(Возможные значения в
Таблица 45)
Фамилия
255
Да
Отчество
255
Да
Имя
255
Да
Должность
255
Да
ОГРН
Дата регистрации
date_assignm
ent_ogrn
name_authori text
2500
ty_assigning_
ogrn
legal_address FiasAddress
Да
actual_addres
s
FiasAddress
Да
post_address
FiasAddress
Да
work_time
phone
email
text
text
character
varying
2500
32
255
site
proportion_sf
text
decimal
2500
15.2
Да
28
Наименование органа,
принявшего решение о
регистрации
Идентификатор
юридического адреса
(Описано в
Таблица 23)
Идентификатор
фактического
адреса
(Описано в
Таблица 23)
Идентификатор
почтового
адреса
(Описано в
Таблица 23)
Режим работы
Телефон
Электронный адрес.
Формат:
[email protected].
Интернет сайт
Доля участия в
уставном капитале
Категория
Параметр
proportion_m
o
Тип
decimal
additional_in text
fo
participation_ text
in_associatio
ns
srf_count
integer
mo_count
integer
offices_count
staff_regular
_total
staff_regular
_administrati
ve
integer
integer
staff_regular
_engineers
integer
staff_regular
_labor
integer
count_dismis
sed
count_dismis
sed_admins
integer
count_dismis
integer
Max
символов
Обязател
ьность
Описание
Субъекта РФ, %
Доля участия в
уставном капитале
муниципального
образования, %
Дополнительная
информация
Сведения об участии в
саморегулируемых
организациях или в
объединениях ТСЖ и
ЖСК
Количество Субъектов
РФ, в которых
организация
осуществляет свою
деятельность
Количество
муниципальных
образований, в которых
организация
осуществляет свою
деятельность
Количество офисов
Штатная численность
на отчетную дату, чел.
Штатная численность
на отчетную дату,
административный
персонал, чел.
Штатная численность
на отчетную дату,
инженеры, чел.
Штатная численность
на отчетную дату,
рабочий персонал, чел.
Уволено за отчетный
период, чел.
Уволено за отчетный
период,
административный
персонал, чел.
Уволено за отчетный
15.2
2500
2500
integer
integer
29
Категория
Параметр
sed_engineer
s
count_dismis
sed_workers
Тип
Max
символов
Описание
период, инженеры, чел.
Уволено за отчетный
период, рабочий
персонал, чел.
Число несчастных
случаев за отчетный
период
Число случаев
привлечения
организации к
административной
ответственности
Копии документов о
применении мер
административного
воздействия, а также
мер, принятых для
устранения нарушений,
повлекших применение
административных
санкций
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Члены правления ТСЖ
integer
accidents_co
unt
integer
prosecute_co
unt
integer
prosecute_co
pies_of_docu
ments
text
2500
prosecute_do ArrayOfInt
cuments_copi
es_files
additional_fil
es
Обязател
ьность
ArrayOfInt
tsg_managem text
ent_members
audit_commi text
sion_member
s
additional_in text
fo_freeform
2500
2500
Члены ревизионной
комиссии
2500
Дополнительные
сведения в
30
Категория
Параметр
residents_cou
nt
count_houses
_under_mng_
report_date
Тип
Max
символов
CountHouse
sUnderMng
ReportDate
count_houses CountHouse
_under_mng_ sUnderMng
start_period
StartPeriod
sum_sq_hous SumSqHous
es_under_mn esUnderMn
g_report_date gReportDat
e
sum_sq_hous SumSqHous
es_under_mn esUnderMn
g_start_perio gStartPeriod
d
avg_time_ser AvgTimeSe
vice_mkd
rviceMkd
income_of_m IncomeOfM
ng
ng
IncomeOfU
sage
income_of_k
u
IncomeOfK
u
spending_of_
SpendingOf
Описание
произвольной форме
Число жителей в
обслуживаемых домах
Количество домов под
управлением на
отчетную дату.
(Описано в Таблица 24)
Количество домов под
управлением на начало
периода. (Описано в
Таблица 25)
Общая площадь домов
под управлением на
отчетную дату.
(Описано в Таблица 26)
Общая площадь домов
под управлением на
начало периода.
(Описано в Таблица 27)
Средний
срок
обслуживания
многоквартирного
дома. (Описано в
Таблица 28)
Доходы, полученные за
оказание услуг по
управлению
многоквартирными
домами. (Описано в
Таблица 29)
Сумма доходов,
полученных от
использования общего
имущества за отчетный
период. (Описано в
Таблица 30)
Сумма доходов,
полученных от
использования общего
имущества за отчетный
период. (Описано в
Таблица 31)
Расходы, полученные в
integer
income_of_u
sage
Обязател
ьность
31
Категория
Параметр
mng
Тип
Max
символов
claims_by_co ClaimsByC
ntracts_mng
ontractsMn
g
ClaimsByR
so
net_assets
float
annual_finan
cial_statemen
ts
annual_finan
cial_statemen
ts_files
text
2500
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Сметы доходов и
расходов ТСЖ или
ЖСК
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Отчет о выполнении
сметы доходов и
расходов
Массив
идентификаторов
файлов. Если
идентификатор файла
ArrayOfInt
revenues_exp text
enditures_esti
mates
revenues_exp ArrayOfInt
enditures_esti
mates_files
2500
performance_ text
report
2500
Описание
связи с оказанием услуг
по управлению
многоквартирными
домами. (Описано в
Таблица 32)
Выплаты по искам по
договорам управления
за отч
етный период.
(Описано в Таблица 33)
Выплата по искам РСО
за отчетный период.
(Описано в Таблица 34)
Чистые активы
управляющей
организации, тыс. руб.
Годовая бухгалтерская
отчетность
Mng
claims_by_rs
o
Обязател
ьность
performance_ ArrayOfInt
report_files
32
Категория
Параметр
Тип
members_me
etings_minut
es
text
members_me
etings_minut
es_files
ArrayOfInt
audit_commi
sion_report
text
audit_commi
sion_report_f
iles
ArrayOfInt
audit_report
text
audit_report_
files
ArrayOfInt
debt_for_mn
g
DebtForMn
g
Max
символов
Обязател
ьность
Описание
не указан - это означает
удаление файла из
анкеты.
Протоколы общих
собраний членов
товарищества или
кооператива, заседаний
правления и
ревизионной комиссии
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Заключения
ревизионной комиссии
(ревизора)
товарищества или
кооператива по
результатам проверки
годовой бухгалтерской
(финансовой)
отчетности
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Аудиторские
заключения
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Задолженность
собственников за
2500
2500
2500
33
Категория
Параметр
Тип
debt_owners
decimal
debt_owners
_for_ku
DebtOwner
sForKu
debt_uo_for_
ku
DebtUoFor
Ku
debt_owners
_communal
decimal
charged_for_
mng
ChargedFor
Mng
charged_for_
resources
ChargedFor
Resources
spending_rep
air
SpendingRe
pair
spending_bea
ty
SpendingBe
auty
spending_rep
SpendingRe
Max
символов
Обязател
ьность
Описание
услуги управления на
отчетную дату.
(Описано в Таблица 35)
Просроченная
задолженность жителей
за услуги по
управлению на начало
отчетного периода
Задолженность
собственников за КУ на
текущую дату, тыс.руб.
(Описано в Таблица 36)
Задолженность
собственников за КУ на
отчетную дату.
(Описано в Таблица 37)
Просроченная
задолженность
собственников за
коммунальные услуги
на начало отчетного
периода, тыс. руб.
Взыскано с
собственников за
услуги управления за
отчетный период.
(Описано в Таблица 38)
Взыскано с
собственников за
поставленные ресурсы
за отчетный период.
(Описано в Таблица 39)
Объем средств,
затраченных на работы
по текущему ремонту
за отчетный период.
(Описано в Таблица 40)
Объем средств,
затраченных на работы
по благоустройству за
отчетный период.
(Описано в Таблица 41)
Объем привлеченных
15.2
15.2
34
Категория
Параметр
Тип
air_invests
pairInvests
payed_ku_by
_statements
PayedKuBy
Statements
payed_ku_by
_needs
PayedKuBy
Needs
Max
символов
management text
_contract
management ArrayOfInt
_contract_file
s
2500
services_cost
text
2500
services_cost
_files
ArrayOfInt
tariffs
tariffs_files
text
ArrayOfInt
Обязател
ьность
Описание
средств на ремонт,
модернизацию и
благоустройство за
отчетный период.
(Описано в Таблица 42)
Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период.
(Описано в Таблица 43)
Оплачено КУ по счетам
на общедомовые
нужды за отчетный
период. (Описано в
Таблица 44)
Проект договора
управления
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Стоимость услуг
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Тарифы
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
2500
35
Таблица 23– Описание типа FiasAddress
Категория
Параметр
Тип
FiasAddress city_id
character
varying
street_id
character
varying
house_numbe character
r
varying
building
character
varying
block
character
varying
room_numbe character
r
varying
letter
character
varying
Max
символов
36
Обязател
ьность
36
Да
36
Описание
Идентификатор города
(GUID из ФИАС)
Идентификатор улицы
(GUID из ФИАС)
Номер дома
36
Строение
36
Корпус
36
Номер квартиры
36
Литера
Таблица 24– Описание типа CountHousesUnderMngReportDate
Категория
Параметр
Тип
CountHouse count_houses decimal
sUnderMng _under_mng_
ReportDate report_date
Max
символов
15.2
Обязател
ьность
Описание
Домов под
управлением на
отчетную дату. Всего
serviced_by_
tsg
decimal
15.2
Домов, обслуживаемых
ТСЖ, на отчетную дату
serviced_by_
tsg_uo
decimal
15.2
serviced_by_
owner_uo
decimal
15.2
serviced_by_
competition
decimal
15.2
Домов, обслуживаемых
по договору между
ТСЖ и управляющей
организацией, на
отчетную дату
Домов, обслуживаемых
по договору между
собственниками и
управляющей
организацией, на
отчетную дату
Домов, обслуживаемых
по результатам
открытого конкурса
органов местного
36
самоуправления, на
отчетную дату
Таблица 25– Описание типа CountHousesUnderMngStartPeriod
Категория
Параметр
Тип
CountHouse count_houses decimal
sUnderMng _under_mng_
StartPeriod start_period
Max
символов
15.2
serviced_by_
tsg
decimal
15.2
serviced_by_
tsg_uo
decimal
15.2
serviced_by_
owner_uo
decimal
15.2
serviced_by_
competition
decimal
15.2
Обязател
ьность
Описание
Количество домов под
управлением на начало
периода
Домов, обслуживаемых
ТСЖ, на начало
периода
Домов, обслуживаемых
по договору между
ТСЖ и управляющей
организацией, на
начало периода
Домов, обслуживаемых
по договору между
собственниками и
управляющей
организацией, на
начало периода
Домов, обслуживаемых
по результатам
открытого конкурса
органов местного
самоуправления, на
начало периода
Таблица 26– Описание типа SumSqHousesUnderMngReportDate
Категория
Параметр
Тип
SumSqHous sum_sq_hous decimal
esUnderMn es_under_mn
gReportDat g_report_date
e
Max
символов
15.2
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
Обязател
ьность
Описание
Общая площадь домов
под управлением на
отчетную дату,
тыс.кв.м.
Общая площадь домов
под управлением на
отчетную дату по
домам до 25 лет
Общая площадь домов
под управлением на
37
Категория
Параметр
Тип
Max
символов
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
отчетную дату по
домам от 26 до 50 лет
Общая площадь домов
под управлением на
отчетную дату по
домам от 51 до 75 лет
Общая площадь домов
под управлением на
отчетную дату по
домам 76 лет и более
Общая площадь домов
под управлением на
отчетную дату по
аварийным домам
Таблица 27– Описание типа SumSqHousesUnderMngStartPeriod
Категория
Параметр
Тип
SumSqHous sum_sq_hous
esUnderMn es_under_mn
gStartPeriod g_start_perio
d
sum_sq_hous
es_concluded
_contracts
decimal
Max
символов
15.2
decimal
15.2
sum_sq_hous
es_terminate
d_contracts
decimal
15.2
Обязател
ьность
Описание
Общая площадь домов
под управлением на
начало периода
Изменение общей
площади домов за
отчетный период по
заключенным
договорам, кв.м.
Изменение общей
площади домов за
отчетный период по
расторгнутым
договорам, кв.м.
Таблица 28– Описание типа AvgTimeServiceMkd
Категория
Параметр
Тип
AvgTimeSe
rviceMkd
avg_time_ser
vice_mkd
decimal
Max
символов
15.2
by_houses_2
5
decimal
15.2
38
Обязател
ьность
Описание
Средний срок
обслуживания
многоквартирного дома
Средний срок
обслуживания по
домам до 25 лет
Категория
Параметр
Тип
by_houses_2
6_50
decimal
Max
символов
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
Средний срок
обслуживания по
домам от 26 до 50 лет
Средний срок
обслуживания по
домам от 51 до 75 лет
Средний срок
обслуживания по
домам 76 лет и более
Средний срок
обслуживания по
аварийным домам
Таблица 29– Описание типа IncomeOfMng
Категория
Параметр
Тип
IncomeOfM income_of_m decimal
ng
ng
Max
символов
15.2
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
Доходы, полученные за
оказание услуг по
управлению
многоквартирными
домами, тыс.руб
Доход от управления за
отчетный период по
домам до 25 лет
Доход от управления за
отчетный период по
домам от 26 до 50 лет
Доход от управления за
отчетный период по
домам от 51 до 75 лет
Доход от управления за
отчетный период по
домам 76 лет и более
Доход от управления за
отчетный период по
аварийным домам
Таблица 30– Описание типа IncomeOfUsage
Категория
Параметр
Тип
IncomeOfU
sage
income_of_u
sage
decimal
Max
символов
15.2
39
Обязател
ьность
Описание
Сумма доходов,
полученных от
Категория
Параметр
Тип
Max
символов
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
использования общего
имущества за отчетный
период, тыс.руб.
Доход от
использования общего
имущества за отчетный
период по домам до 25
лет
Доход от
использования общего
имущества за отчетный
период по домам от 26
до 50 лет
Доход от
использования общего
имущества за отчетный
период по домам от 51
до 75 лет
Доход от
использования общего
имущества за отчетный
период по домам 76 лет
и более
Доход от
использования общего
имущества за отчетный
период по аварийным
домам
Таблица 31– Описание типа IncomeOfKu
Категория
Параметр
Тип
IncomeOfK
u
income_of_k
u
decimal
Max
символов
15.2
by_heating
decimal
15.2
by_electro
decimal
15.2
40
Обязател
ьность
Описание
Доход от
предоставления КУ за
отчетный период
Доход от
предоставления
отопления за отчетный
период
Доход от
предоставления
электричества за
отчетный период
Категория
Параметр
Тип
by_gaz
decimal
Max
символов
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
by_sewerage
decimal
15.2
Обязател
ьность
Описание
Доход от
предоставления газа за
отчетный период
Доход от
предоставления
горячего
водоснабжения за
отчетный период
Доход от
предоставления
холодного
водоснабжения за
отчетный период
Доход от
предоставления
водоотведения за
отчетный период
Таблица 32– Описание типа SpendingOfMng
Категория
Параметр
Тип
SpendingOf
Mng
spending_of_
mng
by_houses_2
5
decimal
Max
символов
15.2
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
Расходы на управление
за отчетный период
Расходы на управление
за отчетный период по
домам до 25 лет
Расходы на управление
за отчетный период по
домам от 26 до 50 лет
Расходы на управление
за отчетный период по
домам от 51 до 75 лет
Расходы на управление
за отчетный период по
домам 76 лет и более
Расходы на управление
за отчетный период по
аварийным домам
Таблица 33– Описание типа ClaimsByContractsMng
Категория
Параметр
Тип
Max
символов
41
Обязател
ьность
Описание
Категория
ClaimsByC
ontractsMn
g
Параметр
Тип
claims_by_co decimal
ntracts_mng
claims_for_d
amage
Max
символов
15.2
decimal
15.2
claims_for_re decimal
fusal
15.2
claims_for_s
hort_shipmen
t
15.2
decimal
Обязател
ьность
Описание
Выплаты по искам по
договорам управления
за отчетный период,
тыс. руб.
Выплаты по искам по
компенсации
нанесенного ущерба
Выплаты по искам по
снижению платы в
связи с неоказанием
услуг
Выплаты по искам по
снижению платы в
связи с недопоставкой
ресурсов
Таблица 34– Описание типа ClaimsByRso
Категория
Параметр
Тип
ClaimsByR
so
claims_by_rs
o
by_heating
decimal
Max
символов
15.2
decimal
15.2
by_electro
decimal
15.2
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
by_sewerage
decimal
15.2
42
Обязател
ьность
Описание
Выплаты по искам РСО
за отчетный период
Выплаты по искам за
отопление за отчетный
период
Выплаты по искам за
электричество за
отчетный период
Выплаты по искам за
газ за отчетный период
Выплаты по искам за
горячее водоснабжение
за отчетный период
Выплаты по искам за
холодное
водоснабжение за
отчетный период
Выплаты по искам за
водоотведение за
отчетный период
Таблица 35– Описание типа DebtForMng
Категория
Параметр
Тип
DebtForMn
g
debt_for_mn
g
decimal
Max
символов
15.2
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
Просроченная
задолженность
собственников за
услуги управления на
отчетную дату, тыс.
руб.
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам до 25 лет
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам от 26 до 50 лет
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам от 51 до 75 лет
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам 76 лет и более
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
аварийным домам
Таблица 36– Описание типа DebtOwnersForKu
Категория
Параметр
Тип
Max
символов
43
Обязател
ьность
Описание
Категория
Параметр
Тип
DebtOwner
sForKu
debt_owners
_for_ku
decimal
Max
символов
15.2
by_heating
decimal
15.2
by_electro
decimal
15.2
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
by_sewerage
decimal
15.2
Обязател
ьность
Описание
Просроченная
задолженность
собственников за КУ на
отчетную дату
Просроченная
задолженность
собственников за
отопление на отчетную
дату
Просроченная
задолженность
собственников за
электричество на
отчетную дату
Просроченная
задолженность
собственников за газ на
отчетную дату
Просроченная
задолженность
собственников за
горячее водоснабжение
на отчетную дату
Просроченная
задолженность
собственников за
холодное
водоснабжение на
отчетную дату
Просроченная
задолженность
собственников за
водоотведение на
отчетную дату
Таблица 37– Описание типа DebtUoForKu
Категория
Параметр
DebtUoFor
Ku
debt_uo_for_
ku
Тип
decimal
Max
символов
15.2
44
Обязател
ьность
Описание
Просроченная
задолженность
организации за
предоставленные
коммунальные услуги,
Категория
Параметр
Тип
Max
символов
by_heating
decimal
15.2
by_electro
decimal
15.2
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
by_sewerage
decimal
15.2
Обязател
ьность
Описание
накопленная за весь
период обслуживания
на отчетную дату
Задолженность
управляющей
организации за
отопление на отчетную
дату
Задолженность
управляющей
организации за
электричество на
отчетную дату
Задолженность
управляющей
организации за газ на
отчетную дату
Задолженность
управляющей
организации за горячее
водоснабжение на
отчетную дату
Задолженность
управляющей
организации за
холодное
водоснабжение на
отчетную дату
Задолженность
управляющей
организации за
водоотведение на
отчетную дату
Таблица 38– Описание типа ChargedForMng
Категория
Параметр
Тип
ChargedFor
Mng
charged_for_
mng
decimal
Max
символов
15.2
45
Обязател
ьность
Описание
Сумма взысканной за
отчетный период
просроченной
задолженности
собственников
помещений и иных лиц,
Категория
Параметр
Тип
Max
символов
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
пользующихся или
проживающих в
помещениях на
законных основаниях
за услуги по
управлению, тыс. руб.
Взыскано с
собственников за
услуги управления за
отчетный период по
домам до 25 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам от 26 до 50 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам от 51 до 75 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам 76 лет и более
Взыскано с
собственников за
услуги управления за
отчетный период по
аварийным домам
Таблица 39– Описание типа ChargedForResources
Категория
Параметр
Тип
ChargedFor
Resources
charged_for_
resources
decimal
Max
символов
15.2
by_heating
decimal
15.2
by_electro
decimal
15.2
46
Обязател
ьность
Описание
Взыскано с
собственников за КУ за
отчетный период
Взыскано с
собственников за
отопление за отчетный
период
Взыскано с
Категория
Параметр
Тип
Max
символов
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
by_sewerage
decimal
15.2
Обязател
ьность
Описание
собственников за
электричество за
отчетный период
Взыскано с
собственников за газ за
отчетный период
Взыскано с
собственников за
горячее водоснабжение
за отчетный период
Взыскано с
собственников за
холодное
водоснабжение за
отчетный период
Взыскано с
собственников за
водоотведение за
отчетный период
Таблица 40– Описание типа SpendingRepair
Категория
Параметр
Тип
SpendingRe
pair
spending_rep
air
decimal
Max
символов
15.2
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
decimal
15.2
47
Обязател
ьность
Описание
Объем работ по
ремонту за отчетный
период, тыс.руб.
Объем работ по
ремонту за отчетный
период по домам до 25
лет
Объем работ по
ремонту за отчетный
период по домам от 26
до 50 лет
Объем работ по
ремонту за отчетный
период по домам от 51
до 75 лет
Объем работ по
ремонту за отчетный
период по домам 76 лет
и более
Объем работ по
ремонтуза отчетный
период по аварийным
домам
arm
Таблица 41– Описание типа SpendingBeauty
Категория
Параметр
Тип
SpendingBe
auty
spending_bea
ty
decimal
Max
символов
15.2
by_houses_2
5
decimal
15.2
by_houses_2
6_50
decimal
15.2
by_houses_5
1_75
decimal
15.2
by_houses_7
6
decimal
15.2
by_houses_al
arm
decimal
15.2
Обязател
ьность
Описание
Объем работ по
благоустройству за
отчетный период
Объем работ по
благоустройству за
отчетный период по
домам до 25 лет
Объем работ по
благоустройству за
отчетный период по
домам от 26 до 50 лет
Объем работ по
благоустройству за
отчетный период по
домам от 51 до 75 лет
Объем работ по
благоустройству за
отчетный период по
домам 76 лет и более
Объем работ по
благоустройству
отчетный период по
аварийным домам
Таблица 42– Описание типа SpendingRepairInvests
Категория
Параметр
Тип
SpendingRe
pairInvests
spending_rep
air_invests
decimal
Max
символов
15.2
subsidy
credits
fin_lising
decimal
decimal
decimal
15.2
15.2
15.2
fin_service
decimal
15.2
48
Обязател
ьность
Описание
Объем привлеченных
средств за отчетный
период
Субсидии
Кредиты
Финансирование по
договорам лизинга
Финансирование по
энергосервисным
договорам
contributions decimal
_residents
other_sources decimal
Целевые взносы
жителей
Другие источники
15.2
15.2
Таблица 43– Описание типа PayedKuByStatements
Категория
Параметр
Тип
PayedKuBy
Statements
payed_ku_by
_statements
decimal
Max
символов
15.2
by_heating
decimal
15.2
by_electro
decimal
15.2
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
Обязател
ьность
Описание
Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за отопление
по показаниям
общедомовых ПУ за
отчетный период
Оплачено за
электричество по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за газ по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за горячее
водоснабжение по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за холодное
водоснабжение по
показаниям
общедомовых ПУ за
отчетный период
Таблица 44– Описание типа PayedKuByNeeds
Категория
Параметр
Тип
PayedKuBy
Needs
payed_ku_by
_needs
decimal
Max
символов
15.2
by_heating
decimal
15.2
49
Обязател
ьность
Описание
Оплачено КУ по счетам
на общедомовые
нужды за отчетный
период
Оплачено за отопление
по счетам на
Категория
Параметр
Тип
Max
символов
by_electro
decimal
15.2
by_gaz
decimal
15.2
by_hot_water
decimal
15.2
by_cold_wat
er
decimal
15.2
Обязател
ьность
Описание
общедомовые нужды за
отчетный период
Оплачено за
электричество по
счетам на
общедомовые нужды за
отчетный период
Оплачено за газ по
счетам на
общедомовые нужды за
отчетный период
Оплачено за горячее
водоснабжение по
счетам на
общедомовые нужды за
отчетный период
Оплачено за холодное
водоснабжение по
счетам на
общедомовые нужды за
отчетный период
Таблица 45– Возможные значения Okopf
Тип
Okopf
Код
1 10 00
1 10 51
1 10 64
1 20 00
1 21 00
1 21 65
1 21 66
1 22 00
1 22 47
1 22 67
1 30 00
1 40 00
1 41 00
1 42 00
1 50 00
Значения
Хозяйственные товарищества
Полные товарищества
Товарищества на вере (коммандитные товарищества)
Хозяйственные общества
Общества с ограниченной или дополнительной
ответственностью
Общества с ограниченной ответственностью
Общества с дополнительной ответственностью
Акционерные общества
Открытые акционерные общества
Закрытые акционерные общества
Хозяйственные партнерства
Производственные кооперативы (артели)
Сельскохозяйственные производственные кооперативы
Производственные кооперативы (кроме
сельскохозяйственных производственных кооперативов)
Унитарные предприятия
50
Тип
Код
1 51 00
1 51 41
1 51 43
1 52 00
1 52 41
1 52 42
1 52 43
1 53 00
1 90 00
2 01 00
2 01 02
2 01 03
2 01 04
2 01 07
2 02 00
2 02 10
2 02 11
2 04 00
2 05 00
2 06 00
2 06 01
2 06 03
2 06 05
2 06 08
2 09 00
2 09 01
2 09 03
2 09 04
2 09 05
2 09 06
2 10 01
2 80 00
2 80 01
2 80 04
2 80 05
Значения
Унитарные предприятия, основанные на праве оперативного
управления (казенные предприятия)
Федеральные казенные предприятия
Муниципальные казенные предприятия
Унитарные предприятия, основанные на праве
хозяйственного ведения
Федеральные государственные унитарные предприятия
Государственные унитарные предприятия субъектов
Российской Федерации
Муниципальные унитарные предприятия
Крестьянские (фермерские) хозяйства
Прочие юридические лица, являющиеся коммерческими
организациями
Потребительские кооперативы
Жилищные и жилищно-строительные кооперативы
Жилищные накопительные кооперативы
Кредитные потребительские кооперативы
Потребительские общества
Общественные организации (объединения)
Общественные движения
Органы общественной самодеятельности
Фонды
Некоммерческие партнерства
Ассоциации (союзы)
Ассоциации (союзы) экономического взаимодействия
субъектов Российской Федерации
Советы муниципальных образований субъектов Российской
Федерации
Союзы (ассоциации) кооперативов
Союзы потребительских обществ
Учреждения
Автономные учреждения
Бюджетные учреждения
Казенные учреждения
Общественные учреждения
Частные учреждения
Садоводческие, огороднические или дачные некоммерческие
товарищества
Юридические лица, являющиеся некоммерческими
организациями, не включенные в другие группировки
Автономные некоммерческие организации
Государственные компании
Государственные корпорации
51
Тип
Код
2 80 13
2 80 15
2 80 16
2 80 17
2 90 00
3 00 01
3 00 02
3 00 03
3 00 04
3 00 06
5 01 02
Значения
Объединения (союзы) крестьянских (фермерских) хозяйств
Товарищество собственников недвижимости
Товарищества собственников жилья
Территориальные общественные самоуправления
Иные некоммерческие организации, не включенные в другие
группировки
Представительства юридических лиц
Филиалы юридических лиц
Обособленные подразделения юридических лиц
Структурные подразделения обособленных подразделений
юридических лиц
Простые товарищества
Индивидуальные предприниматели
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 46).
Таблица 46– Выходные параметры метода SetCompanyProfile в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetCompanyProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">?</inn>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<data xsi:type="api:CompanyProfileData">
<work_time xsi:type="xsd:string">?</work_time>
<additional_info xsi:type="xsd:string">?</additional_info>
<participation_in_associations
xsi:type="xsd:string">?</participation_in_associations>
<srf_count xsi:type="xsd:int">?</srf_count>
<mo_count xsi:type="xsd:int">?</mo_count>
<offices_count xsi:type="xsd:int">?</offices_count>
<staff_regular_total xsi:type="xsd:int">?</staff_regular_total>
52
<staff_regular_administrative
xsi:type="xsd:int">?</staff_regular_administrative>
<staff_regular_engineers
xsi:type="xsd:int">?</staff_regular_engineers>
<staff_regular_labor xsi:type="xsd:int">?</staff_regular_labor>
<count_dismissed xsi:type="xsd:int">?</count_dismissed>
<count_dismissed_admins
xsi:type="xsd:int">?</count_dismissed_admins>
<count_dismissed_engineers
xsi:type="xsd:int">?</count_dismissed_engineers>
<count_dismissed_workers
xsi:type="xsd:int">?</count_dismissed_workers>
<accidents_count xsi:type="xsd:int">?</accidents_count>
<prosecute_count xsi:type="xsd:int">?</prosecute_count>
<prosecute_copies_of_documents
xsi:type="xsd:string">?</prosecute_copies_of_documents>
<tsg_management_members
xsi:type="xsd:string">?</tsg_management_members>
<audit_commision_members
xsi:type="xsd:string">?</audit_commision_members>
<additional_info_freeform
xsi:type="xsd:string">?</additional_info_freeform>
<residents_count xsi:type="xsd:int">?</residents_count>
<count_houses_under_mng_report_date
xsi:type="api:CountHousesUnderMngReportDate">
<count_houses_under_mng_report_date
xsi:type="xsd:int">?</count_houses_under_mng_report_date>
<serviced_by_tsg xsi:type="xsd:int">?</serviced_by_tsg>
<serviced_by_tsg_uo xsi:type="xsd:int">?</serviced_by_tsg_uo>
<serviced_by_owner_uo
xsi:type="xsd:int">?</serviced_by_owner_uo>
<serviced_by_competition
xsi:type="xsd:int">?</serviced_by_competition>
</count_houses_under_mng_report_date>
<count_houses_under_mng_start_period
xsi:type="api:CountHousesUnderMngStartPeriod">
<count_houses_under_mng_start_period
xsi:type="xsd:int">?</count_houses_under_mng_start_period>
<serviced_by_tsg xsi:type="xsd:int">?</serviced_by_tsg>
<serviced_by_tsg_uo xsi:type="xsd:int">?</serviced_by_tsg_uo>
<serviced_by_owner_uo
xsi:type="xsd:int">?</serviced_by_owner_uo>
<serviced_by_competition
xsi:type="xsd:int">?</serviced_by_competition>
</count_houses_under_mng_start_period>
<sum_sq_houses_under_mng_report_date
xsi:type="api:SumSqHousesUnderMngReportDate">
<sum_sq_houses_under_mng_report_date
xsi:type="xsd:float">?</sum_sq_houses_under_mng_report_date>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</sum_sq_houses_under_mng_report_date>
<sum_sq_houses_under_mng_start_period
xsi:type="api:SumSqHousesUnderMngStartPeriod">
<sum_sq_houses_under_mng_start_period
xsi:type="xsd:float">?</sum_sq_houses_under_mng_start_period>
<sum_sq_houses_concluded_contracts
xsi:type="xsd:float">?</sum_sq_houses_concluded_contracts>
<sum_sq_houses_terminated_contracts
xsi:type="xsd:float">?</sum_sq_houses_terminated_contracts>
53
</sum_sq_houses_under_mng_start_period>
<avg_time_service_mkd xsi:type="api:AvgTimeServiceMkd">
<avg_time_service_mkd
xsi:type="xsd:float">?</avg_time_service_mkd>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</avg_time_service_mkd>
<income_of_mng xsi:type="api:IncomeOfMng">
<income_of_mng xsi:type="xsd:float">?</income_of_mng>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</income_of_mng>
<income_of_usage xsi:type="api:IncomeOfUsage">
<income_of_usage xsi:type="xsd:float">?</income_of_usage>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</income_of_usage>
<income_of_ku xsi:type="api:IncomeOfKu">
<income_of_ku xsi:type="xsd:float">?</income_of_ku>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
<by_sewerage xsi:type="xsd:float">?</by_sewerage>
</income_of_ku>
<spending_of_mng xsi:type="api:SpendingOfMng">
<spending_of_mng xsi:type="xsd:float">?</spending_of_mng>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</spending_of_mng>
<claims_by_contracts_mng xsi:type="api:ClaimsByContractsMng">
<claims_by_contracts_mng
xsi:type="xsd:float">?</claims_by_contracts_mng>
<claims_for_damage xsi:type="xsd:float">?</claims_for_damage>
<claims_for_refusal
xsi:type="xsd:float">?</claims_for_refusal>
<claims_for_short_shipment
xsi:type="xsd:float">?</claims_for_short_shipment>
</claims_by_contracts_mng>
<claims_by_rso xsi:type="api:ClaimsByRso">
<claims_by_rso xsi:type="xsd:float">?</claims_by_rso>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
<by_sewerage xsi:type="xsd:float">?</by_sewerage>
</claims_by_rso>
<net_assets xsi:type="xsd:string">?</net_assets>
54
<annual_financial_statements
xsi:type="xsd:string">?</annual_financial_statements>
<revenues_expenditures_estimates
xsi:type="xsd:string">?</revenues_expenditures_estimates>
<performance_report xsi:type="xsd:string">?</performance_report>
<members_meetings_minutes
xsi:type="xsd:string">?</members_meetings_minutes>
<audit_commision_report
xsi:type="xsd:string">?</audit_commision_report>
<audit_report xsi:type="xsd:string">?</audit_report>
<debt_for_mng xsi:type="api:DebtForMng">
<debt_for_mng xsi:type="xsd:float">?</debt_for_mng>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</debt_for_mng>
<debt_owners xsi:type="xsd:float">?</debt_owners>
<debt_owners_for_ku xsi:type="api:DebtOwnersForKu">
<debt_owners_for_ku
xsi:type="xsd:float">?</debt_owners_for_ku>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
<by_sewerage xsi:type="xsd:float">?</by_sewerage>
</debt_owners_for_ku>
<debt_uo_for_ku xsi:type="api:DebtUoForKu">
<debt_uo_for_ku xsi:type="xsd:float">?</debt_uo_for_ku>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
<by_sewerage xsi:type="xsd:float">?</by_sewerage>
</debt_uo_for_ku>
<debt_owners_communal
xsi:type="xsd:float">?</debt_owners_communal>
<charged_for_mng xsi:type="api:ChargedForMng">
<charged_for_mng xsi:type="xsd:float">?</charged_for_mng>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</charged_for_mng>
<charged_for_resources xsi:type="api:ChargedForResources">
<charged_for_resources
xsi:type="xsd:float">?</charged_for_resources>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
<by_sewerage xsi:type="xsd:float">?</by_sewerage>
</charged_for_resources>
<spending_repair xsi:type="api:SpendingRepair">
<spending_repair xsi:type="xsd:float">?</spending_repair>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
55
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</spending_repair>
<spending_beauty xsi:type="api:SpendingBeauty">
<spending_beauty xsi:type="xsd:float">?</spending_beauty>
<by_houses_25 xsi:type="xsd:float">?</by_houses_25>
<by_houses_26_50 xsi:type="xsd:float">?</by_houses_26_50>
<by_houses_51_75 xsi:type="xsd:float">?</by_houses_51_75>
<by_houses_76 xsi:type="xsd:float">?</by_houses_76>
<by_houses_alarm xsi:type="xsd:float">?</by_houses_alarm>
</spending_beauty>
<spending_repair_invests xsi:type="api:SpendingRepairInvests">
<spending_repair_invests
xsi:type="xsd:float">?</spending_repair_invests>
<subsidy xsi:type="xsd:float">?</subsidy>
<credits xsi:type="xsd:float">?</credits>
<fin_lising xsi:type="xsd:float">?</fin_lising>
<fin_service xsi:type="xsd:float">?</fin_service>
<contributions_residents
xsi:type="xsd:float">?</contributions_residents>
<other_sources xsi:type="xsd:float">?</other_sources>
</spending_repair_invests>
<payed_ku_by_statements xsi:type="api:PayedKuByStatements">
<payed_ku_by_statements
xsi:type="xsd:float">?</payed_ku_by_statements>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
</payed_ku_by_statements>
<payed_ku_by_needs xsi:type="api:PayedKuByNeeds">
<payed_ku_by_needs xsi:type="xsd:float">?</payed_ku_by_needs>
<by_heating xsi:type="xsd:float">?</by_heating>
<by_electro xsi:type="xsd:float">?</by_electro>
<by_gaz xsi:type="xsd:float">?</by_gaz>
<by_hot_water xsi:type="xsd:float">?</by_hot_water>
<by_cold_water xsi:type="xsd:float">?</by_cold_water>
</payed_ku_by_needs>
<management_contract
xsi:type="xsd:string">?</management_contract>
<services_cost xsi:type="xsd:string">?</services_cost>
<tariffs xsi:type="xsd:string">?</tariffs>
<okopf xsi:type="xsd:string">?</okopf>
<firstname xsi:type="xsd:string">?</firstname>
<surname xsi:type="xsd:string">?</surname>
<middlename xsi:type="xsd:string">?</middlename>
<position xsi:type="xsd:string">?</position>
<ogrn xsi:type="xsd:string">?</ogrn>
<date_assignment_ogrn
xsi:type="xsd:date">?</date_assignment_ogrn>
<name_authority_assigning_ogrn
xsi:type="xsd:string">?</name_authority_assigning_ogrn>
<legal_address xsi:type="api:FiasAddress">
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
</legal_address>
<actual_address xsi:type="api:FiasAddress">
<city_id xsi:type="xsd:string">?</city_id>
56
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
</actual_address>
<post_address xsi:type="api:FiasAddress">
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
</post_address>
<phone xsi:type="xsd:string">?</phone>
<email xsi:type="xsd:string">?</email>
<site xsi:type="xsd:string">?</site>
<proportion_sf xsi:type="xsd:float">?</proportion_sf>
<proportion_mo xsi:type="xsd:float">?</proportion_mo>
</data>
</api:SetCompanyProfile>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 47 – Результаты вызова метода SetCompanyProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
57
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
Попробуйте обратиться позже.
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1005
INN wasnt found
Управляющая организация с
указанным ИНН не найдена
1024
Missing OKOPF
ОКОПФ с указанным кодом не найдена
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1042
Reporting period is not
related to the Resolution 731
Данные по старым формам раскрытия
информации, согласно Постановлению
Правительства РФ № 731 от 23.09.2010
не относятся к запрашиваемому
отчетному периоду
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1021
5.6
Метод SetNewCompany
1) Описание метода
Метод подачи запроса на регистрацию новой управляющей организации.
Подтверждение регистрации управляющей организации производит модератор Фонда
согласно регламенту.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 48).
Таблица 48 – Входные параметры метода SetNewCompany
Категор
ия
Параметр
Тип
Max
символов
58
Обязательн
ость
Описание
SetNewC inn
ompanyI
n
new_company_da
te
character
varying
NewCompany
ProfileData
12
Да
ИНН
Да
Массив данных
(Описано в
Таблица 49)
Таблица 49– Массив данных (NewCompanyProfileData) метода SetNewCompany
Категор
Параметр
ия
NewCom name_full
panyProf
ileData
name_short
okopf
surname
middlename
firstname
ogrn
legal_address
actual_address
post_address
phone
Тип
character
varying
character
varying
Okopf
character
varying
character
varying
character
varying
character
varying
FiasAddress
Max
символов
255
Обязательн
ость
Да
255
Да
Да
255
255
Полное
наименование
Краткое
наименование
ОКОПФ.
Передается код
всероссийского
справочника
ОКОПФ в
формате «2 80
17». (Описано в
Таблица 45)
Фамилия
Отчество
255
Да
Имя
ОГРН
255
Да
Идентификатор
юридического
адреса
(описано в
Таблица 23)
Идентификатор
фактического
адреса
(описано в
FiasAddress
Таблица 23)
Идентификатор
почтового
адреса
(описано в
FiasAddress
text
Да
Описание
32
59
Таблица 23)
Контактный
Категор
ия
Параметр
Тип
Max
символов
email
character
varying
255
site
proportion_sf
text
decimal
2500
15.2
proportion_mo
decimal
15.2
Обязательн
ость
Описание
телефон
Электронный
адрес. Формат:
[email protected]
u.
Интернет сайт
Доля участия в
уставном
капитале
Субъекта РФ,
%
Доля участия в
уставном
капитале
муниципальног
о образования,
%
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 50).
Таблица 50– Выходные параметры метода SetNewCompany в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="https://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate>29r2r9ln074jsnigave0pl3ue5</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetNewCompany
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">?</inn>
<new_company_data xsi:type="api:NewCompanyProfileData">
<!--You may enter the following 15 items in any order-->
<name_full xsi:type="xsd:string">?</name_full>
<name_short xsi:type="xsd:string">?</name_short>
<okopf xsi:type="api:Okopf">?</okopf>
60
<firstname xsi:type="xsd:string">?</firstname>
<surname xsi:type="xsd:string">?</surname>
<middlename xsi:type="xsd:string">?</middlename>
<ogrn xsi:type="xsd:string">?</ogrn>
<legal_address xsi:type="api:FiasAddress">
<!--You may enter the following 7 items in any order-->
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
<letter xsi:type="xsd:string">?</letter>
</legal_address>
<actual_address xsi:type="api:FiasAddress">
<!--You may enter the following 7 items in any order-->
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
<letter xsi:type="xsd:string">?</letter>
</actual_address>
<post_address xsi:type="api:FiasAddress">
<!--You may enter the following 7 items in any order-->
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
<letter xsi:type="xsd:string">?</letter>
</post_address>
<phone xsi:type="xsd:string">?</phone>
<email xsi:type="xsd:string">?</email>
<site xsi:type="xsd:string">?</site>
<proportion_sf xsi:type="xsd:float">?</proportion_sf>
<proportion_mo xsi:type="xsd:float">?</proportion_mo>
</new_company_data>
</api:SetNewCompany>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
61
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 51 – Результаты вызова метода SetNewCompany
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1024
Missing OKOPF
ОКОПФ с указанным кодом не найдена
1032
The company with INN
already exist
Управляющая организация, с
указанным ИНН, уже зарегистрирована
в системе
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.7
Метод GetHouseList
1) Описание метода
Метод получения списка домов, находящихся в управлении организации с
соответствующим ИНН (по каждому дому возвращается идентификатор дома и адрес по
ФИАС). Внешняя система может получать список домов в управлении организаций, по
которым разрешена подписка.
В результате запроса получения списка домов в управлении API - сервис может
вернуть несколько домов с одинаковым адресом. Внешняя система вправе раскрывать
информацию как по всем своим домам-дублям также и по одному из домов.
Необходимо прекратить управление домами, которым внешняя система не нашла
соответствия в своей системе.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 52).
62
Таблица 52 – Входные параметры метода GetHouseList
Категор
Параметр
ия
GetHous inn
eList
Тип
Max
символов
12
character
varying
Обязательн
ость
Да
Описание
ИНН
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 53).
Таблица 53– Выходные параметры метода GetHouseList
Категория
Параметр
GetHouseLi
stResponse
house_id
full_address
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор дома
Адрес дома (Описано в
Таблица 55)
integer
FullAddress
Таблица 54– Выходные параметры метода GetHouseList в случае ошибочного выполнения
SoapFault
code
name
description
Код результата запроса
Наименование
Описание
integer
text
text
Таблица 55– Описание типа FullAddress
Категория
Параметр
Тип
FullAddress
region_guid
character
varying
region_forma
l_name
character
varying
Max
символов
36
120
region_short_ character
name
varying
region_code
character
varying
area_ guid
character
varying
12
area_formal_
name
character
varying
120
area_short_n
ame
area_code
character
varying
character
varying
character
varying
12
city1_ guid
17
36
17
36
63
Обязател
ьность
Описание
Идентификатор
региона
(GUID по ФИАС,
aolevel = 1)
Формализованное
наименование региона
(ФИАС)
Краткое наименование
типа региона (ФИАС)
Код региона из КЛАДР
4.0.
Идентификатор района
(GUID по ФИАС,
aolevel = 3)
Формализованное
наименование района
(ФИАС)
Краткое наименование
типа района (ФИАС)
Код района из КЛАДР
4.0.
Идентификатор города
(GUID по ФИАС,
Категория
Параметр
Тип
city1_formal
_name
character
varying
120
city1_short_n
ame
city1_code
character
varying
character
varying
character
varying
12
city2_formal
_name
character
varying
120
city2_short_n
ame
character
varying
12
city2_code
character
varying
17
city3_ guid
character
varying
36
city3_formal
_name
character
varying
120
city3_short_n
ame
character
varying
12
city3_code
character
varying
character
varying
17
character
varying
120
city2_ guid
street_ guid
street_formal
_name
street_short_
name
street_code
character
varying
character
varying
additional_ter character
ritory
varying
Max
символов
Обязател
ьность
Описание
aolevel = 4).
Формализованное
наименование города
(ФИАС)
Краткое наименование
типа города (ФИАС)
Код города из КЛАДР
4.0.
Идентификатор
внутригородской
территории
(GUID по ФИАС,
aolevel = 5).
Формализованное
наименование
внутригородской
территории (ФИАС)
Краткое наименование
внутригородской
территории (ФИАС)
Код внутригородской
территории из КЛАДР
4.0.
Идентификатор
населенного пункта
(GUID по ФИАС,
aolevel = 6).
Формализованное
наименование
населенного пункта
(ФИАС)
Краткое наименование
населенного пункта
(ФИАС)
Код населенного
пункта из КЛАДР 4.0.
Идентификатор улицы
(GUID по ФИАС,
aolevel = 7)
Формализованное
наименование улицы
(ФИАС)
Краткое наименование
типа улицы (ФИАС)
Код улицы из КЛАДР
4.0.
Идентификатор
дополнительной
территории (GUID по
17
36
36
12
17
36
64
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
additional_ter character
ritory_formal varying
_name
120
additional_ter
ritory_short_
name
additional_ter
ritory_code
character
varying
12
character
varying
17
house_numbe
r
building
block
letter
text
ФИАС, aolevel = 90)
Формализованное
наименование
дополнительной
территории (ФИАС)
Краткое наименование
типа дополнительной
территории (ФИАС)
Код дополнительной
территории из КЛАДР
4.0.
Номер дома
text
text
text
Строение
Корпус
Литера
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>29r2r9ln074jsnigave0pl3ue5</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseList>
<inn>?</inn>
</api:GetHouseList>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Unauthorized</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>401</code>
<name>Unauthorized</name>
<description>Неавторизованный запрос</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
65
Таблица 56 – Результаты вызова метода GetHouseList
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.8
Метод SetUnlinkFromOrganization
1) Описание метода
Метод прекращения управления домом с соответствующим идентификатором.
Внешняя система может прекращать управление только теми домами, которые находятся
в управлении организаций, по которым внешней системе разрешена подписка на
раскрытие.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 57).
Таблица 57 – Входные параметры метода SetUnlinkFromOrganization
Категор
Параметр
ия
SetUnlin house_id
kFromOr
ganizatio date_stop
nIn
stop_reason_type
Тип
Max
символов
Обязательн
ость
Да
Описание
Идентификатор
дома
Дата
При
stop_reason_t прекращения
ype !=1, поле обслуживания
обязательно,
а иначе не
заполняется
Основание
Да
bigint
date
ContractStopR
66
прекращения
обслуживания
(Описано в
Таблица 58)
Причина
При
stop_reason_t завершения
ype !=1, поле обслуживания
обязательно,
а иначе не
заполняется
easonEnum
stop_reason
text
2500
Таблица 58– Возможные значения ContractStopReasonEnum
Тип
ContractStopReasonEn
um
Идентификатор
Значения
Дом был включен в список по ошибке
Прекращение договора управления /
Выбор иного способа управления
Дом исключен из реестра лицензий
субъекта РФ на основании решения
лицензирующего органа
Вступление в законную силу решения
суда об аннулировании лицензии
Дом исключен на основании отказа в
выдаче лицензии
1
2
3
4
5
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 59).
Таблица 59– Выходные параметры метода SetUnlinkFromOrganization в случае
ошибочного выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
67
<api:SetUnlinkFromOrganization
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<date_stop xsi:type="xsd:date">?</date_stop>
<stop_reason_type
xsi:type="api:ContractStopReasonEnum">?</stop_reason_type>
<stop_reason xsi:type="xsd:string">?</stop_reason>
</api:SetUnlinkFromOrganization>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 60 – Результаты вызова метода SetUnlinkFromOrganization
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1011
House is not in company
Дом, находится в управлении другой
организации «ИНН, НАЗВАНИЕ», по
которой нет подписки
1036
House unlinked already
Управление домом уже прекращено
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1013
Missing management date
Не заполнена дата начала управления
68
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
домом. Прежде чем прекратить
управление домом, Вам необходимо
заполнить дату начала управления с
помощью метода SetHouseProfile.
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.9
Метод SetHouseLinkToOrganization
1) Описание метода
Метод добавления дома, с соответствующим идентификатором, в управление
организации с соответствующим ИНН. Внешняя система может добавлять дома в
управление только тех организаций, по которым внешней системе разрешена подписка на
раскрытие.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 61).
Таблица 61 – Входные параметры метода SetHouseLinkToOrganization
Категор
Параметр
ия
SetHouse house_id
LinkToO
rganizati inn
onIn
Тип
Max
символов
bigint
character
varying
date_start
date
management_reas
on
character
varying
12
Обязательн
ость
Да
Описание
Идентификатор
дома
ИНН
управляющей
организации
Дата начала
управления
Основание
взятия в
управления
домом
Да
Да
255
Да
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 62).
Таблица 62– Выходные параметры метода SetHouseLinkToOrganization в случае
ошибочного выполнения
Категория
SoapFault
Параметр
code
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
integer
69
name
description
Наименование
Описание
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="https://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>29r2r9ln074jsnigave0pl3ue5</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetHouseLinkToOrganization>
<house_id>?</house_id>
<inn>?</inn>
<date_start>?</date_start>
<management_reason>?</management_reason>
</api:SetHouseLinkToOrganization>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 63 – Результаты вызова метода SetHouseLinkToOrganization
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1004
House wasn’t found
Дом с указанным идентификатором не
70
найден
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1011
House is not in company
Дом, находится в управлении другой
организации «ID УО, ИНН,
НАЗВАНИЕ», по которой нет
подписки
1012
House under the management
Дом уже под управлением
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1005
5.10 Метод SetHouseProfile
1) Описание метода
Метод изменяет данные текущей/архивной анкеты дома с соответствующим
идентификатором дома. Внешняя система может изменять данные текущих анкет домов в
управлении организаций, по которым разрешена подписка. Проверка на принадлежность
дома управляющей организации, по которой есть разрешение на подписку раскрытия
данных.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 64).
Таблица 64 – Входные параметры метода SetHouseProfile
Категор
Параметр
ия
SetHouse house_id
ProfileIn
reporting_period_
id
data
Тип
bigint
Обязательн
ость
Да
integer
Да
HouseProfile
Data
Да
Max
символов
Описание
Идентификатор
дома
Идентификатор
отчетного
периода
Массив данных
(Описано в
Таблица 65)
Таблица 65– Массив данных (HouseProfileData) метода SetHouseProfile
Категор
Параметр
ия
HousePr area_total
Тип
decimal
Max
символов
15.2
71
Обязательн
ость
Да
Описание
Общая
площадь
Категор
ия
ofileData
Параметр
area_residental
Тип
Max
символов
decimal
15.2
area_non_resident decimal
al
15.2
cadastral_number
text
exploitation_start
_year
project_type
text
character
varying
character
varying
255
individual_name
character
varying
255
house_type
HouseTypeEn
um
wall_material
HouseWallMa
terialEnum
floor_type
HouseFloorTy
peEnum
storeys_count
entrance_count
integer
integer
elevators_count
integer
area_private
area_municipal
decimal
decimal
location_descripti
on
255
15.2
15.2
72
Обязательн
ость
Описание
помещений
В том числе
жилых
помещений
Общая
площадь
нежилых
помещений
Кадастровый
номер
Год ввода в
эксплуатацию
Серия, тип
проекта
Описание
местоположени
я
Индивидуально
е наименование
дома
Идентификатор
типа жилого
дома
(Описано в
Таблица 68)
Идентификатор
материала
несущих стен
(Описание в
Таблица 69)
Идентификатор
типа
перекрытий
(Описание в
Таблица 70)
Этажность
Количество
подъездов
Количество
лифтов
Частная
Муниципальна
я
Категор
ия
Параметр
Тип
area_national
decimal
Max
символов
15.2
area_land
decimal
15.2
area_territory
decimal
15.2
inventory_numbe
r
flats_count
character
varying
bigint
255
residents_count
text
accounts_count
bigint
constuction_featu
res
character
varying
255
thermal_actual_e
xpense
decimal
15.2
thermal_normativ
e_expense
decimal
15.2
energy_efficiency
HouseEnergy
EfficiencyClas
sEnum
energy_audit_dat
e
date
privatization_start
_date
deterioration_tota
l
deterioration_fou
ndation
deterioration_bear
date
decimal
15.2
decimal
15.2
decimal
15.2
73
Обязательн
ость
Описание
Государственн
ая
Площадь
участка, м2
Площадь
придомовой
территории, м2
Инвентарный
номер
Количество
квартир
Количество
жителей
Количество
лицевых счетов
Конструктивны
е особенности
дома
фактический
удельный
расход,
Вт/М3Сград
нормативный
удельный
расход,
Вт/М3Сград
Идентификатор
класса
энергоэффекти
вности
(Описано в
Таблица 71)
Дата
проведения
энергетическог
о аудита
Дата начала
приватизации
Общая степень
износа
Степень износа
фундамента
Степень износа
Категор
ия
Параметр
ing_walls
deterioration_floo
r
facade
Тип
decimal
Max
символов
15.2
Facade
roof
Roof
basement
Basement
common_space
CommonSpac
e
chute
Chute
heating_system
HeatingSyste
m
hot_water_system
HotWaterSyst
em
cold_water_syste
m
ColdWaterSys
tem
sewerage_system
SewerageSyst
em
electricity_system
ElectricitySyst
em
74
Обязательн
ость
Описание
несущих стен
Степень износа
перекрытий
Фасад
(Описано в
Таблица 72)
Кровля
(Описано в
Таблица 73)
Подвал
(Описание в
Таблица 74)
Помещения
общего
пользования
(Описание в
Таблица 76)
Мусоропровод
ы (Описание в
Таблица 77)
Система
отопления
(Описание в
Таблица 78)
Система
горячего
водоснабжения
(Описание в
Таблица 81)
Система
холодного
водоснабжения
(Описание в
Таблица 83)
Система
водоотведения
(канализация).
(Описание в
Таблица 85)
Система
электроснабже
ния (Описание
в Таблица 87)
Категор
ия
Параметр
Тип
gas_system
GasSystem
lifts
Lift
Max
символов
Provider
electricity_provid
er
Provider
gas_provider
Provider
hot_water_provid
er
Provider
cold_water_provi
der
Provider
drainage_provider Provider
finance
Описание
Система
газоснабжения
(Описание в
Таблица 89)
Лифт
(Описание в
Таблица 91)
Управление
(Описание в
Таблица 92)
Поставщик
отопления
(Описание в
Таблица 94)
Поставщик
электричества
(Описание в
Таблица 94)
Поставщик газа
(Описание в
Таблица 94)
Поставщик
горячей воды
(Описание в
Таблица 94)
Поставщик
холодной воды
(Описание в
Таблица 94)
Поставщик
водоотведения
(Описание в
Таблица 94)
Финансы
(Описание в
Таблица 95)
management_cont ManagementC
ract
ontract
heating_provider
Обязательн
ость
Finance
Таблица 66– Возможные значения HouseStateEnum
Тип
HouseStateEnum
Идентификатор
Значения
1
2
3
normal
warning
alarm
75
Тип
Идентификатор
Значения
4
noinfo
Таблица 67– Возможные значения HouseStageEnum
Тип
HouseStageEnum
Идентификатор
Значения
exploited
decommissioned – пока запретили
изменение
drifting – пока запретили изменение
1
2
3
Таблица 68– Возможные значения HouseTypeEnum
Тип
HouseTypeEnum
Идентификатор
Значения
Общежитие
Объект индивидуального жилищного
строительства
Жилой дом блокированной застройки
Многоквартирный дом
1
2
3
4
Таблица 69– Возможные значения HouseWallMaterialEnum
Тип
HouseWallMaterialEnu
m
Идентификатор
Значения
Нет данных
Каменные, кирпичные
Панельные
Блочные
Смешанные
Монолитные
Деревянные
Прочие
1
2
3
4
5
6
7
8
Таблица 70– Возможные значения HouseFloorTypeEnum
Тип
HouseFloorTypeEnum
Идентификатор
Значения
Нет данных
Железобетонные
Деревянные
Смешанные
1
2
3
4
Таблица 71– Возможные значения HouseEnergyEfficiencyClassEnum
Тип
HouseEnergyEfficiency
ClassEnum
Идентификатор
Значения
Нет данных
Не присвоен
A
B
1
2
3
4
76
Тип
Идентификатор
Значения
5
6
7
8
9
B+
B++
C
D
E
Таблица 72– Описание типа Facade
Тип
Facade
Параметр
Тип
area_total
decimal
Max
символов
15.2
area_plastere
d
area_unplaste
red
area_panel
decimal
15.2
decimal
15.2
decimal
15.2
area_tiled
decimal
15.2
area_lined_si
ding
decimal
15.2
area_wooden
decimal
15.2
area_insulate
d_decorative
_plaster
decimal
15.2
area_insulate
d_tiles
decimal
15.2
area_insulate
d_siding
decimal
15.2
area_riprap
area_glazing
_common_w
ooden
decimal
decimal
15.2
15.2
area_glazing
_common_pl
decimal
15.2
Обязател
ьность
Описание
Площадь фасада общая,
м2
Площадь фасада
оштукатуренная, м2
Площадь фасада
неоштукатуренная, м2
Площадь фасада
панельная, м2
Площадь фасада,
облицованная плиткой,
м2
Площадь фасада,
облицованная
сайдингом, м2
Площадь фасада
деревянная, м2
Площадь утепленного
фасада с отделкой
декоративной
штукатуркой, м2
Площадь утепленного
фасада с отделкой
плиткой, м2
Площадь утепленного
фасада с отделкой
сайдингом, м2
Площадь отмостки, м2
Площадь остекления
мест общего
пользования (дерево),
м2
Площадь остекления
мест общего
77
Тип
Параметр
Тип
Max
символов
Обязател
ьность
Описание
пользования (пластик),
м2
astic
area_glazing
_individual_
wooden
area_door_fil
lings_metal
decimal
15.2
decimal
15.2
area_door_fil
lings_others
last_overhaul
_date
decimal
15.2
Площадь
индивидуального
остекления (дерево), м2
Площадь
металлических дверных
заполнений, м2
Площадь иных дверных
заполнений, м2
Год проведения
последнего
капитального ремонта
text
Таблица 73– Описание типа Roof
Тип
Roof
Параметр
Тип
area_total
decimal
Max
символов
15.2
area_pitched
_slate
area_pitched
_metal
decimal
15.2
decimal
15.2
area_pitched
_others
area_flat
decimal
15.2
decimal
15.2
last_overhaul
_date
text
Обязател
ьность
Описание
Площадь кровли общая,
м2
Площадь кровли
шиферная скатная, м2
Площадь кровли
металлическая скатная,
м2
Площадь кровли иная
скатная, м2
Площадь кровли
плоская, м2
Год проведения
последнего
капитального ремонта
кровли
Таблица 74– Описание типа Basement
Тип
Basement
Параметр
Тип
basement_sta
ge
BasementSt
ageEnum
basement_are
a
decimal
Max
символов
Обязател
ьность
Описание
Сведения о подвале
(Возможные значения в
Таблица 75)
Площадь подвальных
помещений (включая
помещения подвала и
15.2
78
Тип
Параметр
basement_las
t_overhaul_d
ate
Тип
Max
символов
Обязател
ьность
Описание
техподполье, если оно
требует ремонта), м2
Год проведения
последнего
капитального ремонта
подвальных помещений
text
Таблица 75– Возможные значения BasementStageEnum
Тип
BasementStageEnum
Идентификатор
Значения
нет данных
отсутствует
эксплуатируемый
неэксплуатируемый
1
2
3
4
Таблица 76– Описание типа CommonSpace
Категория
Параметр
Тип
CommonSp
ace
common_spa
ce_area
decimal
common_spa
ce_overhaul_
date
text
Max
символов
15.2
Обязател
ьность
Max
символов
Обязател
ьность
Описание
Площадь помещений
общего пользования,
м2
Год проведения
последнего ремонта
помещений общего
пользования. Формат
поля 4 цифры,
например, ‘2015’.
Таблица 77– Описание типа Chute
Категория
Chute
Параметр
chute_count
Тип
Описание
Количество
мусоропроводов в доме
Год проведения
последнего
капитального ремонта
мусоропроводов
integer
chute_last_ov text
erhaul_date
Таблица 78– Описание типа HeatingSystem
Категория
Параметр
Тип
HeatingSyst
system_name
HeatingSyst
Max
символов
Обязател
ьность
Описание
Идентификатор типа
79
Категория
Параметр
em
Тип
Max
символов
Обязател
ьность
(Возможные значения в
Таблица 79)
Количество
элеваторных узлов
системы отопления
Длина трубопроводов
системы отопления, м
emNameEn
um
bigint
elevators
system_lengt
h
decimal
last_overhaul
_date
text
Описание
10.2
input_points_ integer
count
Год проведения
последнего
капитального ремонта
системы отопления
Количество точек ввода
отопления
control_node
s_count
integer
Количество узлов
управления отоплением
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Количество
общедомовых приборов
учета отопления
Идентификатор
отпуска отопления
(Возможные значения в
Таблица 80)
Таблица 79– Возможные значения HeatingSystemNameEnum
Тип
HeatingSystemNameEn
um
Идентификатор
Значения
нет данных
отсутствует
центральное
автономное
поквартирное
печное
1
2
3
4
5
6
Таблица 80– Возможные значения ProvisioningEnum
Тип
ProvisioningEnum
Идентификатор
Значения
нет данных
по нормативам или квартирным ПУ
по показаниям общедомовых ПУ
1
2
3
80
Таблица 81– Описание типа HotWaterSystem
Категория
Параметр
HotWaterSy system_name
stem
system_lengt
h
last_overhaul
_date
Тип
Max
символов
Обязател
ьность
Тип
(Возможные значения в
Таблица 82)
Длина трубопроводов
системы горячего
водоснабжения, м
Год проведения
последнего
капитального ремонта
системы горячего
водоснабжения
Количество точек ввода
горячей воды
HotWaterSy
stemNameE
num
decimal
10.2
text
input_points_ integer
count
control_node
s_count
integer
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество узлов
управления поставкой
горячей воды
Количество
общедомовых приборов
учета горячей воды
Отпуск горячей воды
производится
(Возможные значения в
Таблица 80)
Таблица 82– Возможные значения HotWaterSystemNameEnum
Тип
HotWaterSystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованная открытая
централизованная закрытая
поквартирная
автономная
1
2
3
4
5
6
Таблица 83– Описание типа ColdWaterSystem
Категория
Параметр
ColdWaterS system_name
ystem
Тип
Max
символов
Обязател
ьность
Описание
Тип
(Возможные значения в
Таблица 84)
ColdWaterS
ystemName
Enum
81
Категория
Параметр
Тип
system_lengh
t
decimal
last_overhaul
_date
text
Max
символов
10.2
Обязател
ьность
Длина трубопроводов
системы холодного
водоснабжения, м
Год проведения
последнего
капитального ремонта
системы холодного
водоснабжения
Количество точек ввода
холодной воды
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета холодной воды
Отпуск холодной воды
производится
(Возможные значения в
Таблица 80)
Таблица 84– Возможные значения ColdWaterSystemNameEnum
Тип
ColdWaterSystemNam
eEnum
Идентификатор
Значения
нет данных
отсутствует
централизованное
автономное
1
2
3
4
Таблица 85– Описание типа SewerageSystem
Категория
Параметр
SewerageSy system_name
stem
system_lengt
h
last_overhaul
_date
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор типа
(Возможные значения в
Таблица 86)
Длина трубопроводов
системы
водоотведения, м
Год проведения
последнего
капитального ремонта
системы водоотведения
(канализации)
SewerageSy
stemNameE
num
decimal
10.2
text
82
Таблица 86– Возможные значения SewerageSystemNameEnum
Тип
SewerageSystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованная
автономная
1
2
3
4
Таблица 87– Описание типа ElectricitySystem
Категория
Параметр
Тип
ElectricityS
ystem
system_name
ElectricityS
ystemName
Enum
system_lengt
h
decimal
last_overhaul
_date
text
Max
символов
Обязател
ьность
Система
электроснабжения
(Возможные значения в
Таблица 88)
Длина сетей в местах
общего пользования, м
10.2
Год проведения
последнего капремонта
системы
электроснабжения
Количество точек ввода
электричества
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета электричества
Отпуск электричества
производится
(Возможные значения в
Таблица 80)
Таблица 88– Возможные значения ElectricitySystemNameEnum
Тип
ElectricitySystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованное
комбирированное
1
2
3
4
Таблица 89– Описание типа GasSystem
Категория
Параметр
Тип
GasSystem
system_name
GasSystem
Max
символов
Обязател
ьность
Описание
Вид системы
83
Категория
Параметр
Тип
Max
символов
Обязател
ьность
газоснабжения
(Возможные значения в
Таблица 90)
Длина сетей
соответствующих
требованиям
Длина сетей не
соответствующих
требованиям
Год проведения
последнего капремонта
системы газоснабжения
Количество точек ввода
газа
NameEnum
system_lengt
h
decimal
10.2
system_lengt
h_no_require
ments
last_overhaul
_date
decimal
10.2
text
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета газа
Отпуск газа
производится
(Возможные значения в
Таблица 80)
Таблица 90– Возможные значения GasSystemNameEnum
Тип
GasSystemNameEnum
Идентификатор
Значения
нет данных
отсутствует
централизованное
1
2
3
Таблица 91– Описание типа Lift
Категория
Lift
Параметр
porch_numbe
r
factory_num
ber
stops_count
capacity
date_exploita
tion
date_last_rep
air
Тип
character
varying
character
varying
integer
integer
text
Max
символов
255
Обязател
ьность
Описание
номер подъезда
заводской номер
255
количество остановок
грузоподъемность, кг
год ввода в
эксплуатацию
год проведения
последнего капремонта
text
84
Категория
Параметр
Тип
plan_period
date
manufacturer
text
Max
символов
Обязател
ьность
Описание
плановый срок замены
(вывода из
эксплуатации)
изготовитель
Таблица 92– Описание типа ManagementContract
Категория
Параметр
Managemen contract_type
tContract
date_start
Тип
Max
символов
Обязател
ьность
Описание
Тип договора
управления
(Возможные значения в
Таблица 93)
Дата начала
обслуживания дома по
договору управления
ContractTy
peEnum
date
Плановая дата
прекращения
обслуживания дома по
договору управления
Выполняемые работы
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Выполнение
обязательств
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Примечание
Стоимость услуг
Массив
идентификаторов
файлов. Если
plan_date_sto date
p
jobs
jobs_files
text
ArrayOfInt
2500
responsibility
text
2500
responsibility
_files
ArrayOfInt
notice
service_cost
service_cost_
files
text
text
ArrayOfInt
2500
2500
85
resources_tsz
_zsk
resources_tsz
_zsk_files
text
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Средства ТСЖ или
ЖСК
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Условия оказания услуг
ТСЖ или ЖСК
Массив
идентификаторов
файлов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
2500
ArrayOfInt
terms_service text
_tsz_zsk
terms_service ArrayOfInt
_tsz_zsk_file
s
2500
Таблица 93– Возможные значения ContractTypeEnum
Тип
ContractTypeEnum
Идентификатор
Значения
обслуживаемых ТСЖ
обслуживаемых по договору между
ТСЖ и управляющей организацией
обслуживаемых по договору между
собственниками и управляющей
организацией
обслуживаемых по результатам
открытого конкурса органов местного
самоуправления
обслуживаемых по договору
управления между застройщиком и
управляющей организацией,
отобранной по результатам открытого
конкурса органом местного
самоуправления
обслуживаемых по договору
управления специализированным
жилищным фондом военных городков
Минобороны РФ
1
2
3
4
5
6
86
Таблица 94– Описание типа Provider
Категория
Provider
Параметр
inn
alias
additional_in
fo
supplied_via
_managemen
t_organizatio
n
is_supported
Тип
character
varying
character
varying
character
varying
boolean
Max
символов
12
Обязател
ьность
Описание
ИНН
Наименование
поставщика
Дополнительная
информация
Поставляется через
управляющую
организацию
255
255
Услуга не
предоставляется
boolean
Таблица 95– Описание типа Finance
Категория
Finance
Параметр
Тип
income_man
agement
decimal
Max
символов
15.2
income_man
agement_co
mmon_prope
rty
management
_costs
decimal
15.2
decimal
15.2
debt_owners
_total
decimal
15.2
charged_own
ers_total
decimal
15.2
payment_clai
ms_compens
ation
decimal
15.2
87
Обязател
ьность
Описание
Доход от управления за
отчетный период, тыс.
руб.
Доход от управления
общим имуществом за
отчетный период, тыс.
руб.
Расходы на управление
за отчетный период,
тыс. руб.
Задолженность
собственников за
услуги управления за
отчетный период, тыс.
руб.
Взыскано с
собственников за
услуги управления за
отчетный период, тыс.
руб.
Иски по компенсации
нанесенного ущерба
Категория
Параметр
Тип
payment_clai
ms_refusal
decimal
Max
символов
15.2
payment_clai
ms_not_deliv
ered
decimal
15.2
repair_work
decimal
15.2
beautification
_work
decimal
15.2
raised_funds
_subsidies
decimal
15.2
raised_funds
_credits
decimal
15.2
raised_funds
_leasing
decimal
15.2
raised_funds
_energy_serv
ice
decimal
15.2
raised_funds
_contribution
s
decimal
15.2
raised_funds
_others
decimal
15.2
income_supp
decimal
15.2
88
Обязател
ьность
Описание
Иски по снижению
платы в связи с
неоказанием услуг
Иски по снижению
платы в связи с
недопоставкой
ресурсов
Объем работ по
ремонту за отчетный
период, тыс. руб.
Объем работ по
благоустройству за
отчетный период, тыс.
руб.
Объем привлеченных
средств за отчетный
период, тыс. руб.
(субсидии)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(кредиты)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(финансирование по
договорам лизинга)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(финансирование по
энергосервисным
договорам)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(целевые взносы
жителей)
Объем привлеченных
средств за отчетный
период, тыс. руб. (иные
источники)
Мой дом – Финансы –
Категория
Параметр
Тип
Max
символов
decimal
15.2
income_supp
ly_gaz
decimal
15.2
income_supp
ly_hot_water
decimal
15.2
income_supp
ly_cold_wate
r
decimal
15.2
income_supp
ly_wastewate
r
decimal
15.2
debt_owners
_heating
decimal
15.2
debt_owners
_electricity
decimal
15.2
Описание
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб.
(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб.
(водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
отчетный период, тыс.
руб (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
ly_heating
income_supp
ly_electricity
Обязател
ьность
89
Категория
Параметр
Тип
Max
символов
debt_owners
_gaz
decimal
15.2
debt_owners
_hot_water
decimal
15.2
debt_owners
_cold_water
decimal
15.2
debt_owners
_wastewater
decimal
15.2
charged_serv
ices_heating
decimal
15.2
charged_serv decimal
ices_electricit
y
15.2
charged_serv
ices_gaz
15.2
decimal
Обязател
ьность
Описание
отчетный период, тыс.
руб (электричество)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
отчетный период, тыс.
руб (газ)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
отчетный период, тыс.
руб (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
отчетный период, тыс.
руб (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ за
отчетный период, тыс.
руб (водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб.(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
90
Категория
Параметр
Тип
Max
символов
charged_serv
ices_hot_wat
er
decimal
15.2
charged_serv
ices_cold_wa
ter
decimal
15.2
charged_serv
ices_wastewa
ter
decimal
15.2
paid_services
_heating
decimal
15.2
paid_services
_electricity
decimal
15.2
paid_services
_gaz
decimal
15.2
Обязател
ьность
Описание
собственников за КУ за
отчетный период, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб.(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
91
Категория
Параметр
Тип
Max
символов
paid_services
_hot_water
decimal
15.2
paid_services
_cold_water
decimal
15.2
paid_resourc
es_heating
decimal
15.2
paid_resourc
es_electricity
decimal
15.2
paid_resourc
es_gaz
decimal
15.2
paid_resourc
es_hot_water
decimal
15.2
Обязател
ьность
Описание
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (электричество)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
92
Категория
Параметр
paid_resourc
es_cold_wate
r
Тип
decimal
Max
символов
Обязател
ьность
Описание
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (холодное
водоснабжение)
15.2
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 96).
Таблица 96– Выходные параметры метода SetHouseProfile в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header>
<api:Login
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<login xsi:type="xsd:string">?</login>
<password xsi:type="xsd:string">?</password>
</api:Login>
</soapenv:Header>
<soapenv:Body>
<api:SetHouseProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<data xsi:type="api:HouseProfileData">
<!--You may enter the following 53 items in any order-->
<area_total xsi:type="api:Decimal152">?</area_total>
<area_residential xsi:type="api:Decimal152">?</area_residential>
<area_non_residential
xsi:type="api:Decimal152">?</area_non_residential>
<cadastral_number xsi:type="xsd:string">?</cadastral_number>
<project_type xsi:type="xsd:string">?</project_type>
93
<location_description
xsi:type="xsd:string">?</location_description>
<individual_name xsi:type="xsd:string">?</individual_name>
<house_type xsi:type="api:HouseTypeEnum">?</house_type>
<exploitation_start_year
xsi:type="xsd:string">?</exploitation_start_year>
<wall_material
xsi:type="api:HouseWallMaterialEnum">?</wall_material>
<floor_type xsi:type="api:HouseFloorTypeEnum">?</floor_type>
<storeys_count xsi:type="xsd:int">?</storeys_count>
<entrance_count xsi:type="xsd:int">?</entrance_count>
<elevators_count xsi:type="xsd:int">?</elevators_count>
<area_private xsi:type="api:Decimal152">?</area_private>
<area_municipal xsi:type="api:Decimal152">?</area_municipal>
<area_national xsi:type="api:Decimal152">?</area_national>
<area_land xsi:type="api:Decimal152">?</area_land>
<area_territory xsi:type="api:Decimal152">?</area_territory>
<inventory_number xsi:type="xsd:string">?</inventory_number>
<flats_count xsi:type="xsd:int">?</flats_count>
<residents_count xsi:type="xsd:int">?</residents_count>
<accounts_count xsi:type="xsd:int">?</accounts_count>
<construction_features
xsi:type="xsd:string">?</construction_features>
<thermal_actual_expense
xsi:type="api:Decimal152">?</thermal_actual_expense>
<thermal_normative_expense
xsi:type="api:Decimal152">?</thermal_normative_expense>
<energy_efficiency
xsi:type="api:HouseEnergyEfficiencyClassEnum">?</energy_efficiency>
<energy_audit_date xsi:type="xsd:date">?</energy_audit_date>
<privatization_start_date
xsi:type="xsd:date">?</privatization_start_date>
<deterioration_total
xsi:type="api:Decimal152">?</deterioration_total>
<deterioration_foundation
xsi:type="api:Decimal152">?</deterioration_foundation>
<deterioration_bearing_walls
xsi:type="api:Decimal152">?</deterioration_bearing_walls>
<deterioration_floor
xsi:type="api:Decimal152">?</deterioration_floor>
<facade xsi:type="api:Facade">
<!--You may enter the following 18 items in any order-->
<area_total xsi:type="api:Decimal152">?</area_total>
<area_plastered xsi:type="api:Decimal152">?</area_plastered>
<area_unplastered
xsi:type="api:Decimal152">?</area_unplastered>
<area_panel xsi:type="api:Decimal152">?</area_panel>
<area_tiled xsi:type="api:Decimal152">?</area_tiled>
<area_lined_siding
xsi:type="api:Decimal152">?</area_lined_siding>
<area_wooden xsi:type="api:Decimal152">?</area_wooden>
<area_insulated_decorative_plaster
xsi:type="api:Decimal152">?</area_insulated_decorative_plaster>
<area_insulated_tiles
xsi:type="api:Decimal152">?</area_insulated_tiles>
<area_insulated_siding
xsi:type="api:Decimal152">?</area_insulated_siding>
<area_riprap xsi:type="api:Decimal152">?</area_riprap>
<area_glazing_common_wooden
xsi:type="api:Decimal152">?</area_glazing_common_wooden>
<area_glazing_common_plastic
xsi:type="api:Decimal152">?</area_glazing_common_plastic>
94
<area_glazing_individual_wooden
xsi:type="api:Decimal152">?</area_glazing_individual_wooden>
<area_glazing_individual_plastic
xsi:type="api:Decimal152">?</area_glazing_individual_plastic>
<area_door_fillings_metal
xsi:type="api:Decimal152">?</area_door_fillings_metal>
<area_door_fillings_others
xsi:type="api:Decimal152">?</area_door_fillings_others>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
</facade>
<roof xsi:type="api:Roof">
<!--You may enter the following 6 items in any order-->
<area_total xsi:type="api:Decimal152">?</area_total>
<area_pitched_slate
xsi:type="api:Decimal152">?</area_pitched_slate>
<area_pitched_metal
xsi:type="api:Decimal152">?</area_pitched_metal>
<area_pitched_others
xsi:type="api:Decimal152">?</area_pitched_others>
<area_flat xsi:type="api:Decimal152">?</area_flat>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
</roof>
<basement xsi:type="api:Basement">
<!--You may enter the following 3 items in any order-->
<basement_stage
xsi:type="api:BasementStageEnum">?</basement_stage>
<basement_area xsi:type="api:Decimal152">?</basement_area>
<basement_last_overhaul_date
xsi:type="xsd:string">?</basement_last_overhaul_date>
</basement>
<common_space xsi:type="api:CommonSpace">
<!--You may enter the following 2 items in any order-->
<common_space_area
xsi:type="api:Decimal152">?</common_space_area>
<common_space_overhaul_date
xsi:type="xsd:string">?</common_space_overhaul_date>
</common_space>
<chute xsi:type="api:Chute">
<!--You may enter the following 2 items in any order-->
<chute_count xsi:type="xsd:int">?</chute_count>
<chute_last_overhaul_date
xsi:type="xsd:string">?</chute_last_overhaul_date>
</chute>
<heating_system xsi:type="api:HeatingSystem">
<!--You may enter the following 8 items in any order-->
<system_name
xsi:type="api:HeatingSystemNameEnum">?</system_name>
<elevators xsi:type="xsd:int">?</elevators>
<system_length xsi:type="api:Decimal152">?</system_length>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<input_points_count xsi:type="xsd:int">?</input_points_count>
<control_nodes_count
xsi:type="xsd:int">?</control_nodes_count>
<metering_devices_count
xsi:type="xsd:int">?</metering_devices_count>
<provisioning xsi:type="api:ProvisioningEnum">?</provisioning>
</heating_system>
<hot_water_system xsi:type="api:HotWaterSystem">
<!--You may enter the following 7 items in any order-->
95
<system_name
xsi:type="api:HotWaterSystemNameEnum">?</system_name>
<system_length xsi:type="api:Decimal152">?</system_length>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<input_points_count xsi:type="xsd:int">?</input_points_count>
<control_nodes_count
xsi:type="xsd:int">?</control_nodes_count>
<metering_devices_count
xsi:type="xsd:int">?</metering_devices_count>
<provisioning xsi:type="api:ProvisioningEnum">?</provisioning>
</hot_water_system>
<cold_water_system xsi:type="api:ColdWaterSystem">
<!--You may enter the following 6 items in any order-->
<system_name
xsi:type="api:ColdWaterSystemNameEnum">?</system_name>
<system_length xsi:type="api:Decimal152">?</system_length>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<input_points_count xsi:type="xsd:int">?</input_points_count>
<metering_devices_count
xsi:type="xsd:int">?</metering_devices_count>
<provisioning xsi:type="api:ProvisioningEnum">?</provisioning>
</cold_water_system>
<sewerage_system xsi:type="api:SewerageSystem">
<!--You may enter the following 3 items in any order-->
<system_name
xsi:type="api:SewerageSystemNameEnum">?</system_name>
<system_length xsi:type="api:Decimal152">?</system_length>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
</sewerage_system>
<electricity_system xsi:type="api:ElectricitySystem">
<!--You may enter the following 6 items in any order-->
<system_name
xsi:type="api:ElectricitySystemNameEnum">?</system_name>
<system_length xsi:type="api:Decimal152">?</system_length>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<input_points_count xsi:type="xsd:int">?</input_points_count>
<metering_devices_count
xsi:type="xsd:int">?</metering_devices_count>
<provisioning xsi:type="api:ProvisioningEnum">?</provisioning>
</electricity_system>
<gas_system xsi:type="api:GasSystem">
<!--You may enter the following 7 items in any order-->
<system_name xsi:type="api:GasSystemNameEnum">?</system_name>
<system_length xsi:type="api:Decimal152">?</system_length>
<system_length_no_requirements
xsi:type="api:Decimal152">?</system_length_no_requirements>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<input_points_count xsi:type="xsd:int">?</input_points_count>
<metering_devices_count
xsi:type="xsd:int">?</metering_devices_count>
<provisioning xsi:type="api:ProvisioningEnum">?</provisioning>
</gas_system>
<lifts xsi:type="api:ArrayOfLift"
soapenc:arrayType="api:Lift[]"/>
<management_contract xsi:type="api:ManagementContract">
<!--You may enter the following 9 items in any order-->
<contract_type
xsi:type="api:ContractTypeEnum">?</contract_type>
96
<date_start xsi:type="xsd:date">?</date_start>
<plan_date_stop xsi:type="xsd:date">?</plan_date_stop>
<jobs xsi:type="xsd:string">?</jobs>
<responsibility xsi:type="xsd:string">?</responsibility>
<notice xsi:type="xsd:string">?</notice>
<service_cost xsi:type="xsd:string">?</service_cost>
<resources_tsz_zsk xsi:type="xsd:string">?</resources_tsz_zsk>
<terms_service_tsz_zsk
xsi:type="xsd:string">?</terms_service_tsz_zsk>
</management_contract>
<heating_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
</heating_provider>
<electricity_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
</electricity_provider>
<gas_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
</gas_provider>
<hot_water_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
</hot_water_provider>
<cold_water_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
</cold_water_provider>
<drainage_provider xsi:type="api:Provider">
<!--You may enter the following 5 items in any order-->
<is_supported xsi:type="xsd:boolean">?</is_supported>
<supplied_via_management_organization
xsi:type="xsd:boolean">?</supplied_via_management_organization>
<inn xsi:type="xsd:string">?</inn>
<alias xsi:type="xsd:string">?</alias>
<additional_info xsi:type="xsd:string">?</additional_info>
97
</drainage_provider>
<finance xsi:type="api:Finance">
<!--You may enter the following 44 items in any order-->
<income_management
xsi:type="api:Decimal152">?</income_management>
<income_management_common_property
xsi:type="api:Decimal152">?</income_management_common_property>
<management_costs
xsi:type="api:Decimal152">?</management_costs>
<debt_owners_total
xsi:type="api:Decimal152">?</debt_owners_total>
<charged_owners_total
xsi:type="api:Decimal152">?</charged_owners_total>
<payment_claims_compensation
xsi:type="api:Decimal152">?</payment_claims_compensation>
<payment_claims_refusal
xsi:type="api:Decimal152">?</payment_claims_refusal>
<payment_claims_not_delivered
xsi:type="api:Decimal152">?</payment_claims_not_delivered>
<repair_work xsi:type="api:Decimal152">?</repair_work>
<beautification_work
xsi:type="api:Decimal152">?</beautification_work>
<raised_funds_subsidies
xsi:type="api:Decimal152">?</raised_funds_subsidies>
<raised_funds_credits
xsi:type="api:Decimal152">?</raised_funds_credits>
<raised_funds_leasing
xsi:type="api:Decimal152">?</raised_funds_leasing>
<raised_funds_energy_service
xsi:type="api:Decimal152">?</raised_funds_energy_service>
<raised_funds_contributions
xsi:type="api:Decimal152">?</raised_funds_contributions>
<raised_funds_others
xsi:type="api:Decimal152">?</raised_funds_others>
<income_supply_heating
xsi:type="api:Decimal152">?</income_supply_heating>
<income_supply_electricity
xsi:type="api:Decimal152">?</income_supply_electricity>
<income_supply_gaz
xsi:type="api:Decimal152">?</income_supply_gaz>
<income_supply_hot_water
xsi:type="api:Decimal152">?</income_supply_hot_water>
<income_supply_cold_water
xsi:type="api:Decimal152">?</income_supply_cold_water>
<income_supply_wastewater
xsi:type="api:Decimal152">?</income_supply_wastewater>
<debt_owners_heating
xsi:type="api:Decimal152">?</debt_owners_heating>
<debt_owners_electricity
xsi:type="api:Decimal152">?</debt_owners_electricity>
<debt_owners_gaz xsi:type="api:Decimal152">?</debt_owners_gaz>
<debt_owners_hot_water
xsi:type="api:Decimal152">?</debt_owners_hot_water>
<debt_owners_cold_water
xsi:type="api:Decimal152">?</debt_owners_cold_water>
<debt_owners_wastewater
xsi:type="api:Decimal152">?</debt_owners_wastewater>
<charged_services_heating
xsi:type="api:Decimal152">?</charged_services_heating>
<charged_services_electricity
xsi:type="api:Decimal152">?</charged_services_electricity>
<charged_services_gaz
xsi:type="api:Decimal152">?</charged_services_gaz>
98
<charged_services_hot_water
xsi:type="api:Decimal152">?</charged_services_hot_water>
<charged_services_cold_water
xsi:type="api:Decimal152">?</charged_services_cold_water>
<charged_services_wastewater
xsi:type="api:Decimal152">?</charged_services_wastewater>
<paid_services_heating
xsi:type="api:Decimal152">?</paid_services_heating>
<paid_services_electricity
xsi:type="api:Decimal152">?</paid_services_electricity>
<paid_services_gaz
xsi:type="api:Decimal152">?</paid_services_gaz>
<paid_services_hot_water
xsi:type="api:Decimal152">?</paid_services_hot_water>
<paid_services_cold_water
xsi:type="api:Decimal152">?</paid_services_cold_water>
<paid_resources_heating
xsi:type="api:Decimal152">?</paid_resources_heating>
<paid_resources_electricity
xsi:type="api:Decimal152">?</paid_resources_electricity>
<paid_resources_gaz
xsi:type="api:Decimal152">?</paid_resources_gaz>
<paid_resources_hot_water
xsi:type="api:Decimal152">?</paid_resources_hot_water>
<paid_resources_cold_water
xsi:type="api:Decimal152">?</paid_resources_cold_water>
</finance>
</data>
</api:SetHouseProfile>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 97 – Результаты вызова метода SetHouseProfile
Code
(Код результата
запроса)
401
Name
(Наименование)
Description
(Описание)
Неавторизованный запрос
Unauthorized
99
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1007
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1011
House is not in company
Дом, находится в управлении другой
организации «ID УО, ИНН,
НАЗВАНИЕ», по которой нет
подписки
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1005
INN wasnt found
Управляющая организация с
указанным ИНН не найдена
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1012
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.11 Метод SetNewHouse
1) Описание метода
Метод добавления нового дома с соответствующим адресом по ФИАС (GUID).
Внешняя система на вход подает GUID улицы, если дом без улицы, то на вход подается
GUID населенного пункта. Проверка существования дома с указанным адресом.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 98).
100
Таблица 98 – Входные параметры метода SetNewHouse
Категор
Параметр
ия
SetNew
address
HouseIn
Тип
Max
символов
FiasAddress
Обязательн
ость
Да
Описание
Адрес дома
(GUID по
ФИАС)
(Описано в
Таблица 23)
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 99).
Таблица 99– Выходные параметры метода SetNewHouse
Категория
SetNewHou
seOut
Параметр
house_id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор дома
integer
Таблица 100– Выходные параметры метода SetNewHouse в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate>ev4sin4te6anc6949udv23n482</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetNewHouse
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<address xsi:type="api:FiasAddress">
<!--You may enter the following 7 items in any order-->
<city_id xsi:type="xsd:string">?</city_id>
<street_id xsi:type="xsd:string">?</street_id>
<house_number xsi:type="xsd:string">?</house_number>
<building xsi:type="xsd:string">?</building>
<block xsi:type="xsd:string">?</block>
<room_number xsi:type="xsd:string">?</room_number>
<letter xsi:type="xsd:string">?</letter>
</address>
</api:SetNewHouse>
</soapenv:Body>
</soapenv:Envelope>
101
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 101 – Результаты вызова метода SetNewHouse
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
1018
House is already exist
Дом с указанным адресом уже
существует
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.12 Метод GetHouseInfo
1) Описание метода
102
Метод получения идентификатора дома с соответствующим адресом по ФИАС. По
одному адресу может быть несколько домов, например, снесенные. Возвращаем все дома.
В результате запроса получения информации по дому API - сервис может вернуть
несколько домов с одинаковым адресом. Необходимо выбрать дом, который находится в
управлении организации, по которой внешняя система раскрывает информацию. Если
таких домов несколько, то внешняя система вправе раскрывать информацию как по всем
своим домам-дублям также и по одному из домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 102).
Таблица 102 – Входные параметры метода GetHouseInfo
Категор
Параметр
ия
GetHous fias_address
eInfo
Тип
Max
символов
Обязательн
ость
Описание
Адрес дома по
ФИАС
(Описано в
FiasAddress
Таблица 23)
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 103).
Таблица 103– Выходные параметры метода GetHouseInfo
Категория
HouseInfo
Параметр
Тип
Max
символов
Обязател
ьность
Да
house_id
full_address
integer
FullAddress
inn
character
varying
state
HouseState
Enum
Да
stage
HouseStage
Enum
Да
is_drifting_fr
om
date
12
103
Описание
Идентификатор дома
Адрес дома (Описано в
Таблица 55)
ИНН текущей
организации, в
управлении которой
находится дом
Идентификатор
состояния (Описано в
Таблица 66)
Идентификатор стадия
жизненного цикла дома
(Описано в Таблица 67)
Дата сноса дома. Дата
возвращается, только
когда стадия дома
«снесен»
Таблица 104– Выходные параметры метода GetHouseInfo в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="https://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>ev4sin4te6anc6949udv23n482</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseInfo>
<address>
<!--You may enter the following 6 items in any order-->
<city_id>?</city_id>
<street_id>?</street_id>
<house_number>?</house_number>
<building>?</building>
<block>?</block>
<room_number>?</room_number>
<letter>?</letter>
</address>
</api:GetHouseInfo>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
104
Таблица 105 – Результаты вызова метода GetHouseInfo
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
1033
House wasn’t found
Дом с указанным адресом не найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.13 Метод SetUploadFile
1) Описание метода
Метод загрузки файла в систему. В качестве выходного параметра возвращается
идентификатор файла, который необходимо будет использовать при добавлении файла в
анкету управляющей организации/дома. Файл создается с временным типом. Файлы с
временным типом удаляются через сутки. Таким образом, после загрузки файла
необходимо его прикрепить к анкете организации или дома. Идентификатор файла можно
использовать лишь один раз.
Допустимые расширения файлов: .odt, .ods, .odp, .doc, .docx, .xls, .xlsx, .ppt, .pptx,
.txt, .dat, .jpg, .jpeg, .png, .pdf, .gif, .tif, rtf. Максимальный размер файла: 15Мб.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 106).
105
Таблица 106 – Входные параметры метода SetUploadFile
Категор
Параметр
ия
UploadFi name
leIn
data
Тип
Max
символов
255
character
varying
string
Обязательн
ость
Да
Да
Описание
Название
файла
Файл. Текст,
содержимое
зашифровано
B64
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 107).
Таблица 107– Выходные параметры метода SetUploadFile
Категория
FileInfo
Параметр
file_id
name
extension
size
create_date
Тип
bigint
character
varying
character
varying
integer
date
Max
символов
Обязател
ьность
Да
255
Описание
Идентификатор файла
Название файла
Расширение файла
255
Размер файла
Дата загрузки файла
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate>ev4sin4te6anc6949udv23n482</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetUploadFile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<file_object xsi:type="api:FileObject">
<!--You may enter the following 2 items in any order-->
<name xsi:type="xsd:string">?</name>
<data xsi:type="xsd:string">?</data>
</file_object>
</api:SetUploadFile>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
106
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 108 – Результаты вызова метода SetUploadFile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1022
Extension is not valid
Файл с таким расширение не допустим
к загрузке
1023
File Size Limit Exceeded
Размер загружаемого файла превышает
15MB
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.14 Метод GetFileByID
1) Описание метода
Метод получения файла с соответствующим идентификатором. Внешняя система
может получать файлы с соответствующим идентификатором из текущей/архивной
анкеты организации, по которой внешней системе разрешена подписка на раскрытие.
Внешняя система может получать файлы, с соответствующим идентификатором из
107
текущей/архивной анкеты дома, который в управлении организации, по которой
разрешена подписка. Также внешняя система может получить файлы, которые были
загружены ею с помощью метода «SetUploadFile».
2) Входные данные
В таблице представлены входные параметры метода (Таблица 109).
Таблица 109 – Входные параметры метода GetFileByID
Категория
GetFileByI
DIn
Параметр
file_id
Тип
Max
символов
bigint
Обязател
ьность
Да
Описание
Идентификатор файла
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 110).
Таблица 110– Выходные параметры метода GetFileByID
Категория
GetFileByI
DOut
Параметр
file
Тип
Max
символов
Обязател
ьность
Описание
Файл. (Описано в
Таблица 112)
FileObject
Таблица 111– Выходные параметры метода GetFileByID в случае ошибочного выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
Таблица 112 – Описание типа FileObject
Категор
Параметр
ия
FileObje name
ct
data
Тип
Max
символов
character
varying
string
Обязательн
ость
Да
Да
Описание
Название
файла
Файл. Текст,
содержимое
зашифровано
B64
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
108
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetFileByID
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<file_id xsi:type="xsd:int">?</file_id>
</api:GetFileByID>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 113 – Результаты вызова метода GetFileByID
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
Unauthorized
Неавторизованный запрос
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1035
Missing file
Файл с указанным идентификатором не
найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
401
109
5.15
Метод GetCompanyProfile
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
с соответствующим ИНН за указанный отчетный период.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 114).
Таблица 114 – Входные параметры метода GetCompanyProfile
Категория
Параметр
GetCompan inn
yProfileIn
reporting_per
iod_id
Тип
character
varying
bigint
Max
Обязател
символов
ьность
12
Да
Да
Описание
ИНН управляющей
организации
Идентификатор
отчетного периода
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 115).
Таблица 115– Выходные параметры метода GetCompanyProfile
Категория
Параметр
GetCompan
yProfileOut
GetCompany
ProfileRespo
nse
Тип
Max
символов
Обязател
ьность
Да
Описание
Массив данных
(Описано в Таблица
116)
Таблица 116–Параметры GetCompanyProfileResponse
Категория
GetCompan
yProfileRes
ponse
Параметр
inn
name_full
name_short
company_pro
file_data
files_info
Тип
character
varying
character
varying
character
varying
CompanyPr
ofileData
FileInfo
Max
Обязател
символов
ьность
12
Да
Описание
ИНН
Да
Полное наименование
юридического лица
Да
Краткое наименование
юридического лица
Да
Массив данных
(Описано в Таблица 22)
Массив файлов анкеты
управляющей
организации (описано в
Таблица 107)
Таблица 117– Выходные параметры метода GetCompanyProfile в случае ошибочного
выполнения
Категория
Параметр
Тип
Max
110
Обязател
Описание
символов
SoapFault
code
name
description
ьность
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>4be5tmhhmrla5nsuf4depd5o91</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfile>
<inn>?</inn>
<reporting_period_id>?</reporting_period_id>
</api:GetCompanyProfile>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 118 – Результаты вызова метода GetCompanyProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
111
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
Попробуйте обратиться позже.
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1005
INN wasnt found
Управляющая организация с
указанным ИНН не найдена
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.16 Метод GetHouseProfile
1) Описание метода
Метод получения данных анкеты (текущей/архивной) дома с соответствующим
идентификатором дома.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 119).
Таблица 119 – Входные параметры метода GetHouseProfile
Категория
Параметр
GetHouseP
rofileIn
house_id
reporting_per
iod_id
Тип
Max
символов
bigint
bigint
Обязател
ьность
Да
Да
Описание
Идентификатор дома
Идентификатор
отчетного периода
3) Выходные параметры
GetHouseProfileOut вызывает массив данных GetHouseProfileResponse (описано в
Таблица 120).
Таблица 120– Выходные параметры метода GetHouseProfile
Категор
Параметр
ия
GetHous house_id
eProfileR
Тип
Max
символов
integer
112
Обязательн
ость
Да
Описание
Идентификатор
дома
Категор
Параметр
ия
esponse
house_profile_dat
a
Тип
Max
символов
HouseProfile
Data
Обязательн
ость
Да
full_address
FullAddress
Да
stage
HouseStageEn
um
Да
state
HouseStateEn
um
Да
emergency_date
date
emergency_numb
er
character
varying
255
emergency_reaso
n
character
varying
255
emergency_after
character
varying
character
varying
255
inn
files
12
FileInfo
Описание
Массив данных
(Описано в
Таблица 65)
Адрес дома
(Описано в
Таблица 55)
Идентификатор
стадии
жизненного
цикла дома
(Описано в
Таблица 67)
Идентификатор
состояния дома
(Описано в
Таблица 73)
Дата документа
о признании
дома
аварийным
Номер
документа о
признании
дома
аварийным
Основание
признания
дома
аварийным
Дальнейшее
использование
ИНН текущей
организации, в
управлении
которой
находится дом
Массив файлов
анкеты
многоквартирн
ого дома
(описано в
Таблица 107)
Таблица 121– Выходные параметры метода GetHouseProfile в случае ошибочного
выполнения
Категория
Параметр
Тип
Max
113
Обязател
Описание
символов
SoapFault
code
name
description
ьность
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>tmkoa8v8thbrnkuqlnope5b8c7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfile>
<house_id>?</house_id>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
</api:GetHouseProfile>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 122 – Результаты вызова метода GetHouseProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
114
Попробуйте обратиться позже
House wasn’t found
1004
Дом с указанным идентификатором не
найден
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.17 Метод GetCompanyProfileSF
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
по указанному субъекту федерации за указанный отчетный период. Чтение данных
постраничное, на одной странице передаются 100 анкет организаций.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 123).
Таблица 123 – Входные параметры метода GetCompanyProfileSF
Категория
Параметр
GetCompan region_id
yProfileSFI
n
page_number
reporting_per
iod_id
Тип
character
varying
Max
Обязател
символов
ьность
Да
255
integer
integer
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
Идентификатор
отчетного периода
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 124).
Таблица 124– Выходные параметры метода GetCompanyProfileSF
Категория
Параметр
Тип
Max
символов
115
Обязател
ьность
Описание
GetCompan data
yProfileSFR
esponse
page_number
page_count
ArrayOfGet
CompanyPr
ofileRespon
se
integer
integer
Да
Массив данных
Да
Да
Номер страницы
Количество страниц
Массив данных ArrayOfGetCompanyProfileResponse вызывает GetCompanyProfileResponse
(Описано в Таблица 116).
Таблица 125– Выходные параметры метода GetCompanyProfileSF в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate>gpj0kj0ds4j71vlr6hcmkcgva7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfileSF
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<region_id xsi:type="xsd:string">0c089b04-099e-4e0e-955a6bf1ce525f1a</region_id>
<page_number xsi:type="xsd:int"></page_number>
<reporting_period_id xsi:type="xsd:int">8</reporting_period_id>
</api:GetCompanyProfileSF>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
116
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 126 – Результаты вызова метода GetCompanyProfileSF
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
1038
Page wasnt found
Страница с указанным номером не
найдена
1017
No permission to access
Нет доступа на чтение по указанному
Субъекту Федерации
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
117
5.18 Метод GetHouseProfileSF
1) Описание метода
Метод получения данных анкеты (текущей/архивной) дома по указанному субъекту
федерации. Чтение данных постраничное, на одной странице передаются 100 анкет домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 127).
Таблица 127 – Входные параметры метода GetHouseProfileSF
Категория
GetHouseP
rofileSFIn
Параметр
Тип
region_id
character
varying
reporting_per
iod_id
page_number
bigint
Max
Обязател
символов
ьность
Да
255
Да
integer
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Идентификатор
отчетного периода
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
3) Выходные параметры
GetHouseProfileSFOut вызывает GetHouseProfileSFResponse (описано в Таблица 128).
Таблица 128– Выходные параметры метода GetHouseProfileSF
Категория
Параметр
GetHousePr data
ofileSFResp
onse
page_number
page_count
Тип
Max
символов
ArrayOfGet
HouseProfil
eResponse
integer
integer
Обязател
ьность
Да
Да
Да
Описание
Массив данных
(Описано в Таблица
120).
Номер страницы
Количество страниц
Массив данных ArrayOfGetHouseProfileResponse вызывает GeHouseProfileResponse
(Описано в Таблица 129).
Таблица 129– Параметры GetHouseProfileResponse
Категор
Параметр
ия
GetHous house_profile_dat
eProfileR a
esponse
Тип
Max
символов
HouseProfile
Data
118
Обязательн
ость
Да
Описание
Массив данных
(Описано в
Таблица 65)
Категор
ия
Параметр
Тип
Max
символов
full_address
FullAddress
stage
HouseStageEn
um
inn
character
varying
house_id
bigint
Обязательн
ость
Да
Да
12
Да
Описание
Адрес дома
(Описано в
Таблица 55)
Идентификатор
стадии
жизненного
цикла дома
(Описано в
Таблица 67)
ИНН текущей
организации, в
управлении
которой
находится дом
Идентификатор
дома
Таблица 130– Выходные параметры метода GetHouseProfileSF в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate>gpj0kj0ds4j71vlr6hcmkcgva7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfileSF
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<region_id xsi:type="xsd:string">0c089b04-099e-4e0e-955a6bf1ce525f1a</region_id>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<page_number xsi:type="xsd:int"></page_number>
</api:GetHouseProfileSF>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
119
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 131 – Результаты вызова метода GetHouseProfileSF
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1038
Page wasnt found
Страница с указанным номером не
найдена
1017
No permission to access
Нет доступа на чтение по указанному
Субъекту Федерации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
120
5.19 Метод GetCompanyProfileSF988
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
по указанному субъекту федерации за указанный отчетный период. Чтение данных
постраничное, на одной странице передаются 100 анкет организаций.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 132).
Таблица 132 – Входные параметры метода GetCompanyProfileSF988
Категория
Параметр
GetCompan region_id
yProfileSF9
88In
reporting_per
iod_id
page_number
Тип
character
varying
Max
Обязател
символов
ьность
Да
255
Да
integer
integer
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Идентификатор
отчетного периода.
Идентификатор
отчетного периода
можно получить
методом
ReportingPeriodList
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 133).
Таблица 133– Выходные параметры метода GetCompanyProfileSF988
Категория
GetCompan
yProfileSF9
88Response
Параметр
Тип
data
ArrayOfGet
CompanyPr
ofile988Res
ponse
page_number
page_count
integer
integer
Max
символов
Обязател
ьность
Да
Да
Да
121
Описание
Массив данных.
ArrayOfGetCompanyPro
file988Response
вызывает
GetCompanyProfile988R
esponse (Описано в
Таблица 134)
Номер страницы
Количество страниц
Таблица 134–Параметры GetCompanyProfile988Response
Категория
GetCompan
yProfile988
Response
Параметр
Тип
Max
символов
inn
name_full
name_short
last_update
under_manag
ement_house
s_count
under_manag
ement_house
s_square
company_pro
file_data
files_info
character
varying
character
varying
255
Да
255
Да
Да
timestamp(0
) without
time zone
integer
decimal
Обязател
ьность
Да
15.2
Да
CompanyPr
ofileData98
8
FileInfo
Описание
ИНН юридического
лица
Полное наименование
юридического лица
Краткое наименование
юридического лица.
Если ОКОПФ
«Индивидуальный
предприниматель», то
Краткое наименование
не обязательно на ввод.
Последнее изменение
анкеты
Количество домов,
находящихся в
управлении (ед.)
Площадь домов,
находящихся в
управлении (кв.м.)
Массив данных
(описано в Таблица
135)
Массив файлов анкеты
управляющей
организации (описано в
Таблица 107)
Таблица 135 – Описание типа CompanyProfileData988
Категория
CompanyPr
ofileData98
8
Параметр
Тип
okopf
Okopf
ogrn
character
varying
character
varying
character
varying
surname
firstname
Max
символов
Обязател
ьность
Да
Описание
255
Да
ОКОПФ. Передается
код всероссийского
справочника ОКОПФ в
формате «2 80 17»
(описано в Таблица 45)
ОГРН
255
Да
Фамилия
255
Да
Имя
122
Категория
Параметр
middlename
legal_address
actual_addres
s
post_address
phone
fax
Тип
character
varying
FiasAddress
Max
символов
255
Описание
Отчество
Да
Место государственной
регистрации
юридического лица
(идентификатор
юридического адреса)
(описано в
Таблица 23)
Адрес фактического
местонахождения
органов управления
(идентификатор
фактического адреса)
(описано в
FiasAddress
Таблица 23)
Почтовый адрес
(идентификатор
почтового адреса)
(описано в
FiasAddress
text
character
varying
character
varying
32
255
site
text
2500
work_time
text
2500
email
Обязател
ьность
Таблица 23)
Контактные телефоны
Факс
Адрес электронной
почты. Формат:
[email protected]
Официальный сайт в
сети Интернет
Режим работы, в т. ч.
часы личного приема
граждан
Адрес диспетчерской
службы (описано в
255
dispatcher_ad FiasAddress
dress
dispatcher_p
hone
dispatcher_w
ork_time
proportion_sf
text
2500
text
2500
decimal
5.2
proportion_m
o
decimal
5.2
Таблица 23)
Контактные телефоны
диспетчерской службы
Режим работы
диспетчерской службы
Доля участия в
уставном капитале
Субъекта РФ, %
Доля участия в
уставном капитале
123
Категория
Параметр
Тип
staff_regular
_total
staff_regular
_administrati
ve
staff_regular
_engineers
staff_regular
_labor
membership_
information
integer
chart_file_id
integer
Max
символов
integer
integer
2500
income_of_m decimal
ng
15.2
spending_of_
mng
15.2
decimal
Описание
муниципального
образования, %
Штатная численность
всего, чел.
Штатная численность,
чел (административный
персонал)
Штатная численность,
чел (инженеры)
Штатная численность,
чел (рабочий персонал)
Сведения о членстве
управляющей
организации,
товарищества или
кооператива в
саморегулируемой
организации
Устав товарищества
собственников жилья
или кооператива. Файл
добавляется только для
товариществ и
кооперативов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Сведения о доходах,
полученных за
оказание услуг по
управлению
многоквартирными
домами (по данным
раздельного учета
доходов и расходов),
руб.
Сведения о расходах,
понесенных в связи с
оказанием услуг по
управлению
многоквартирными
домами (по данным
integer
text
Обязател
ьность
124
Категория
Параметр
Тип
Max
символов
debt_for_ku
decimal
15.2
debt_for_ther
mal_energy
decimal
15.2
debt_for_ther
mal_energy_
by_heating
decimal
15.2
debt_for_ther
mal_energy_
by_hot_water
decimal
15.2
Обязател
ьность
Описание
раздельного учета
доходов и расходов),
руб.
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб.
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
тепловой энергии)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
тепловой энергии для
нужд отопления)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
125
Категория
Параметр
Тип
Max
символов
debt_for_hot
_water
decimal
15.2
debt_for_col
d_water
decimal
15.2
debt_for_sew
erage
decimal
15.2
debt_for_gas
decimal
15.2
Обязател
ьность
Описание
организациями за
коммунальные
ресурсы, руб. (по
тепловой энергии для
нужд горячего
водоснабжения)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
горячей воде)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
холодной воде)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
водоотведению)
Общая задолженность
управляющей
организации
(индивидуального
126
Категория
Параметр
Тип
Max
символов
debt_for_elec
trical_energy
decimal
12,2
debt_for_oth
er
decimal
15.2
annual_finan
cial_statemen
t_files
ArrayOfInt
Обязател
ьность
Описание
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
поставке газа)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
электрической энергии)
Общая задолженность
управляющей
организации
(индивидуального
предпринимателя)
перед
ресурсоснабжающими
организациями за
коммунальные
ресурсы, руб. (по
прочим ресурсам
(услугам))
Массив
идентификаторов
файлов годовой
бухгалтерской
отчетности
Массив
идентификаторов
файлов смет доходов и
расходов ТСЖ и ЖСК.
Файлы добавляются
только для товариществ
и кооперативов. Если
идентификатор файла
revenues_exp ArrayOfInt
enditures_esti
mates_files
127
Категория
Параметр
Тип
Max
символов
Обязател
ьность
не указан - это означает
удаление файла из
анкеты.
Массив
идентификаторов
файлов отчетов о
выполнении сметы
доходов и расходов.
Файлы добавляются
только для товариществ
и кооперативов. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Нарушения.
ArrayOfDisturbance
вызывает Disturbance
(описано в таблице
Таблица 136)
Лицензии.
ArrayOfLicense
вызывает License
(Описано в Таблица
138). Редактирование
блока лицензий
недоступно, если
ОКОПФ с кодом «2 01
00» или «2 01 02» или
«2 01 03» или «2 01 04»
или «2 06 05» или «2 80
15» или «2 80 16».
performance_ ArrayOfInt
report_files
disturbances
ArrayOfDis
turbance
licenses
ArrayOfLic
ense
Описание
Таблица 136– Описание типа Disturbance
Тип
Disturbance
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор
нарушения. При записи
данных (метод
SetCompanyProfile988)
следующая логика
работы с нарушениями:
Если указать ID
integer
128
Тип
Параметр
Тип
Max
символов
Обязател
ьность
Описание
существующего
нарушения –
редактирование
нарушения.
Если указать ID
несуществующего
нарушения в анкете УО
– ошибка «Поле «data>disturbances>disturbance->id»
заполнено не верно».
Если не указать ID–
добавление нового
нарушения в анкету
УО. Если ничего не
прислать – удаление
нарушения.
Дата привлечения к
административной
ответственности
Тип лица,
привлеченного к
административной
ответственности
(возможные значения в
Таблица 137)
date_of_resp
onsibility
date
person_type
PersonType
person_fio
character
varying
255
person_positi
on
character
varying
255
subject_of_di
text
2500
ФИО лица,
привлеченного к
административной
ответственности. Поле
заполняется, если тип
лица = «Должностное
лицо», а иначе не
заполняется.
Должность лица,
привлеченного к
административной
ответственности. Поле
заполняется, если тип
лица = «Должностное
лицо», а иначе не
заполняется.
Предмет
129
Тип
Параметр
Тип
Max
символов
text
document_da
te
date
document_nu
mber
character
varying
document_fil
e_id
integer
measures_to_
eliminate
text
2500
integer
decimal
15.2
text
2500
Описание
административного
нарушения
Наименование
контролирующего
органа
Количество
выявленных нарушений
Размер штрафа
sturbance
supervisory_
authority_na
me
number_of_d
isturbance
amount_of_p
enalty
document_na
me
Обязател
ьность
Наименование
документа о
применении мер
административного
воздействия
Дата документа о
применении мер
административного
воздействия
Номер документа о
применении мер
административного
воздействия
Идентификатор
документа. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
Мероприятия,
проведенные для
устранения
выявленных нарушений
и результаты
административного
воздействия
255
2500
Таблица 137– Возможные значения PersonType
Тип
PersonType
Идентификатор
Значения
Юридическое лицо
Должностное лицо
1
2
130
Таблица 138– Описание типа License
Тип
License
Параметр
Тип
Max
символов
id
integer
license_numb
er
license_recei
pt_date
license_issui
ng_authority
license_docu
ment_file_id
character
varying
date
255
text
2500
Обязател
ьность
Описание
Идентификатор
лицензии. При записи
данных (метод
SetCompanyProfile988)
следующая логика
работы с нарушениями:
Если указать ID
существующей
лицензии –
редактирование
лицензии.
Если указать ID
несуществующей
лицензии в анкете УО –
ошибка «Поле «data>licenses->licence->id»
заполнено не верно».
Если не указать ID–
добавление новой
лицензии в анкету УО.
Если ничего не
прислать – удаление
лицензии.
Номер лицензии
Дата получения
лицензии
Орган, выдавший
лицензию
Идентификатор файла
лицензии. Если
идентификатор файла
не указан - это означает
удаление файла из
анкеты.
integer
Таблица 139– Выходные параметры метода GetCompanyProfileSF988 в случае
ошибочного выполнения
Категория
SoapFault
Параметр
code
name
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
integer
text
131
description
Описание
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:api="http://reformagkh.ru/api">
<soapenv:Header>
<authenticate>i1c2lhe9a99q6g71q6ldeqfpd5</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfileSF988
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<region_id xsi:type="xsd:string">29251dcf-00a1-4e34-98d45c47484a36d4</region_id>
<page_number xsi:type="xsd:int">1</page_number>
<reporting_period_id xsi:type="xsd:int">22</reporting_period_id>
</api:GetCompanyProfileSF988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 140 – Результаты вызова метода GetCompanyProfileSF988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
132
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
неспособен выполнить запрос.
Попробуйте обратиться позже.
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
1038
Page wasnt found
Страница с указанным номером не
найдена
1017
No permission to access
Нет доступа на чтение по указанному
Субъекту Федерации
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1041
Reporting period is not
related to the Resolution 988
Данные по новым формам раскрытия
информации, согласно Постановлению
Правительства РФ № 988 от 27.09.2014
не относятся к запрашиваемому
отчетному периоду
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.20 Метод GetCompanyProfile988
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
с соответствующим ИНН за указанный отчетный период.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 141).
Таблица 141 – Входные параметры метода GetCompanyProfile988
Категория
Параметр
GetCompan inn
yProfile988
In
reporting_per
iod_id
Тип
character
varying
bigint
Max
Обязател
символов
ьность
12
Да
Да
3) Выходные параметры
133
Описание
ИНН управляющей
организации
Идентификатор
отчетного периода
GetCompanyProfile988Out вызывает GetCompanyProfile988Response (Описано в
Таблица 134).
Таблица 142– Выходные параметры метода GetCompanyProfile988 в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://
reformagkh.ru/api">
<soapenv:Header>
<authenticate>ndk3a04qsobj5r1no40cjd0e42</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfile988
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">2462938589</inn>
<reporting_period_id xsi:type="xsd:int">22</reporting_period_id>
</api:GetCompanyProfile988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://api.reformagkh.ru/api_document_literal"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
134
Таблица 143 – Результаты вызова метода GetCompanyProfile988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1005
INN wasnt found
Управляющая организация с
указанным ИНН не найдена
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1041
Reporting period is not
related to the Resolution 988
Данные по новым формам раскрытия
информации, согласно Постановлению
Правительства РФ № 988 от 27.09.2014
не относятся к запрашиваемому
отчетному периоду
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.21 Метод GetHouseProfileSF988
1) Описание метода
Метод получения данных текущих/архивных анкет дома по указанному субъекту
федерации. Чтение данных постраничное, на одной странице передаются 100 анкет домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 144).
Таблица 144 – Входные параметры метода GetHouseProfileSF988
Категория
Параметр
GetHouseP region_id
rofileSF988
Тип
character
varying
Max
Обязател
символов
ьность
Да
255
135
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Категория
In
Параметр
Тип
page_number
integer
reporting_per
iod_id
bigint
Max
символов
Обязател
ьность
Да
Описание
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
Идентификатор
отчетного периода
3) Выходные параметры
В таблице представлены выходные параметры метода
GetHouseProfileSF988Out вызывает GetHouseProfileSF988Response.
(Таблица
145).
Таблица 145– Выходные параметры метода GetHouseProfileSF988Response
Категория
GetHousePr
ofileSF988
Response
Параметр
Тип
data
ArrayOfGet
HouseProfil
e988Respon
se
page_number
page_count
integer
integer
Max
символов
Обязател
ьность
Да
Да
Да
Описание
Массив
ArrayOfGetHouseProfile
988Response вызывает
GeHouseProfile988Resp
onse (описано в
Таблица 146)
Номер страницы
Количество страниц
Таблица 146– Выходные параметры метода GeHouseProfile988Response
Категория
Параметр
GetHousePr
ofile988Res
ponse
house_id
full_address
stage
inn
last_update
Тип
Max
символов
integer
FullAddress
HouseStage
Enum
character
varying
house_profile
_data
timestamp(0
) without
time zone
HouseProfil
eData988
files_info
FileInfo
Обязател
ьность
Да
Да
Да
Да
Да
Да
136
Описание
Идентификатор дома
Адрес дома
Идентификатор стадии
жизненного цикла дома
ИНН организации, в
управлении которой
находится дом
Последнее изменение
анкеты
Массив данных
(описано в таблице
Таблица 147)
Массив файлов анкеты
многоквартирного дома
(описано в Таблица
107)
Таблица 147– Описание типа HouseProfileData988
Категори
Параметр
я
HouseProf area_total
ileData988
area_residentia
l
Тип
decimal
Max
символов
15.2
decimal
15.2
area_non_resid decimal
ential
15.2
area_common_ decimal
property
15.2
is_alarm
boolean
method_of_for
ming_overhaul
_fund
integer
exploitation_st
art_year
integer
project_type
text
built_year
integer
house_type
HouseType
988Enum
integer
Да
FormingO
verhaulFu
ndEnum
2500
floor_count_m
ax
floor_count_m integer
in
entrance_count integer
elevators_coun
t
flats_count
Обязател
ьность
integer
Описание
Общая площадь дома,
кв.м
Общая площадь дома, в
т.ч. жилых помещений,
кв.м
Общая площадь дома, в
т.ч. нежилых
помещений, кв.м
Общая площадь дома, в
т.ч. помещений,
входящих в состав
общего имущества,
кв.м.
Признак аварийности.
Возможные значения:
true (да, дом
аварийный), false (нет,
дом не аварийный).
Значение по
умолчанию: «Нет».
Информация по
аварийности или при
отказе от аварийности
заполняется в теге
«alarm_info».
Способ формирования
фонда капитального
ремонта (описано в
Таблица 154).
Год ввода в
эксплуатацию (Формат:
‘2015’)
Серия, тип постройки
здания
Год постройки.
(Формат: ‘2015’)
Тип дома (описано в
Таблица 153)
Количество этажей,
наибольшее, ед.
Количество этажей,
наименьшее, ед.
Количество подъездов,
ед.
Количество лифтов, ед.
Количество
помещений, ед.
integer
137
Категори
я
Параметр
Тип
Max
символов
living_quarters
_count
integer
not_living_qua
rters_count
integer
area_land
decimal
15.2
parking_square decimal
15.2
HouseEnerg
yEfficiency
Class988En
um
additional_info text
2500
boolean
has_sportsgrou
nd
boolean
other_beautific
ation
text
foundation_typ HouseFoun
e
dationType
Enum
floor_type
HouseFloor
Type988En
um
wall_material
HouseWall
Material988
Enum
area_basement decimal
Описание
Количество
помещений, в том
числе, жилых, ед.
Количество
помещений, в том
числе, нежилых, ед.
Площадь земельного
участка, входящего в
состав общего
имущества в
многоквартирном доме,
кв.м
Площадь парковки в
границах земельного
участка, кв.м
Класс энергетической
эффективности
(описано в Таблица
152)
Дополнительная
информация
Элементы
благоустройства
(детская площадка).
Возможные значения
true (да, детская
площадка имеется),
false (нет, не имеется).
Элементы
благоустройства
(спортивная площадка).
Возможные значения
true (да, спортивная
площадка имеется) ,
false (нет, не имеется).
Элементы
благоустройства
(другое)
Идентификатор типа
фундамента (Описано в
Таблица 157)
Идентификатор типа
перекрытий (описано в
Таблица 158)
Материал несущих стен
(описано в Таблица
159)
Площадь подвала по
полу, кв.м
energy_efficie
ncy
has_playgroun
d
Обязател
ьность
2500
15.2
138
Категори
я
Параметр
Тип
chute_type
HouseChute
TypeEnum
chute_count
integer
electrical_type
HouseElectr
icalTypeEn
um
electrical_entri
es_count
heating_type
integer
hot_water_typ
e
HouseHotW
aterTypeEn
um
cold_water_ty
pe
HouseCold
WaterType
Enum
sewerage_type
HouseSewe
rageTypeEn
um
sewerage_cess
pools_volume
gas_type
decimal
ventilation_typ
e
HouseVenti
lationTypeE
num
firefighting_ty
pe
HouseFirefi
ghtingType
Enum
drainage_type
HouseDrain
ageTypeEn
Max
символов
Обязател
ьность
Описание
Идентификатор типа
мусоропровода
(описано в Таблица
160)
Количество
мусоропроводов, ед.
Идентификатор типа
системы
электроснабжения
(описано в Таблица
161)
Количество вводов в
МКД, ед.
Идентификатор типа
системы
теплоснабжения
(описано в Таблица
162)
Идентификатор типа
системы горячего
водоснабжения
(описано в Таблица
163)
Идентификатор типа
системы холодного
водоснабжения
(описано в Таблица
164)
Идентификатор типа
системы водоотведения
(описано в Таблица
165)
Объем выгребных ям,
куб.м
Идентификатор типа
системы газоснабжения
(описано в Таблица
166)
Идентификатор типа
системы вентиляции
(описано в Таблица
167)
Идентификатор типа
системы
пожаротушения
(описано в Таблица
168)
Идентификатор типа
системы водостоков
HouseHeati
ngTypeEnu
m
15.2
HouseGasT
ypeEnum
139
Категори
я
Параметр
Тип
Max
символов
ArrayOfHo
useCadastra
lNumber
facades
ArrayOfHo
useFacade
roofs
ArrayOfHo
useRoof
additional_
equipments
ArrayOfHo
useAddition
alEquipmen
t
metering_devi
ces
ArrayOfHo
useMetering
Device
lifts
ArrayOfHo
useLift
management_c
ontract
HouseMana
gementCont
ract
ArrayOfHo
useService
services
Описание
(описано в Таблица
169)
Кадастровый номер.
Массив
ArrayOfHouseCadastral
Number возвращает тип
данных
HouseCadastralNumber
(описано в Таблица
156).
Фасад. Массив данных
ArrayOfHouseFacade
возвращает тип данных
HouseFacade (описано в
Таблица 170).
Крыша. Массив данных
ArrayOfHouseRoof
возвращает тип
данныхHouseRoof
(описано в Таблица
172)
Иное
оборудование/конструк
тивный элемент.
Массив данных
ArrayOfHouseAdditional
Equipment возвращает
тип данных
HouseAdditionalEquipm
ent (описано в Таблица
175)
Общедомовые приборы
учета. Массив данных
ArrayOfHouseMetering
Device возвращает тип
данных
HouseMeteringDevice
(описано в Таблица
176)
Лифт. Массив данных
ArrayOfHouseLift
возвращает тип данных
HouseLift (описано в
Таблица 181)
Управление (описано в
Таблица 183)
um
cadastral_num
bers
Обязател
ьность
Работы (услуги) по
содержанию. Массив
140
Категори
я
Параметр
Тип
communal_ser
vices
ArrayOfHo
useCommu
nalService
common_prop
erties
ArrayOfHo
useCommo
nProperty
overhaul
HouseOver
haul
common_meet
ings
ArrayOfHo
useCommo
nMeeting
report
HouseRepor
t
alarm_info
HouseAlar
m
Max
символов
Обязател
ьность
Описание
данных
ArrayOfHouseService
возвращает тип данных
HouseService (описано
в Таблица 185)
Коммунальные услуги.
Массив данных
ArrayOfHouseCommuna
lService возвращает тип
данных
HouseCommunalService
(описано в Таблица
188)
Общее имущество.
Массив данных
ArrayOfHouseCommonP
roperty возвращает тип
данных
HouseCommonProperty
(описано в Таблица
193)
Сведения о КР
(описано в Таблица
195)
Общие собрания
собственников дома.
Массив данных
ArrayOfHouseCommon
Meeting тип данных
HouseCommonMeeting
(описано в Таблица
196)
Отчет по управлению
(описано в Таблица
197)
Информация при
признании дома
аварийным. При
признании дома
аварийным необходимо
заполнить информацию
из Таблица 148, для
отказа от аварийности
дополнительно
заполнить информацию
из Таблица 150. Пока
дом аварийный –
редактирование
информации по
аварийности доступно,
141
Категори
я
Параметр
Тип
Max
символов
Обязател
ьность
Описание
если есть отказ от
аварийности, то
редактирование
информации
недоступно. Для
повторного признания
дома аварийным
необходимо изменить
хотя бы одно поле из
Таблица 148, включая
изменение
идентификатора файла.
При условии, что
одновременно
заполнены данные двух
таблиц, произойдет
признание дома
аварийным и сразу же
отказ от аварийности.
Таблица 148– Описание типа HouseAlarm
Тип
HouseAlar
m
Параметр
Тип
document_da
te
date
document_nu
mber
character
varying
reason
AlarmReaso
nEnum
reason_other
text
failure
HouseAlar
mFailure
Max
символов
Обязател
ьность
Да
Да
255
Да
Да
2500
Описание
Дата документа
признания дома
аварийным
Номер документа
признания дома
аварийным
Причина признания
дома аварийным
(описано в Таблица
149)
Причина признания
дома аварийным (иная).
Заполняется если reason
= 6.
Информация при отказе
от аварийности дома
(Описано в
Таблица 150)
Таблица 149– Описание типа AlarmReasonEnum
Тип
AlarmReasonEnum
Идентификатор
Значения
Физический износ
Влияние окружающей среды
Природные катастрофы
1
2
3
142
Причины техногенного характера
Пожар
Иная
4
5
6
Таблица 150– Описание типа HouseAlarmFailure
Тип
HouseAlar
mFailure
Параметр
reason
Тип
Max
символов
AlarmFailur
eReasonEnu
m
Обязател
ьность
Да
Описание
Причина об отказе
признания аварийным
(описано в
Таблица 155)
document_na
me
character
varying
document_da
te
timestamp(0
) without
time zone
document_nu
mber
character
varying
files
ArrayOfInt
Наименование
документа об отказе
признания дома
аварийным. Поле
обязательное для
заполнения, если
reason != 1 (если тип
причины отказа не
равно «Ошибочный
признак состояния»)
Дата документа об
отказе признания
дома аварийным.
Поле обязательное
для заполнения, если
reason != 1 (если тип
причины отказа не
равно «Ошибочный
признак состояния»)
Номер документа об
отказе признания
дома аварийным.
Поле обязательное
для заполнения, если
reason != 1 (если тип
причины отказа не
равно «Ошибочный
признак состояния»)
Массив
идентификаторов
файлов документа об
отказе от признака
аварийности дома.
Указывается
255
255
143
Тип
Параметр
Тип
Max
символов
Обязател
ьность
Описание
идентификатор файла,
который был загружен
с помощью метода
SetUploadFile. При
повторном отказе от
аварийности
необходимо файлы
заново загрузить в
систему, а потом
прикрепить.
Таблица 151– Описание типа AlarmFailureFile
Категория
Параметр
file_id
Тип
Max
символов
Обязател
ьность
Описание
integer
Таблица 152– Возможные значения HouseEnergyEfficiencyClass988Enum
Тип
HouseEnergyEfficiency
Class988Enum
Идентификатор
Значения
Не присвоен
A
B++
B+
C
D
E
B
1
2
3
4
5
6
7
8
Таблица 153– Описание типа HouseType988Enum
Тип
HouseType988Enum
Идентификатор
Значения
Многоквартирный дом
Жилой дом блокированной застройки
Специализированный жилищный фонд
Жилой дом (индивидуальноопределенное здание)
(это значение не доступно для выбора,
по причине исключения из
справочника)
1
2
3
4
Таблица 154– Описание типа FormingOverhaulFundEnum
Тип
Идентификатор
Значения
144
FormingOverhaulFund
Enum
На специальном счете организации
На специальном счете у регионального
оператора
На счете регионального оператора
Не определен
1
2
3
4
Таблица 155– Описание типа AlarmFailureReasonEnum
Тип
AlarmFailureReasonEn
um
Идентификатор
Значения
Ошибочный признак состояния
Реконструкция
Признание пригодным для проживания
1
2
3
Таблица 156– Описание типа HouseCadastralNumber
Тип
Параметр
HouseCadas id
tralNumber
Cadastral_nu
mber
Тип
Max
символов
Описание
Идентификатор
кадастрового номера.
При записи данных
(метод
SetHouseProfile988)
следующая логика
работы с кадастровыми
номерами:
Если указать ID
существующего
кадастрового номера –
редактирование.
Если указать ID
несуществующего
кадастрового номера в
анкете дома – ошибка
«Поле «data->
cadastral_numbers >item->id» заполнено
не верно».
Если не указать ID–
добавление нового
кадастрового номера в
анкету дома. Если
ничего не прислать –
удаление кадастрового
номера.
Кадастровый номер
integer
character
varying
Обязател
ьность
250
145
Таблица 157– Возможные значения HouseFoundationTypeEnum
Тип
HouseFoundationType
Enum
Идентификатор
Значения
Ленточный
Бетонные столбы
Свайный
Иной
Столбчатый
Сплошной
Сборный
Отсутствует
1
2
3
4
5
6
7
8
Таблица 158– Возможные значения HouseFloorType988Enum
Тип
HouseFloorType988En
um
Идентификатор
Значения
Железобетонные
Деревянные
Смешанные
Иные
1
2
3
4
Таблица 159– Возможные значения HouseWallMaterial988Enum
Тип
HouseWallMaterial988
Enum
Идентификатор
Значения
Каменные, кирпичные
Панельные
Блочные
Смешанные
Деревянные
Монолитные
Иные
1
2
3
4
5
6
7
Таблица 160– Возможные значения HouseChuteTypeEnum
Тип
HouseChuteTypeEnum
Идентификатор
Значения
Отсутствует
Квартирные
На лестничной клетке
1
2
3
Таблица 161– Возможные значения HouseElectricalTypeEnum
Тип
HouseElectricalTypeEn
um
Идентификатор
Значения
Отсутствует
Центральное
Комбинированное
1
2
3
Таблица 162– Возможные значения HouseHeatingTypeEnum
Тип
Идентификатор
Значения
146
HouseHeatingTypeEnu
m
Отсутствует
Центральное
Автономная котельная (крышная,
встроенно-пристроенная)
Квартирное отопление (квартирный
котел)
Печное
Электроотопление
Индивидуальный тепловой пункт
(ИТП)
1
2
3
4
5
6
7
Таблица 163– Возможные значения HouseHotWaterTypeEnum
Тип
HouseHotWaterTypeE
num
Идентификатор
Значения
Отсутствует
Центральное (открытая система)
Центральное (закрытая система)
Автономная котельная (крышная,
встроенно-пристроенная)
Квартирное (квартирный котел)
Печное
Индивидуальный тепловой пункт
(ИТП)
1
2
3
4
5
6
7
Таблица 164– Возможные значения HouseColdWaterTypeEnum
Тип
HouseColdWaterTypeE
num
Идентификатор
Значения
Отсутствует
Центральное
Автономное
1
2
3
Таблица 165– Возможные значения HouseSewerageTypeEnum
Тип
HouseSewerageTypeEn
um
Идентификатор
Значения
Отсутствует
Центральное
Автономное
1
2
3
Таблица 166– Возможные значения HouseGasTypeEnum
Тип
HouseGasTypeEnum
Идентификатор
Значения
Отсутствует
Центральное
Автономное
1
2
3
147
Таблица 167– Возможные значения HouseVentilationTypeEnum
Тип
HouseVentilationType
Enum
Идентификатор
Значения
Отсутствует
Приточная вентиляция
Вытяжная вентиляция
Приточно-вытяжная вентиляция
1
2
3
4
Таблица 168– Возможные значения HouseFirefightingTypeEnum
Тип
HouseFirefightingType
Enum
Идентификатор
Значения
Отсутствует
Автоматическая
Пожарные гидранты
Пожарный кран
1
2
3
4
Таблица 169– Возможные значения HouseDrainageTypeEnum
Тип
HouseDrainageTypeEn
um
Идентификатор
Значения
Отсутствует
Наружные водостоки
Внутренние водостоки
Смешанные
1
2
3
4
Таблица 170– Описание типа HouseFacade
Тип
Параметр
HouseFacad id
e
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор фасада.
При записи данных
(метод
SetHouseProfile988)
следующая логика
работы с фасадами:
Если указать ID
существующего фасада
– редактирование.
Если указать ID
несуществующего
фасада в анкете дома –
ошибка «Поле «data->
facades ->item->id»
заполнено не верно».
Если не указать ID–
добавление нового
фасада в анкету дома.
Если ничего не
integer
148
Тип
Параметр
Тип
Max
символов
Обязател
ьность
прислать – удаление
фасада.
Идентификатор типа
фасада (описано в
Таблица 171)
HouseFacad
eTypeEnum
Type
Описание
Таблица 171– Возможные значения HouseFacadeTypeEnum
Тип
HouseFacadeTypeEnu
m
Идентификатор
Значения
Соответствует материалу стен
Оштукатуренный
Окрашенный
Облицованный плиткой
Облицованный камнем
Сайдинг
Иной
1
2
3
4
5
6
7
Таблица 172– Описание типа HouseRoof
Тип
HouseRoof
Параметр
Тип
id
integer
Roof_type
HouseRoof
TypeEnum
Max
символов
Обязател
ьность
Описание
Идентификатор крыши.
При записи данных
(метод
SetHouseProfile988)
следующая логика
работы с крышами:
Если указать ID
существующей крыши
– редактирование.
Если указать ID
несуществующей
крыши в анкете дома –
ошибка «Поле «data->
roofs->item->id»
заполнено не верно».
Если не указать ID–
добавление новой
крыши в анкету дома.
Если ничего не
прислать – удаление
крыши.
Идентификатор типа
крыши (описано в
149
Тип
Параметр
roofing_type
Тип
Max
символов
Обязател
ьность
Описание
Таблица 173)
Идентификатор типа
кровли (описано в
Таблица 174)
HouseRoofi
ngTypeEnu
m
Таблица 173– Возможные значения HouseRoofTypeEnum
Тип
HouseRoofTypeEnum
Идентификатор
Значения
Плоская
Скатная
1
2
Таблица 174– Возможные значения HouseRoofingTypeEnum
Тип
HouseRoofingTypeEnu
m
Идентификатор
Значения
Из волнистых и полуволнистых
асбестоцементных листов (шиферная)
Из оцинкованной стали
Из металлочерепицы
Из профилированного настила
Из рулонных материалов
Мягкая (наплавляемая) крыша
Из иного материала
Безрулонная железобетонная крыша
1
2
3
4
5
6
7
8
Таблица 175– Описание типа HouseAdditionalEquipment
Тип
HouseAddit
ionalEquip
ment
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор
дополнительного
оборудования /
конструктивного
элемента. При записи
данных (метод
SetHouseProfile988)
следующая логика
работы с
оборудованием:
Если указать ID
существующего
оборудовния–
редактирование.
Если указать ID
несуществующего
integer
150
Тип
Параметр
Тип
Max
символов
Type
character
varying
255
description
text
2500
Обязател
ьность
Описание
оборудования в анкете
дома – ошибка «Поле
«data->
additional_equipments >item->id» заполнено
не верно».
Если не указать ID–
добавление нового
оборудования в анкету
дома. Если ничего не
прислать – удаление
оборудования.
Вид оборудования /
конструктивного
элемента
Описание
дополнительного
оборудования /
конструктивного
элемента
Таблица 176– Описание типа HouseMeteringDevice
Тип
Параметр
HouseMeter id
ingDevice
Тип
Max
символов
integer
151
Обязател
ьность
Да
Описание
Идентификатор
прибора учета. При
записи данных (метод
SetHouseProfile988)
следующая логика
работы с приборами
учета:
Если указать ID
существующего
прибора –
редактирование.
Если указать ID
несуществующего
прибора в анкете дома
– ошибка «Поле «data->
metering_devices ->item>id» заполнено не
верно».
Если не указать ID–
добавление нового
Тип
Параметр
Communal_r
esource_type
availability
Тип
Max
символов
HouseMeter
TypeEnum
Unit_of_mea
surement
UnitOfMeas
ureEnum
Commissioni
ng_date
date
Calibration_d
ate
date
Описание
прибора учета в анкету
дома. Если ничего не
прислать – удаление
прибора учета.
Идентификатор вида
коммунального ресурса
(описано в Таблица
177)
Идентификатор
наличия прибора учета
(описано в Таблица
178)
Идентификатор типа
прибора учета (описано
в Таблица 179).
Заполняется, если
значение в поле
«availability» равно
одному из
идентификаторов типа
MeteringDeviceAvailabil
ityEnum.
Идентификатор
единицы измерения
(описано в Таблица
180). Заполняется, если
значение в поле
«availability» равно
одному из
идентификаторов типа
MeteringDeviceAvailabil
ityEnum.
Дата ввода в
эксплуатацию.
Заполняется, если
значение в поле
«availability» равно
одному из
идентификаторов типа
MeteringDeviceAvailabil
ityEnum.
Дата поверки / замены
прибора учета.
Заполняется, если
значение в поле
«availability» равно
одному из
идентификаторов типа
MeteringDeviceAvailabil
ityEnum.
HouseCom
munalServi
ceTypeEnu
m
MeteringDe
viceAvailab
ilityEnum
meter_type
Обязател
ьность
152
Тип
Параметр
Is_default
Тип
Max
символов
Обязател
ьность
Описание
Признак определения
основной (is_default is
true) прибор учета или
пользовательский
(is_default is false).
Нельзя удалить
основные приборы
учета – их 6 штук.
Нельзя менять значение
в поле
«communal_resource_ty
pe (Вид коммунальной
услуги)» для основных
приборов учета, такая
возможность есть
только для
пользовательских
приборов. Пока не
заполнено поле
«availability (Наличие
приборы учета)» для
всех 6ти приборов,
нельзя добавить
пользовательский
прибор.
boolean
Таблица 177– Возможные значения HouseCommunalServiceTypeEnum
Тип
HouseCommunalServic
eTypeEnum
Идентификатор
Значения
Холодное водоснабжение
Горячее водоснабжение
Водоотведение
Электроснабжение
Отопление
Газоснабжение
Холодная вода для нужд ГВС
Тепловая энергия для подогрева
холодной воды для нужд ГВС
Газоснабжение для подогрева холодной
воды для нужд ГВС
Компонент на тепловую энергию для
ГВС
Обращение с твердыми
коммунальными отходами
1
2
3
4
5
6
7
8
9
10
11
153
Таблица 178– Возможные значения MeteringDeviceAvailabilityEnum
Тип
MeteringDeviceAvaila
bilityEnum
Идентификатор
Значения
Отсутствует, установка не требуется
Отсутствует, требуется установка
Установлен
1
2
3
Таблица 179– Возможные значения HouseMeterTypeEnum
Тип
HouseMeterTypeEnum
Идентификатор
Значения
Без интерфейса передачи данных
С интерфейсом передачи данных
1
2
Таблица 180– Возможные значения UnitOfMeasureEnum
Тип
UnitOfMeasureEnum
Идентификатор
Значения
кв.м
пог.м
шт.
куб.м
Гкал
Гкал/кв.м
Гкал/час
Гкал*час/кв.м
Гкал/год
чел.
ед.
руб.
%
°С*сут
км
куб.м/сут.
куб.м/квартира
куб.м/чел.в мес.
Вт/куб.м
кВт
кВА
Вт/(куб.м*°С)
час
дн.
тыс.руб.
м
кг
кг/куб.м
мВт
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
154
кВт/куб.м
кВт/ч
кВт*ч
руб/куб.м
куб.м/кв.м
кВт.ч/кв.м
руб./Гкал
руб./кВт.ч
Гкал/чел.
Гкал/куб.м
кВт/чел.
кВт*ч/чел.в мес.
руб./1000куб.м.
куб.м/кв.м общ. Имущества в мес.
кВт*ч/кв.м общ. Имущества в мес.
кВт/кв.м
Гкал/кв.м в мес.
Гкал/кв.м. в год
руб./чел. В мес.
руб./кв.м
руб./кг
1 пролёт
10 погонных метров
10 шт.
100 кв.м.
100 куб.м.
100 погонных метров
100 шт.
1000 кв.м.
1 м фальца
Квартира
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Таблица 181– Описание типа HouseLift
Тип
HouseLift
Параметр
id
Тип
Max
символо
в
Обязатель
ность
Описание
Идентификатор лифта.
При записи данных
(метод
SetHouseProfile988)
следующая логика
работы с лифтами:
Если указать ID
integer
155
Тип
Параметр
porch_numbe
r
type
commissioni
ng_year
Тип
character
varying
HouseLiftT
ypeEnum
Max
символо
в
Обязатель
ность
Описание
существующего лифта
– редактирование.
Если указать ID
несуществующего
лифта в анкете дома –
ошибка «Поле «data->
lifts ->item->id»
заполнено не верно».
Если не указать ID–
добавление нового
лифта в анкету дома.
Если ничего не
прислать – удаление
лифта.
Номер подъезда
255
Идентификатор типа
лифта (описано в
Таблица 182)
Год ввода в
эксплуатацию (Формат:
‘2015’)
integer
Таблица 182– Возможные значения HouseLiftTypeEnum
Тип
HouseLiftTypeEnum
Идентификатор
Значения
Пассажирский
Грузовой
Грузо-пассажирский
1
2
3
Таблица 183– Описание типа HouseManagementContract
Категория
HouseMana
gementCont
ract
Параметр
Тип
Max
символов
date_start
date
management
_reason
confirm_met
hod_docume
nt_name
character
varying
255
text
2500
Обязател
ьность
Да
Да
Описание
Дата начала
обслуживания дома по
договору управления
Основание управления
Наименование
документа,
подтверждающего
выбранный способ
управления
156
confirm_met
hod_docume
nt_date
date
confirm_met
hod_docume
nt_number
character
varying
Дата документа,
подтверждающего
выбранный способ
управления
Номер документа,
подтверждающего
выбранный способ
управления
Дата договора
управления
255
management date
_contract_dat
e
management ArrayOfInt
_contract_file
s
Массив
идентификаторов
файлов договоров
управления. Если
идентификатор файла
не указан – это
означает удаление
файла из анкеты.
Таблица 184– Описание типа ManagementContractsFiles
Категория
Параметр
file_id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор файла
договора управления.
integer
Таблица 185– Описание типа HouseService
Категория
HouseServi
ce
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор работы
(услуги). При записи
данных (метод
SetHouseProfile988)
следующая логика
работы с
выполняемыми
работами (услугами):
Если указать ID
существующей работы
(услуги) –
редактирование.
Если указать ID
несуществующей
integer
157
Name
HouseServi
ceNameEnu
m
name_other
character
varying
Stop_reason_
type
ServiceStop
ReasonType
Enum
date_stop
date
Stop_reason
character
varying
Report
HouseServi
ceReport
costs
ArrayOfHo
255
255
Да
158
работы (услуги) в
анкете дома – ошибка
«Поле «data-> services>item->id» заполнено
не верно».
Если не указать ID–
добавление новой
работы (услуги) в
анкету дома.
Идентификатор
наименования
работы/услуги (описано
в Таблица 186)
Наименование работы
(прочая услуга).
Заполняется только при
HouseServiceNameEnu
m = 14.
Идентификатор типа
прекращения
предоставления работы
(услуги) (описано в
Таблица 203)
Дата истечения срока
предоставления услуги.
Заполняется, если
значение в поле
stop_reason_type = 1
(Срок действия
предоставления услуги
истек).
Основание
прекращения
предоставления услуг.
Заполняется, если
значение в поле
stop_reason_type = 1
(Срок действия
предоставления услуги
истек).
Отчет по выполненным
работам (услугам)
(описано в Таблица
202)
История стоимости
работы (услуги).
Массив данных
ArrayOfHouseServiceCo
st возвращает тип
данных
HouseServicesCost
(описано в Таблица
187). В истории
стоимости должна быть
хотя бы одна запись.
useServiceC
ost
Таблица 186– Возможные значения HouseServiceNameEnum
Тип
HouseServiceNameEnu
m
Идентификатор
Значения
Работы (услуги) по управлению
многоквартирным домом
Работы по содержанию помещений,
входящих в состав общего имущества в
многоквартирном доме
Работы по обеспечению вывоза
бытовых отходов
Работы по содержанию и ремонту
конструктивных элементов (несущих
конструкций и ненесущих конструкций)
многоквартирных домов
Работы по содержанию и ремонту
оборудования и систем инженернотехнического обеспечения, входящих в
состав имущества в многоквартирном
доме
Работы по содержанию и ремонту
мусоропроводов в многоквартирном
доме
Работы по содержанию и ремонту
лифта (лифтов) в многоквартирном
доме
Работы по обеспечению требований
пожарной безопасности
Работы по содержанию и ремонту
систем дымоудаления и вентиляции
Работы по содержанию и ремонту
систем внутридомового газового
оборудования
Обеспечение устранения аварий на
внутридомовых инженерных системах в
1
2
3
4
5
6
7
8
9
10
11
159
многоквартирном доме
Проведение дератизации и дезинсекции
помещений, входящих в состав общего
имущества в многоквартирном доме
Работы по содержанию земельного
участка с элементами озеленения и
благоустройства, иными объектами,
предназначенными для обслуживания и
эксплуатации многоквартирного дома
Прочая работа (услуга)
12
13
14
Таблица 187– Описание типа HouseServicesCost
Категория
HouseServi
cesCost
Параметр
Тип
year
integer
Plan_cost_pe
r_unit
decimal
Max
символов
Обязател
ьность
Да
15.2
Описание
Год предоставления
работы/услуги. Можно
указать только «2015»,
либо «2016», иначе
система выдаст
ошибку.
Годовая плановая
стоимость работ (услуг)
(руб.)
Таблица 188– Описание типа HouseCommunalService
Категория
HouseCom
munalServi
ce
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор
коммунальной услуги.
При записи данных
(метод
SetHouseProfile988)
следующая логика
работы с
коммунальными
услугами:
Если указать ID
существующей услуги
– редактирование.
Если указать ID
несуществующей
услуги в анкете дома –
ошибка «Поле «data->
communal_services-
integer
160
type
filling_fact
>item->id» заполнено
не верно».
Если не указать ID–
добавление новой
коммунальной услуги в
анкету дома
Вид коммунальной
услуги (описано в
Таблица 177)
HouseCom
munalServi
ceTypeEnu
m
СommunalS
erviceFillin
gFactEnum
Service_meth
od
CommunalS
erviceMeth
odEnum
tariff_descrip
tion
text
tariff_descrip
tion_file_id
integer
Supplied_via
_managemen
t_organizatio
n
boolean
2500
Да
161
Факт предоставления
услуги (описано в
Таблица 189).
Доступны все переходы
кроме перехода с факта
предоставления
«Прекращено» на
какой-либо другой факт
предоставления.
Основание
предоставления услуги
(описано в Таблица
190)
Описание
дифференциации
тарифов в случаях,
предусмотренных
законодательством
Российской Федерации
о государственном
регулировании цен
(тарифов)
Описание тарифа в
виде файла.
Идентификатор файла.
Если идентификатор
файла не указан – это
означает удаление
файла из анкеты.
Услуга предоставляется
через УО. Возможные
значения: true (да,
услуга предоставляется
через УО), false (нет,
услуга не
Provider_inn
character
varying
12
provider_na
me
character
varying
255
предоставляется через
УО).
ИНН лица,
осуществляющего
поставку
коммунального
ресурса. Заполняется,
если значение в поле
supplied_via_manageme
nt_organization is false
(услуга не
предоставляется через
УО)
Наименование лица,
осуществляющего
поставку
коммунального
ресурса. Заполняется,
если значение в поле
supplied_via_manageme
nt_organization is false
(услуга не
предоставляется через
УО)
Дополнительная
информация.
Заполняется, если
значение в поле
supplied_via_manageme
nt_organization is false
(услуга не
предоставляется через
УО)
Дата договора на
поставку
коммунального
ресурса. Заполняется,
если значение в поле
supplied_via_manageme
nt_organization is false
(услуга не
предоставляется через
УО)
Номер договора на
поставку
profider_addi
tional_info
supply_contr
act_date
date
supply_contr
act_number
character
varying
255
162
costs
ArrayOfHo
useCommu
nalServiceC
ost
Legal_act_of
_tariff_date
date
legal_act_of_ character
tariff_number varying
255
character
varying
255
legal_act_of_
tariff_org_na
me
коммунального
ресурса. Заполняется,
если значение в поле
supplied_via_manageme
nt_organization is false
(услуга не
предоставляется через
УО)
История стоимости
услуги. Массив данных
ArrayOfHouseCommuna
lServiceCost возвращает
тип данных
HouseCommunalService
Cost (описано в
Таблица 192). История
стоимости услуги
обязательно для
заполнения, если «Факт
предоставления» =
«Предоставляется» или
«Прекращено».
История стоимости
услуги не обязательно,
если «Факт
предоставления» =
«Предоставляется» или
«Прекращено» и
«Основание
предоставления» =
Предоставляется через
прямые договоры с
собственниками».
Дата нормативноправового акта,
устанавливающего
тариф
Номер нормативноправового акта,
устанавливающего
тариф
Наименование органа,
принявшего
нормативно-правовой
акт, устанавливающий
163
consumption
_norm
decimal
consumption
_norm_unit_
of_measurem
ent
UnitOfMeas
ureEnum
consumption
_norm_additi
onal_info
text
consumption decimal
_norm_on_co
mmon_needs
тариф
Норматив потребления
коммунальной услуги в
жилых помещениях
Идентификатор
единицы измерения
норматива потребления
коммунальной услуги в
жилых помещениях
(описано в Таблица
180)
Дополнительная
информация о
нормативе потребления
услуги в жилых
помещениях
Норматив потребления
коммунальной услуги
на общедомовые
нужды
Идентификатор
единицы измерения
норматива потребления
коммунальной услуги
на общедомовые
нужды (описано в
Таблица 180)
Дополнительная
информация о
нормативе потребления
услуги на общедомовые
нужды
Нормативно-правовой
акт, устанавливающий
норматив потребления
коммунальной услуги
(заполняется по
каждому нормативному
правовому акту).
Массив данных
ArrayOfHouseCommuna
lServiceNormativeAct
возвращает тип данных
HouseCommunalService
NormativeAct (описано
17.5
2500
17.5
consumption UnitOfMeas
_norm_on_co ureEnum
mmon_needs
_unit_of_mea
surement
consumption text
2500
_norm_on_co
mmon_needs
_additional_i
nfo
normative_ac ArrayOfHo
ts
useCommu
nalServiceN
ormativeAct
164
в Таблица 191)
Идентификатор типа
прекращения
предоставления услуги.
Для основной
коммунальной услуги
(is_default is true)
можно указать только
значение
ServiceStopReasonType
Enum = 1. (описано в
Таблица 203)
Дата истечения срока
предоставления услуги.
Заполняется, если
значение в поле
stop_reason_type = 1
(Срок действия
предоставления услуги
истек).
Основание
прекращения
предоставления услуг.
Заполняется, если
значение в поле
stop_reason_type = 1
(Срок действия
предоставления услуги
истек).
Отчет по управлению.
Объемы по
коммунальным услугам
(описано в Таблица
206). Объемы по
коммунальной услуге
не заполняются, если
«Описание
предоставления
услуги» =
«Предоставляется через
прямые договоры с
собственниками» или
«Факт предоставления
услуги» = «Не
предоставляется»
stop_reason_t ServiceStop
ReasonType
ype
Enum
date_stop
date
Stop_reason
character
varying
Volumes_rep
ort
HouseCom
munalServi
ceVolumes
Report
255
165
is_default
объемы по
коммунальной услуге
не заполняются
Признак определения
основная (is_default is
true) коммунальная
услуга или
пользовательская
(is_default is false).
Нельзя удалить
основные услуги – их 6
штук.
Нельзя менять значение
в поле «type (Вид
коммунальной услуги)»
для основных КУ, такая
возможность есть
только для
пользовательских КУ.
Пока не заполнено поле
«filling_fact (Факт
предоставления
услуги)» для всех 6ти
КУ, нельзя добавить
пользовательскую КУ.
boolean
Таблица 189– Возможные значения СommunalServiceFillingFactEnum
Тип
СommunalServiceFillin
gFactEnum
Идентификатор
Значения
Предоставляется
Не предоставляется
Прекращено
1
2
3
Таблица 190– Возможные значения CommunalServiceMethodEnum
Тип
СommunalServiceMeth
odEnum
Идентификатор
Значения
Предоставляется через договор
управления
Предоставляется через договор с ТСЖ и
ЖСК
Предоставляется через прямые
договоры с собственниками
1
2
3
Таблица 191– Описание типа HouseCommunalServiceNormativeAct
Категория
HouseCom
munalServi
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор
норматива
integer
166
ceNormativ
eAct
document_da
te
date
document_nu
mber
character
varying
255
document_or
ganization_n
ame
character
varying
255
Дата нормативного
правового акта,
устанавливающего
норматив потребления
коммунальной услуги
Номер нормативного
правового акта,
устанавливающего
норматив потребления
коммунальной услуги
Наименование
принявшего акт органа
Таблица 192– Описание типа HouseCommunalServiceCost
Категория
HouseCom
munalServi
ceCost
Параметр
Тип
id
integer
tariff_start_d
ate
unit_of_meas
urement
date
tariff
decimal
Max
символов
Обязател
ьность
Описание
Идентификатор
стоимости
Дата начала действия
тарифа
Идентификатор
единицы измерения
(описано в Таблица
180)
Тариф (цена) (руб.)
UnitOfMeas
ureEnum
15.3
Таблица 193– Описание типа HouseCommonProperty
Категория
HouseCom
monPropert
y
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор общего
имущества. При записи
данных (метод
SetHouseProfile988)
следующая логика
работы с общим
имуществом:
Если указать ID
существующего общего
имущества –
редактирование.
Если указать ID
несуществующего
общего имущества в
integer
167
Name
character
varying
255
function
text
2500
area
decimal
15.2
rent
HouseCom
monPropert
yRent
анкете дома – ошибка
«Поле «data->
common_properties >item->id» заполнено
не верно».
Если не указать ID–
добавление нового
общего имущества в
анкету дома. Если
ничего не прислать –
удаление общего
имущества.
Наименование объекта
общего имущества
Назначение объекта
общего имущества
Площадь объекта
общего имущества
(заполняется в
отношении помещений
и земельных участков),
кв.м
Общее имущество
сдается в аренду (в
пользование) (описано
в Таблица 194)
Таблица 194– Описание типа HouseCommonPropertyRent
Категория
Параметр
Тип
HouseCom
monPropert
yRent
provider_na
me
character
varying
provider_inn
character
varying
12
contract_num
ber
contract_date
contract_start
_date
cost_per_mo
nth
common_me
eting_protoco
character
varying
255
Max
символов
255
Описание
Наименование
владельца
(пользователя)
ИНН владельца
(пользователя)
Номер договора
Дата договора
Дата начала действия
договора
Стоимость по договору
в месяц, руб.
Дата протокола общего
собрания
date
date
decimal
Обязател
ьность
15.2
date
168
собственников
помещений
Номер протокола
общего собрания
собственников
помещений
l_date
common_me character
eting_protoco varying
l_number
255
Таблица 195– Описание типа HouseOverhaul
Категория
Параметр
Тип
HouseOver
haul
provider_inn
character
varying
provider_na
me
character
varying
Max
символов
12
255
common_me date
eting_protoco
l_date
common_me character
eting_protoco varying
l_number
255
payment_am
ount_for_1s
m
decimal
15.2
additional_in
fo
text
2500
169
Обязател
ьность
Описание
ИНН владельца
специального счета
Наименование
владельца
специального счета
Дата протокола общего
собрания
собственников
помещений, на котором
принято решение о
способе формирования
фонда капитального
ремонта
Номер протокола
общего собрания
собственников
помещений, на котором
принято решение о
способе формирования
фонда капитального
ремонта
Размер взноса на
капитальный ремонт на
1 кв. м в соответствии с
решением общего
собрания
собственников
помещений в
многоквартирном доме,
руб.
Дополнительная
информация
Таблица 196– Описание типа HouseCommonMeeting
Категория
HouseCom
monMeetin
g
Параметр
id
Тип
Max
символов
Protocol_date date
character
varying
protocol_file
_id
integer
Описание
Идентификатор общего
собрания. При записи
данных (метод
SetHouseProfile988)
следующая логика
работы с общим
собранием
собственников:
Если указать ID
существующего общего
собрания
собственников –
редактирование.
Если указать ID
несуществующего
общего собрания
собственников в анкете
дома – ошибка «Поле
«data->
common_meetings >item->id» заполнено
не верно».
Если не указать ID –
добавление нового
общего собрания
собственников в анкету
дома. Если ничего не
прислать – удаление
общего собрания
собственников.
Дата протокола общего
собрания
собственников
помещений
Номер протокола
общего собрания
собственников
помещений
Идентификатор файла.
Если идентификатор
файла не указан – это
означает удаление
integer
protocol_nu
mber
Обязател
ьность
255
170
файла из анкеты.
Таблица 197– Описание типа HouseReport
Категория
Параметр
HouseRepor common
t
Тип
Max
символов
Обязател
ьность
Отчеты по управлению.
Общая информация
(описано в Таблица
198)
Отчеты по управлению.
Коммунальные услуги
(описано в Таблица
199)
Отчеты по управлению.
Претензии по качеству
работ (описано в
Таблица 201)
Отчеты по управлению.
Претензионно-исковая
работа (описано в
Таблица 200)
HouseRepor
tCommon
communal_se HouseRepor
tCommunal
rvice
Service
claims_to_co
nsumers
HouseRepor
tClaimsToC
onsumers
house_report
_quality_of_
work_claims
HouseRepor
tQualityOf
WorkClaim
s
Описание
Таблица 198– Описание типа HouseReportCommon
Категория
Параметр
Тип
decimal
Max
символов
15.2
decimal
15.2
decimal
15.2
decimal
15.2
charged_for_ decimal
maintenance_
15.2
HouseRepor cash_balance
tCommon
_beginning_p
eriod_consu
mers_overpa
yment
cash_balance
_beginning_p
eriod
cash_balance
_beginning_p
eriod_consu
mers_arrears
charged_for_
services
Обязател
ьность
Описание
Авансовые платежи
потребителей (на
начало периода), руб.
Переходящие остатки
денежных средств (на
начало периода), руб.
Задолженность
потребителей (на
начало периода), руб.
Начислено за услуги
(работы) по
содержанию и
текущему ремонту, руб.
(всего)
Начислено за услуги
(работы) по
171
содержанию и
текущему ремонту, в
том числе, за
содержание дома, руб.
Начислено за услуги
(работы) по
содержанию и
текущему ремонту, в
том числе, за текущий
ремонт, руб.
Начислено за услуги
(работы) по
содержанию и
текущему ремонту, в
том числе, за услуги
управления, руб.
Получено денежных
средств, руб. (всего)
Получено денежных
средств, в т. Ч,
денежных средств от
собственников/нанимат
елей помещений, руб.
Получено денежных
средств, в т. Ч, целевых
взносов от
собственников/нанимат
елей помещений, руб.
Получено денежных
средств, в т. Ч,
субсидий, руб.
Получено денежных
средств, в т. Ч,
денежных средств от
использования общего
имущества, руб.
Получено денежных
средств, в т. Ч, прочие
поступления, руб.
of_house
charged_for_ decimal
maintenance_
work
15.2
charged_for_
management
_service
decimal
15.2
received_cas
h
received_cas
h_from_own
ers
decimal
15.2
decimal
15.2
received_targ
et_payment_f
rom_owners
decimal
15.2
received_sub
sidies
decimal
15.2
received_fro
m_use_of_co
mmon_prope
rty
decimal
15.2
received_fro
m_other
decimal
15.2
cash_total
decimal
15.2
cash_balance
_ending_peri
decimal
15.2
Всего денежных
средств с учетом
остатков, руб.
Авансовые платежи
потребителей на конец
172
od_consumer
s_overpayme
nt
cash_balance
_ending_peri
od
cash_balance
_ending_peri
od_consumer
s_arrears
периода, руб.
decimal
15.2
decimal
15.2
Переходящие остатки
денежных средств на
конец периода, руб.
Задолженность
потребителей на конец
периода, руб.
Таблица 199– Описание типа HouseReportCommunalService
Категория
Параметр
Тип
HouseRepor balance_begi
tCommunal nning_period
Service
_consumers_
overpayment
balance_begi
nning_period
decimal
Max
символов
15.2
decimal
15.2
balance_begi
nning_period
_consumers_
arrears
balance_endi
ng_period_co
nsumers_ove
rpayment
balance_endi
ng_period
decimal
15.2
decimal
15.2
Авансовые платежи
потребителей (на конец
периода), руб.
decimal
15.2
balance_endi decimal
ng_period_co
nsumers_arre
ars
claims_receiv integer
ed_count
15.2
Переходящие остатки
денежных средств (на
конец периода), руб.
Задолженность
потребителей (на конец
периода), руб.
claims_satisfi
ed_count
Обязател
ьность
Описание
Авансовые платежи
потребителей (на
начало периода), руб.
Переходящие остатки
денежных средств (на
начало периода), руб.
Задолженность
потребителей (на
начало периода), руб.
Количество
поступивших
претензий по качеству
предоставленных
коммунальных услуг,
ед.
Количество
удовлетворенных
integer
173
claims_denie
d_count
integer
produced_rec
alculation_a
mount
decimal
претензий по качеству
предоставленных
коммунальных услуг,
ед.
Количество претензий
по качеству
предоставленных
коммунальных услуг, в
удовлетворении
которых отказано
Сумма произведенного
перерасчета, руб.
15.2
Таблица 200– Описание типа HouseReportClaimsToConsumers
Категория
Параметр
Тип
HouseRepor sent_claims_
tClaimsToC count
onsumers
integer
filed_actions
_count
Received_cas
h_amount
integer
decimal
Max
символов
Обязател
ьность
Описание
Направлено претензий
потребителямдолжникам, ед.
Направлено исковых
заявлений, ед.
Получено денежных
средств по результатам
претензионно-исковой
работы, ед.
15.2
Таблица 201– Описание типа HouseReportQualityOfWorkClaims
Категория
Параметр
Тип
Max
символов
integer
claims_denie
d_count
integer
produced_rec
alculation_a
decimal
Описание
Количество
поступивших
претензий по качеству
работ, ед.
Количество
удовлетворенных
претензий по качеству
работ, ед.
Количество претензий
по качеству работ, в
удовлетворении
которых отказано, ед.
Сумма произведенного
перерасчета, руб.
HouseRepor claims_receiv integer
tQualityOf
ed_count
WorkClaim
s
claims_satisfi
ed_count
Обязател
ьность
15.2
174
mount
Таблица 202– Описание типа HouseServiceReport
Категория
Параметр
Тип
HouseServi
ceReport
fact_cost_per
_unit
decimal
volumes
ArrayOfHo
useServiceR
eportVolum
e
Max
символов
15.2
Обязател
ьность
Описание
Годовая фактическая
стоимость работ
(услуг), руб.
Детальный перечень
выполненных работ
(оказанных услуг) в
рамках выбранной
работы (услуги).
Массив данных
ArrayOfHouseServiceRe
portVolume возвращает
тип данных
HouseServiceReportVolu
me (описано в Таблица
204)
Таблица 203– Описание типа ServiceStopReasonTypeEnum
Тип
ServiceStopReasonTyp
eEnum
Идентификатор
Значения
Срок действия предоставления услуги
истек
Услуга была включена в список
предоставляемых услуг по ошибке
1
2
Таблица 204– Описание типа HouseServiceReportVolume
Категория
HouseServi
ceReportVo
lume
Параметр
id
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор работы
(услуги), выполняемой
в рамках указанного
раздела работ (услуг).
При записи данных
(метод
SetCompanyProfile988)
следующая логика
работы с отчетом по
выполняемым работам
(услугам):
Если указать ID
сведений о
integer
175
Name
text
periodicity
HouseRepor
tServicesVo
lumesPeriod
icityEnum
unit_of_meas
urement
UnitOfMeas
ureEnum
cost_per_unit
decimal
выполняемых работах
(услугах) –
редактирование.
Если указать ID
несуществующих
сведений о
выполняемых работах в
анкете дома – ошибка
«Поле «data-> services > report -> volumes>id» заполнено не
верно».
Если не указать ID–
добавление новых
сведений о
выполняемых работах
(услугах) в анкету
дома. Если ничего не
прислать – удаление
сведений о
выполняемых работах.
Наименование работы
(услуги), выполняемой
в рамках указанного
раздела работ (услуг)
Периодичность
выполнения работ
(оказания услуг)
(описано в Таблица
205)
Идентификатор
единицы измерения
(описано в Таблица
180)
Стоимость на единицу
измерения, руб.
2500
15.3
Таблица 205– Описание типа HouseReportServicesVolumesPeriodicityEnum
Тип
HouseReportServicesV
olumesPeriodicityEnu
m
Идентификатор
Значения
Ежедневно
Еженедельно
Ежемесячно
Ежеквартально
Ежегодно
Один раз в сутки
1
2
3
4
5
6
176
Два и более раз в сутки
Один раз в неделю
Два и более раз в неделю
Один раз в месяц
Два и более раз в месяц
Один раз в квартал
Два и более раз в квартал
Один раз в год
Два и более раз в год
Один раз в сутки, при отрицательной
температуре
Два и более раз в сутки, при
отрицательной температуре
Один раз в неделю, при отрицательной
температуре
Два и более раз в неделю, при
отрицательной температуре
Один раз в сутки, при снегопаде
Два и более раз в сутки, при снегопаде
Один раз в неделю, при снегопаде
Два и более раз в неделю, при
снегопаде
При проведении капитального ремонта
При проведении текущего ремонта
При подготовке к зиме
По мере необходимости
По графику
По мере выявления
Ежедневно, кроме выходных и
праздничных дней
Ежедневно, кроме воскресных и
праздничных дней
Не реже одного раза в три дня
Постоянно при подготовке к
отопительному сезону
После отопительного сезона
Один раз в месяц (с ноября по апрель)
Иная
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Таблица 206– Описание типа HouseCommunalServiceVolumesReport
Категория
Параметр
Тип
HouseCom
munalServi
ceVolumes
Report
unit_of_meas
urement
UnitOfMeas
ureEnum
total_volume
decimal
Max
символов
Обязател
ьность
Описание
Идентификатор
единицы измерения
(описано в Таблица
180)
Общий объем
потребления (нат.
15.2
177
accrued_cons
umer
Paid_by_con
sumers_amou
nt
Consumer_ar
rears
Cash_to_pro
vider_payme
nt
decimal
15.2
decimal
15.2
decimal
15.2
decimal
15.2
paid_to_supp
lier_amount
decimal
15.2
arrear_to_sup
plier_amount
decimal
15.2
total_penaltie
s
decimal
15.2
показ)
Начислено
потребителям, руб.
Оплачено
потребителями, руб.
Задолженность
потребителей, руб.
Начислено
поставщиком
(поставщиками)
коммунального
ресурса, руб.
Оплачено поставщику
(поставщикам)
коммунального
ресурса, руб.
Задолженность перед
поставщиком
(поставщиками)
коммунального
ресурса, руб.
Суммы пени и
штрафов, уплаченные
поставщику
(поставщикам)
коммунального
ресурса, руб.
Таблица 207– Выходные параметры метода GetHouseProfileSF988 в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:api=”http://api.reformagkh.ru/api”>
<soapenv:Header>
<authenticate>m56iitk7o72g9beuqtqns83gg3</authenticate>
178
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfileSF988
soapenv:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/”>
<region_id xsi:type=”xsd:string”>0c5b2444-70a0-4932-980cb4dc0d3f02b5</region_id>
<page_number xsi:type=”xsd:int”>1</page_number>
<reporting_period_id xsi:type=”xsd:int”>22</reporting_period_id>
</api:GetHouseProfileSF988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ns1=”http://api.reformagkh.ru/api_document_literal”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type=”ns1:ErrorDetails”>
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 208 – Результаты вызова метода GetHouseProfileSF988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
1038
Page
Страница с указанным номером не
найдена
1017
No permission to access
ditin found
Нет доступа на чтение по указанному
Субъекту Федерации
179
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1041
Reporting period is not
related to the Resolution 988
Данные по новым формам раскрытия
информации согласно Постановлению
988 не относятся к запрашиваемому
отчетному периоду
1044
Availability of house
metering devices must be
filled
Необходимо заполнить информацию о
наличии прибора учета по всем видам
коммунальных ресурсов
1045
Communal service providing
must be filled
Необходимо заполнить информацию о
факте предоставления по всем видам
коммунальных ресурсов
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field “NAME” is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.22 Метод GetHouseProfile988
1) Описание метода
Метод получения данных текущей/архивной анкеты дома с соответствующим
идентификатором дома.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 209).
Таблица 209 – Входные параметры метода GetHouseProfile988
Категория
Параметр
GetHouseP
rofile988In
house_id
reporting_per
iod_id
Тип
Max
символов
bigint
bigint
Обязател
ьность
Да
Да
Описание
Идентификатор дома
Идентификатор
отчетного периода.
Идентификатор
отчетного периода
можно получить
методом
ReportingPeriodList
3) Выходные параметры
GetHouseProfileOut вызывает GetHouseProfile988Response (описано в Таблица 146)
180
Таблица 210– Выходные параметры метода GetHouseProfile988 в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:api=”http://api.reformagkh.ru/api”>
<soapenv:Header>
<authenticate>9u14qpm7rk1vkuqg5sqnvvd3d6</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfile988
soapenv:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/”>
<house_id xsi:type=”xsd:int”>8961123</house_id>
<reporting_period_id xsi:type=”xsd:int”>22</reporting_period_id>
</api:GetHouseProfile988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ns1=”http://api.reformagkh.ru/api_document_literal”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type=”ns1:ErrorDetails”>
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 211 – Результаты вызова метода GetHouseProfile988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
181
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1041
Reporting period is not
related to the Resolution 731
Данные по старым формам раскрытия
информации согласно Постановлению
731 не относятся к запрашиваемому
отчетному периоду
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field “NAME” is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.23 Метод SetCompanyProfile988
1) Описание метода
Метод изменяет данные по текущей/архивной анкете управляющей организации с
соответствующим ИНН за указанный отчетный период. Внешняя система может
обновлять анкеты только тех организаций, по которым разрешена подписка.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 21).
Таблица 212 – Входные параметры метода SetCompanyProfile988
Категор
Параметр
ия
SetComp inn
anyProfil
e988In
reporting_period_
id
Тип
character
varying
bigint
Max
символов
12
Обязательн
ость
Да
Да
182
Описание
ИНН
Идентификатор
отчетного
периода.
Идентификатор
отчетного
периода можно
Data
Да
CompanyProfi
leData988
получить с
помощью
метода
GetReportingPer
iodList.
Массив данных
(описано в
Таблица 135)
Таблица 213– Выходные параметры метода SetCompanyProfile988 в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
3) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:api=”http://api.reformagkh.ru/api”
xmlns:soapenc=”http://schemas.xmlsoap.org/soap/encoding/”>
<soapenv:Header>
<api:Login
soapenv:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/”>
<login xsi:type=”xsd:string”>?</login>
<password xsi:type=”xsd:string”>?</password>
</api:Login>
</soapenv:Header>
<soapenv:Body>
<api:SetCompanyProfile988
soapenv:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/”>
<inn xsi:type=”xsd:string”>?</inn>
<reporting_period_id xsi:type=”xsd:int”>?</reporting_period_id>
<data xsi:type=”api:CompanyProfileData988”>
<!–You may enter the following 41 items in any order
<work_time xsi:type=”xsd:string”>?</work_time>
<dispatcher_address xsi:type=”api:FiasAddress”>
<!–You may enter the following 7 items in any order
<city_id xsi:type=”xsd:string”>?</city_id>
<street_id xsi:type=”xsd:string”>?</street_id>
<house_number xsi:type=”xsd:string”>?</house_number>
<building xsi:type=”xsd:string”>?</building>
<block xsi:type=”xsd:string”>?</block>
<room_number xsi:type=”xsd:string”>?</room_number>
<letter xsi:type=”xsd:string”>?</letter>
</dispatcher_address>
<dispatcher_phone xsi:type=”xsd:string”>?</dispatcher_phone>
<dispatcher_work_time
xsi:type=”xsd:string”>?</dispatcher_work_time>
<fax xsi:type=”xsd:string”>?</fax>
<staff_regular_total xsi:type=”xsd:int”>?</staff_regular_total>
183
<staff_regular_administrative
xsi:type=”xsd:int”>?</staff_regular_administrative>
<staff_regular_engineers
xsi:type=”xsd:int”>?</staff_regular_engineers>
<staff_regular_labor xsi:type=”xsd:int”>?</staff_regular_labor>
<membership_information
xsi:type=”xsd:string”>?</membership_information>
<chart_file_id xsi:type=”xsd:int”>?</chart_file_id>
<income_of_mng xsi:type=”api:Decimal152”>?</income_of_mng>
<spending_of_mng xsi:type=”api:Decimal152”>?</spending_of_mng>
<debt_for_ku xsi:type=”api:Decimal152”>?</debt_for_ku>
<debt_for_thermal_energy
xsi:type=”api:Decimal152”>?</debt_for_thermal_energy>
<debt_for_thermal_energy_by_heating
xsi:type=”api:Decimal152”>?</debt_for_thermal_energy_by_heating>
<debt_for_thermal_energy_by_hot_water
xsi:type=”api:Decimal152”>?</debt_for_thermal_energy_by_hot_water>
<debt_for_hot_water
xsi:type=”api:Decimal152”>?</debt_for_hot_water>
<debt_for_cold_water
xsi:type=”api:Decimal152”>?</debt_for_cold_water>
<debt_for_sewerage
xsi:type=”api:Decimal152”>?</debt_for_sewerage>
<debt_for_gas xsi:type=”api:Decimal152”>?</debt_for_gas>
<debt_for_electrical_energy
xsi:type=”api:Decimal152”>?</debt_for_electrical_energy>
<debt_for_other xsi:type=”api:Decimal152”>?</debt_for_other>
<annual_financial_statement_files xsi:type=”api:ArrayOfInt”
soapenc:arrayType=”xsd:int[]”/>
<revenues_expenditures_estimates_files xsi:type=”api:ArrayOfInt”
soapenc:arrayType=”xsd:int[]”/>
<performance_report_files xsi:type=”api:ArrayOfInt”
soapenc:arrayType=”xsd:int[]”/>
<disturbances xsi:type=”api:ArrayOfDisturbance”
soapenc:arrayType=”api:Disturbance[]”/>
<licenses xsi:type=”api:ArrayOfLicense”
soapenc:arrayType=”api:License[]”/>
<okopf xsi:type=”api:Okopf”>?</okopf>
<firstname xsi:type=”xsd:string”>?</firstname>
<surname xsi:type=”xsd:string”>?</surname>
<middlename xsi:type=”xsd:string”>?</middlename>
<ogrn xsi:type=”xsd:string”>?</ogrn>
<legal_address xsi:type=”api:FiasAddress”>
<!–You may enter the following 7 items in any order
<city_id xsi:type=”xsd:string”>?</city_id>
<street_id xsi:type=”xsd:string”>?</street_id>
<house_number xsi:type=”xsd:string”>?</house_number>
<building xsi:type=”xsd:string”>?</building>
<block xsi:type=”xsd:string”>?</block>
<room_number xsi:type=”xsd:string”>?</room_number>
<letter xsi:type=”xsd:string”>?</letter>
</legal_address>
<actual_address xsi:type=”api:FiasAddress”>
<!–You may enter the following 7 items in any order
<city_id xsi:type=”xsd:string”>?</city_id>
<street_id xsi:type=”xsd:string”>?</street_id>
<house_number xsi:type=”xsd:string”>?</house_number>
<building xsi:type=”xsd:string”>?</building>
<block xsi:type=”xsd:string”>?</block>
<room_number xsi:type=”xsd:string”>?</room_number>
<letter xsi:type=”xsd:string”>?</letter>
</actual_address>
<post_address xsi:type=”api:FiasAddress”>
184
<!–You may enter the following 7 items in any order
<city_id xsi:type=”xsd:string”>?</city_id>
<street_id xsi:type=”xsd:string”>?</street_id>
<house_number xsi:type=”xsd:string”>?</house_number>
<building xsi:type=”xsd:string”>?</building>
<block xsi:type=”xsd:string”>?</block>
<room_number xsi:type=”xsd:string”>?</room_number>
<letter xsi:type=”xsd:string”>?</letter>
</post_address>
<phone xsi:type=”xsd:string”>?</phone>
<email xsi:type=”xsd:string”>?</email>
<site xsi:type=”xsd:string”>?</site>
<proportion_sf xsi:type=”xsd:float”>?</proportion_sf>
<proportion_mo xsi:type=”xsd:float”>?</proportion_mo>
</data>
</api:SetCompanyProfile988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ns1=”http://api.reformagkh.ru/api”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type=”ns1:ErrorDetails”>
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
4) Ошибки
Таблица 214 – Результаты вызова метода SetCompanyProfile988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1005
INN
didn’t found
Управляющая организация с
185
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
указанным ИНН не найдена
1024
Missing OKOPF
ОКОПФ с указанным кодом не найдена
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1041
Reporting period is not
related to the Resolution 988
Данные по новым формам раскрытия
информации согласно Постановлению
988 не относятся к запрашиваемому
отчетному периоду
1043
It’s doesn’t fill up for official
Поле «НАЗВАНИЕ ПОЛЯ» не
заполняется для типа «Должностное
лицо»
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field “NAME” is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1021
186
5.24 Метод SetHouseProfile988
1) Описание метода
Метод изменяет данные текущей/архивной анкеты дома с соответствующим
идентификатором дома. Внешняя система может изменять данные анкет домов в
управлении организаций, по которым разрешена подписка. Проверка на принадлежность
дома управляющей организации, по которой есть разрешение на подписку раскрытия
данных.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 64).
Таблица 215 – Входные параметры метода SetHouseProfile988
Категор
Параметр
ия
SetHouse house_id
Profile98
reporting_period_
8In
id
data
Тип
bigint
Обязательн
ость
Да
bigint
Да
HouseProfile
Data988
Да
Max
символов
Описание
Идентификатор
дома
Идентификатор
отчетного
периода.
Идентификатор
отчетного
периода можно
получить
методом
ReportingPeriod
List
Массив данных
(описано в
таблице
Таблица 147)
Таблица 216– Выходные параметры метода SetHouseProfile988 в случае ошибочного
выполнения
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
3) Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:api=”https://api-beta.reformagkh.ru/api_document_literal”>
<soapenv:Header/>
187
<soapenv:Body>
<api:SetHouseProfile988>
<house_id>?</house_id>
<reporting_period_id>?</reporting_period_id>
<data>
<!–You may enter the following 55 items in any order
<area_total>?</area_total>
<area_residential>?</area_residential>
<area_non_residential>?</area_non_residential>
<area_common_property>?</area_common_property>
<is_alarm>?</is_alarm>
<method_of_forming_overhaul_fund>?</method_of_forming_overhaul_fund>
<exploitation_start_year>?</exploitation_start_year>
<project_type>?</project_type>
<built_year>?</built_year>
<house_type>?</house_type>
<floor_count_min>?</floor_count_min>
<floor_count_max>?</floor_count_max>
<entrance_count>?</entrance_count>
<elevators_count>?</elevators_count>
<flats_count>?</flats_count>
<living_quarters_count>?</living_quarters_count>
<not_living_quarters_count>?</not_living_quarters_count>
<area_land>?</area_land>
<parking_square>?</parking_square>
<energy_efficiency>?</energy_efficiency>
<additional_info>?</additional_info>
<has_playground>?</has_playground>
<has_sportsground>?</has_sportsground>
<other_beautification>?</other_beautification>
<foundation_type>?</foundation_type>
<floor_type>?</floor_type>
<wall_material>?</wall_material>
<area_basement>?</area_basement>
<chute_type>?</chute_type>
<chute_count>?</chute_count>
<electrical_type>?</electrical_type>
<electrical_entries_count>?</electrical_entries_count>
<heating_type>?</heating_type>
<hot_water_type>?</hot_water_type>
<cold_water_type>?</cold_water_type>
<sewerage_type>?</sewerage_type>
<sewerage_cesspools_volume>?</sewerage_cesspools_volume>
<gas_type>?</gas_type>
<ventilation_type>?</ventilation_type>
<firefighting_type>?</firefighting_type>
<drainage_type>?</drainage_type>
<cadastral_numbers>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 2 items in any order
<id>?</id>
<cadastral_number>?</cadastral_number>
</item>
</cadastral_numbers>
<facades>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 2 items in any order
<id>?</id>
<type>?</type>
</item>
188
</facades>
<roofs>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 3 items in any order
<id>?</id>
<roof_type>?</roof_type>
<roofing_type>?</roofing_type>
</item>
</roofs>
<additional_equipments>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 3 items in any order
<id>?</id>
<type>?</type>
<description>?</description>
</item>
</additional_equipments>
<metering_devices>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 8 items in any order
<id>?</id>
<communal_resource_type>?</communal_resource_type>
<availability>?</availability>
<meter_type>?</meter_type>
<unit_of_measurement>?</unit_of_measurement>
<commissioning_date>?</commissioning_date>
<calibration_date>?</calibration_date>
<is_default>?</is_default>
</item>
</metering_devices>
<lifts>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 4 items in any order
<id>?</id>
<porch_number>?</porch_number>
<type>?</type>
<commissioning_year>?</commissioning_year>
</item>
</lifts>
<management_contract>
<!–You may enter the following 7 items in any order
<date_start>?</date_start>
<management_reason>?</management_reason>
<confirm_method_document_name>?</confirm_method_document_name>
<confirm_method_document_date>?</confirm_method_document_date>
<confirm_method_document_number>?</confirm_method_document_number>
<management_contract_date>?</management_contract_date>
<management_contract_files>
<!–Zero or more repetitions:
<item>?</item>
</management_contract_files>
</management_contract>
<services>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 8 items in any order
<id>?</id>
<name>?</name>
189
<name_other>?</name_other>
<stop_reason_type>?</stop_reason_type>
<stop_reason>?</stop_reason>
<date_stop>?</date_stop>
<report>
<!–You may enter the following 2 items in any order
<fact_cost_per_unit>?</fact_cost_per_unit>
<volumes>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 5 items in any
order
<id>?</id>
<name>?</name>
<periodicity>?</periodicity>
<unit_of_measurement>?</unit_of_measurement>
<cost_per_unit>?</cost_per_unit>
</item>
</volumes>
</report>
<costs SOAP-ENC:arrayType=”ns1:HouseServiceCost[2]”
xsi:type=”ns1:ArrayOfHouseServiceCost”>
<item xsi:type=”ns1:HouseServiceCost”>
<year xsi:type=”xsd:int”>?</year>
<plan_cost_per_unit>?<plan_cost_per_unit >
</item>
</costs>
</item>
</services>
<communal_services>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 27 items in any order
<id>?</id>
<type>?</type>
<filling_fact>?</filling_fact>
<service_method>?</service_method>
<tariff_description>?</tariff_description>
<supplied_via_management_organization>?</supplied_via_management_organization
>
<provider_inn>?</provider_inn>
<provider_name>?</provider_name>
<provider_additional_info>?</provider_additional_info>
<supply_contract_date>?</supply_contract_date>
<supply_contract_number>?</supply_contract_number>
<costs>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 4 items in any order
<id>?</id>
<tariff_start_date>?</tariff_start_date>
<unit_of_measurement>?</unit_of_measurement>
<tariff>?</tariff>
</item>
</costs>
<legal_act_of_tariff_date>?</legal_act_of_tariff_date>
<legal_act_of_tariff_number>?</legal_act_of_tariff_number>
<legal_act_of_tariff_org_name>?</legal_act_of_tariff_org_name>
<consumption_norm>?</consumption_norm>
190
<consumption_norm_unit_of_measurement>?</consumption_norm_unit_of_measurement
>
<consumption_norm_additional_info>?</consumption_norm_additional_info>
<consumption_norm_on_common_needs>?</consumption_norm_on_common_needs>
<consumption_norm_on_common_needs_unit_of_measurement>?</consumption_norm_on_
common_needs_unit_of_measurement>
<consumption_norm_on_common_needs_additional_info>?</consumption_norm_on_comm
on_needs_additional_info>
<normative_acts>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 4 items in any order
<id>?</id>
<document_date>?</document_date>
<document_number>?</document_number>
<document_organization_name>?</document_organization_name>
</item>
</normative_acts>
<stop_reason_type>?</stop_reason_type>
<stop_reason>?</stop_reason>
<date_stop>?</date_stop>
<volumes_report>
<!–You may enter the following 9 items in any order
<unit_of_measurement>?</unit_of_measurement>
<total_volume>?</total_volume>
<accrued_consumer>?</accrued_consumer>
<paid_by_consumers_amount>?</paid_by_consumers_amount>
<consumer_arrears>?</consumer_arrears>
<cash_to_provider_payment>?</cash_to_provider_payment>
<paid_to_supplier_amount>?</paid_to_supplier_amount>
<arrear_to_supplier_amount>?</arrear_to_supplier_amount>
<total_penalties>?</total_penalties>
</volumes_report>
<is_default>?</is_default>
</item>
</communal_services>
<overhaul>
<!–You may enter the following 6 items in any order
<provider_inn>?</provider_inn>
<provider_name>?</provider_name>
<common_meeting_protocol_date>?</common_meeting_protocol_date>
<common_meeting_protocol_number>?</common_meeting_protocol_number>
<payment_amount_for_1sm>?</payment_amount_for_1sm>
<additional_info>?</additional_info>
</overhaul>
<common_meetings>
<!–Zero or more repetitions:
<item>
<!–You may enter the following 4 items in any order
<id>?</id>
<protocol_date>?</protocol_date>
<protocol_number>?</protocol_number>
<protocol_file_id>?</protocol_file_id>
</item>
</common_meetings>
<common_properties>
191
<!–Zero or more repetitions:
<item>
<!–You may enter the following 5 items in any order
<id>?</id>
<name>?</name>
<function>?</function>
<area>?</area>
<rent>
<!–You may enter the following 8 items in any order
<provider_name>?</provider_name>
<provider_inn>?</provider_inn>
<contract_number>?</contract_number>
<contract_date>?</contract_date>
<contract_start_date>?</contract_start_date>
<cost_per_month>?</cost_per_month>
<common_meeting_protocol_date>?</common_meeting_protocol_date>
<common_meeting_protocol_number>?</common_meeting_protocol_number>
</rent>
</item>
</common_properties>
<report>
<!–You may enter the following 4 items in any order
<common>
<!–You may enter the following 17 items in any order
<cash_balance_beginning_period>?</cash_balance_beginning_period>
<cash_balance_beginning_period_consumers_overpayment>?</cash_balance_beginnin
g_period_consumers_overpayment>
<cash_balance_beginning_period_consumers_arrears>?</cash_balance_beginning_pe
riod_consumers_arrears>
<charged_for_services>?</charged_for_services>
<charged_for_maintenance_of_house>?</charged_for_maintenance_of_house>
<charged_for_maintenance_work>?</charged_for_maintenance_work>
<charged_for_management_service>?</charged_for_management_service>
<received_cash>?</received_cash>
<received_cash_from_owners>?</received_cash_from_owners>
<received_target_payment_from_owners>?</received_target_payment_from_owners>
<received_subsidies>?</received_subsidies>
<received_from_use_of_common_property>?</received_from_use_of_common_property
>
<received_from_other>?</received_from_other>
<cash_total>?</cash_total>
<cash_balance_ending_period>?</cash_balance_ending_period>
<cash_balance_ending_period_consumers_overpayment>?</cash_balance_ending_peri
od_consumers_overpayment>
<cash_balance_ending_period_consumers_arrears>?</cash_balance_ending_period_c
onsumers_arrears>
</common>
<communal_service>
<!–You may enter the following 10 items in any order
<balance_beginning_period>?</balance_beginning_period>
192
<balance_beginning_period_consumers_overpayment>?</balance_beginning_period_c
onsumers_overpayment>
<balance_beginning_period_consumers_arrears>?</balance_beginning_period_consu
mers_arrears>
<balance_ending_period>?</balance_ending_period>
<balance_ending_period_consumers_overpayment>?</balance_ending_period_consume
rs_overpayment>
<balance_ending_period_consumers_arrears>?</balance_ending_period_consumers_a
rrears>
<claims_received_count>?</claims_received_count>
<claims_satisfied_count>?</claims_satisfied_count>
<claims_denied_count>?</claims_denied_count>
<produced_recalculation_amount>?</produced_recalculation_amount>
</communal_service>
<claims_to_consumers>
<!–You may enter the following 3 items in any order
<sent_claims_count>?</sent_claims_count>
<filed_actions_count>?</filed_actions_count>
<received_cash_amount>?</received_cash_amount>
</claims_to_consumers>
<house_report_quality_of_work_claims>
<!–You may enter the following 4 items in any order
<claims_received_count>?</claims_received_count>
<claims_satisfied_count>?</claims_satisfied_count>
<claims_denied_count>?</claims_denied_count>
<produced_recalculation_amount>?</produced_recalculation_amount>
</house_report_quality_of_work_claims>
</report>
<alarm_info>
<!–You may enter the following 5 items in any order
<document_date>?</document_date>
<document_number>?</document_number>
<reason>?</reason>
<reason_other>?</reason_other>
<failure>
<!–You may enter the following 5 items in any order
<reason>?</reason>
<document_name>?</document_name>
<document_date>?</document_date>
<document_number>?</document_number>
<files>
<!–Zero or more repetitions:
<item>?</item>
</files>
</failure>
</alarm_info>
</data>
</api:SetHouseProfile988>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ns1=”http://api.reformagkh.ru/api”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
<SOAP-ENV:Body>
193
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type=”ns1:ErrorDetails”>
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «sessionId» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
4) Ошибки
Таблица 217 – Результаты вызова метода SetHouseProfile988
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1007
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1011
House is not in company
Дом, находится в управлении другой
организации «ID УО, ИНН,
НАЗВАНИЕ», по которой нет
подписки
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
194
1044
Availability of house
metering devices must be
filled
Необходимо заполнить информацию о
наличии прибора учета по всем видам
коммунальных ресурсов
1045
Communal service providing
must be filled
Необходимо заполнить информацию о
факте предоставления по всем видам
коммунальных ресурсов
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1012
Field “NAME” is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
195
СОСТАВ ПОКАЗАТЕЛЕЙ АНКЕТ, СОГЛАСНО
6
ПОСТАНОВЛЕНИЮ ПРАВИТЕЛЬСТВА РФ №731 от 23.09.2010,
КОТОРЫЕ НЕ МОГУТ ПРИНИМАТЬ ЗНАЧЕНИЕ «0»
В Таблица 218 представлены показатели анкеты управляющей организации,
которые не могут принимать значение «0».
Таблица 218 – Состав показателей анкеты управляющей организации
Наименование в wsdl
документе
Наименование поля
Группа показателей «Реквизиты»
Организационная форма
okopf
ИНН
inn
Юридический адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Фактический адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Почтовый адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Группа показателей «Сведения о
государственной регистрации»
ОГРН или ОГРНИП
ogrn
Дата присвоения ОГРН (ОГРНИП)
date_assignment_ogrn
Дополнительные сведения
Электронный адрес
email
Интернет-сайт
site
В Таблица 219 представлены показатели анкеты многоквартирного дома, которые
не могут принимать значение «0».
Таблица 219 – Состав показателей анкеты многоквартирного дома
Наименование в wsdl
документе
Наименование поля
Раздел «Общая характеристика»
196
Тип жилого дома
house_type
Состояние дома
state
Дата начала приватизации
privatization_start_date
Материал стен
wall_material
Тип перекрытий
floor_type
Этажность
storeys_count
Количество подъездов
Дата документа о признании дома
аварийным
entrance_count
emergency_date
Группа показателей «Удельная
тепловая характеристика здания»
Класс энергоэффективности здания
Дата проведения энергетического аудита
energy_efficiency
energy_audit_date
Группа показателей «Подвал»
Сведения о подвале
basement_stage
Группа показателей «Система
отопления»
Система отопления
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
горячего водоснабжения»
Система горячего водоснабжения
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
холодного водоснабжения»
Система холодного водоснабжения
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
канализации»
Система водоотведения (канализации)
system_name
197
Группа показателей «Система
электроснабжения»
Система электроснабжения
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
газоснабжения»
Вид системы газоснабжения
Отпуск ресурсов производится
system_name
provisioning
Раздел «Лифты»
Номер подъезда
porch_number
Количество остановок
stops_count
Грузоподъемность
capacity
Плановый срок замены (вывода из
эксплуатации)
plan_period
Раздел «Управление»
Тип договора
contract_type
Дата начала обслуживания дома по
договору управления
date_start
Плановая дата завершения обслуживания:
plan_date_stop
Раздел «Поставщики услуг»
ИНН
Inn
198
7
СПИСОК ОШИБОК ПЕРЕДАЧИ ИНФОРМАЦИИ
В случае возникновения ошибки обработка запроса прекращается, сервер
возвращает HTTP-статус ответа, отражающий суть произошедшей ошибки. Кроме статуса
в ответе передается краткое описание ошибки. Сообщение об ошибке возвращается
формате XML. Пример ошибки:
<SOAP-ENV:Envelope xmlns:SOAP-ENV=»http://schemas.xmlsoap.org/soap/envelope/»
xmlns:ns1=»http://api.reformagkh.ru/api»
xmlns:xsi=»http://www.w3.org/2001/XMLSchema-instance»>
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Unauthorized</faultstring>
<detail xsi:type=”ns1:ErrorDetails”>
<code>401</code>
<name>Unauthorized</name>
<description>Unauthorized</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Таблица 220 – Список ошибок
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
400
Bad request
Сервер обнаружил в запросе клиента
синтаксическую ошибку
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
404
Not Found
Указанный метод не найден
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1002
Authentication failed
Логин не найден или логин не
соответствует паролю.
1003
User is blocked
Пользователь заблокирован
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1005
INN wasnt found
Управляющая организация с
указанным ИНН не найдена
1006
User doesn’t conform to
Пользователь не соответствует
199
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
external system
внешней системе
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1008
House is managed by any
organization
Дом не в управлении
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1011
House is not in company
Дом, находится в управлении другой
организации «НАЗВАНИЕ УО», по
которой нет подписки
1012
House under the management
Дом уже под управлением
1013
Missing management date
Не заполнена дата начала управления
домом. Прежде чем прекратить
управление домом, Вам необходимо
заполнить дату начала управления с
помощью метода SetHouseProfile.
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
1016
No interaction
Взаимодействие с системой «Реформа
ЖКХ» запрещено
1017
No permission to access
Нет доступа на чтение по указанному
Субъекту Федерации
1018
House is already exist
Дом с указанным адресом уже
существует
1019
Missing part of profile
Отсутствует раздел анкеты с
указанным идентификатором
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1021
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1022
Extension is not valid
Файл с таким расширение не допустим
к загрузке
200
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
1023
File Size Limit Exceeded
Размер загружаемого файла превышает
15MB
1024
Missing OKOPF
ОКОПФ с указанным кодом не найдена
1025
Technical works in the
system
Ведутся технические работы.
Попробуйте обратиться позже
1026
Part is not in house profile
Указан раздел «ИДЕНТИФИКАТОР
РАЗДЕЛА», который не относится к
анкете дома
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1028
Part is not in company profile
Указан раздел «ИДЕНТИФИКАТОР
РАЗДЕЛА», который не относится к
анкете управляющей организации
1029
Request have been already
submitted
Запрос не создан. Запрос на подписку
уже был подан
1030
API – service is temporarily
unavailable
API-сервис доступен с 08:00 до 23:45
1032
The company with INN
already exist
Управляющая организация с
указанным ИНН уже зарегистрирована
в системе
1033
House wasn’t found
Дом с указанным адресом не найден
1035
Missing file
Файл с указанным идентификатором не
найден
1036
House unlinked already
Управление домом уже прекращено
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
1038
Page
Страница с указанным номером не
найдена
ditin found
1039
House was added by error
Была указана причина прекращения
управления: «Дом был включен по
ошибке». Заполнение даты и основания
окончания управления не требуется.
1040
Missing house profile in this
reporting period
Анкета дома за указанный отчетный
период не найдена
1041
Reporting period is not
related to the Resolution 988
Данные по новым формам раскрытия
информации, согласно Постановлению
Правительства РФ № 988 от 27.09.2014
201
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
не относятся к запрашиваемому
отчетному периоду
Reporting period is not
related to the Resolution 731
Данные по старым формам раскрытия
информации, согласно Постановлению
Правительства РФ № 731 от 23.09.2010
не относятся к запрашиваемому
отчетному периоду
1043
It fills up only for official
Поле «НАЗВАНИЕ ПОЛЯ»
заполняется только для типа
«Должностное лицо»
1044
Availability of house
metering devices must be
filled
Необходимо заполнить информацию о
наличии прибора учета по всем видам
коммунальных ресурсов
1045
Communal service providing
must be filled
Необходимо заполнить информацию о
факте предоставления по всем видам
коммунальных ресурсов
1046
If provider is MO field
“NAME” doesn’t fill up
Поле «НАЗВАНИЕ ПОЛЯ» не
заполняется, так как поставщиком
ресурсов является управляющая
организация.
1047
File is not from company
profile
Файл с указанным идентификатором не
относится к анкете УО
1048
File is not from house profile
Файл с указанным идентификатором не
относится к анкете МКД
1049
Can not delete default
communal service
Нельзя удалить коммунальную услугу
по умолчанию
1050
Can not delete default
metering device
Нельзя удалить прибор учета по
умолчанию
1051
Report of services is not
filled for services deleted by
mistake
По работе (услуге) удаленной по
ошибке отчет не заполняется
1052
Report of communal
services volumes is not filled
for communal services
deleted by mistake
По коммунальной услуге удаленной по
ошибке объемы не заполняется
1053
If “reason” = 1 (erroneous
state) parameters like
“document_name”,
“document_date”,
“document_number” are not
fiiled
Если причиной об отказе признания
дома аварийным является ошибочный
признак состояния, поля
«Наименование документа», «Дата
документа», «Номер документа» не
заполняются
1042
202
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
1054
If “service_method” = 3 or
“filling_fact” = 2 report of
communal services volumes
is not filled
Если «Описание предоставления
услуги» = «Предоставляется через
прямые договоры с собственниками»
или «Факт предоставления услуги» =
«Не предоставляется» объемы по
коммунальной услуге не заполняются
1055
For default communal
services diting of
communal service type is
forbidded
Нельзя редактировать «Вид
коммунальной услуги» и флаг
«Коммунальная услуга по умолчанию»
для коммунальных услуг по
умолчанию
1056
Editing “type” and
“is_default” fields for default
metering device is forbidden
Нельзя редактировать «Вид
коммунальной услуги» для приборов
учета по умолчанию
1057
Missing id
Указанный идентификатор в «ПУТЬ К
НЕПРАВИЛЬНОМУ ID» не найден
1058
Doesn’t edit for removing or
not providing communal
service
Поле «НАЗВАНИЕ ПОЛЯ» не
доступно на редактирование для
удаленной или непредоставляемой
коммунальной услуги
1059
Doesn’t edit for removing
service
Поле «НАЗВАНИЕ ПОЛЯ» не
доступно на редактирование для
удаленной выполняемой работы
(услуги)
1060
Doesn’t edit for not
providing communal service
Поле «НАЗВАНИЕ ПОЛЯ» не
доступно на редактирование для
непредоставляемой коммунальной
услуги
9999
Custom error
Текст будет сформирован в
зависимости от ошибки
203
8
ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ
API – (англ. Application programming interface) – интерфейс программирования
приложений (интерфейс прикладного программирования). Набор готовых классов,
процедур, функций, структур и констант, предоставляемых приложением (библиотекой,
сервисом) для использования во внешних программных продуктах.
XML – (англ. eXtensible Markup Language) – расширяемый язык разметки.
Спецификация XML описывает XML-документы и частично описывает поведение XMLпроцессоров (программ, читающих XML-документы и обеспечивающих доступ к их
содержимому).
SOAP – (от англ. Simple Object Access Protocol — простой протокол доступа к
объектам) — протокол обмена структурированными сообщениями в распределённой
вычислительной среде.
WSDL – (англ. Web Services Description Language) — язык описания веб-сервисов и
доступа к ним, основанный на языке XML.
GET и SET – методы доступа. Get выполняется, когда осуществляется чтение
данных, set выполняется, когда осуществляется запись данных.
ИНН
–
идентификационный
номер
налогоплательщик
Цифровой
код,
упорядочивающий учёт налогоплательщиков в Российской Федерации.
ФИАС – федеральная информационная адресная система. Классификатор содержит
адресные элементы и историю их изменения: регионы, районы, города, городские округа,
населенные пункты, улицы, дома.
Товарищества и кооперативы -
относятся следующие ОКОПФ «Товарищества
собственников жилья (2 80 16 ) », «Жилищные и жилищно-строительные кооперативы (2
01 02)», «Потребительские кооперативы (2 01 00)», «Жилищные накопительные
кооперативы (2 01 03)», «Кредитные потребительские кооперативы (2 01 04)»,
«Производственные кооперативы (артели) (1 40 00)», «Производственные кооперативы
(кроме сельскохозяйственных производственных кооперативов) (1 42 00)», «Союзы
(ассоциации) кооперативов (2 06 05)», «Сельскохозяйственные производственные
кооперативы (1 41 00)» и «Товарищество собственников недвижимости (2 80 15)».
ЖКХ – жилищно-коммунальное хозяйство. Комплекс отраслей экономики,
обеспечивающий функционирование инженерной инфраструктуры различных зданий в
населённых пунктах, создающий удобства и комфортабельность проживания и
нахождения в них людей путём предоставления им широкого спектра услуг.
204
ТСЖ – товарищество собственников жилья. Юридическое лицо, некоммерческая
организация,
созданная
на
основе
объединения
собственников
помещений
многоквартирного дома или собственников соседних участков с жилыми строениями
(домами) для совместного управления теми помещениями этого дома и землями, которые
находятся в совместном владении и пользовании, а также для ведения хозяйственной
деятельности в таком доме и на земле, находящейся в совместном владении, в форме
эксплуатации общего имущества, строительства дополнительных помещений и объектов
общего имущества, а также сдачи в аренду, внаём части общего имущества в
многоквартирном доме или общего земельного участка.
ЖСК – жилищно-строительный кооператив (жилищный кооператив). Объединение
людей или организаций, с целью строительства жилья, а также для управления жильем.
ТСН – товарищество собственников недвижимости.Добровольное объединение
собственников недвижимого имущества (помещений в здании, в том числе в
многоквартирном доме, или в нескольких зданиях, жилых домов, дачных домов,
садоводческих, огороднических или дачных земельных участков и т.п.), созданное ими
для совместного владения, пользования и в установленных законом пределах
распоряжения имуществом (вещами), в силу закона находящимся в их общей
собственности или в общем пользовании, а также, для достижения иных целей,
предусмотренных законом.
ОКОПФ – общероссийский классификатор организационно-правовых форм. В
классификаторе каждой организационно-правовой форме соответствует двухразрядный
цифровой код.
GUID
(Globally
Unique
Identifier)
статистически
уникальный
128-битный
идентификатор. Его главная особенность — уникальность, которая позволяет создавать
расширяемые сервисы и приложения без опасения конфликтов, вызванных совпадением
идентификаторов.
205
Лист регистрации изменений
№п/
п
Исполнитель
Версия
документ
а
Примечание
Дата
1.
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены методы чтения
GetCompanyProfileSF988,
GetCompanyProfile988.
2.
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены методы чтения
GetHouseProfileSF988, GetHouseProfile988.
Доработаны методы чтения по старым
формам GetHouseProfileSF,
GetHouseProfile. В старых методах стало
доступно чтение архивных анкет домов.
1.0.14
16.06.2015
3.
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены методы чтения GetHouseInfo,
GetHouseList.
1.0.15
19.06.2015
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены методы чтения/записи
GetRequestList, SetRequestForSubmit,
SetHouseProfile, SetHouseProfile988,
SetCompanyProfile, SetCompanyProfile988.
В «GetHouseProfileResponse» вынесены
следующие поля: state, emergency_date,
emergency_number, emergency_reason,
emergency_after в связи с невозможностью
редактирования. В методы записи данных
в анкеты УО/МКД добавлены возможности
прикрепления файла к требуемому
разделу. Добавление файлов таким путем
будет доступно в следующей версии.
1.0.16
03.07.2015
5.
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены методы: загрузки файла
«SetUploadFile», получения файла
«GetFileByID», взятие в управление
«SetHouseLinkToOrganization»,
прекращение управления домом
«SetUnlinkFromOrganization», создания
дома «SetNewHouse», создания заявки на
регистрацию новой УО «SetNewCompany».
Обновлены схемы взаимодействия.
1.0.17
13.07.2015
6.
ГК-Фонд
содействия
реформировани
ю ЖКХ
1.0.18
20.07.2015
7.
ГК-Фонд
содействия
реформировани
ю ЖКХ
1.0.19
21.07.2015
4.
1.0.13
Добавлены значения в следующие
справочники: HouseFirefightingTypeEnum,
HouseReportServicesVolumesPeriodicityEnu
m
Обновлены описания для параметров
chart_file_id,
revenues_expenditures_estimates_files,
performance_report_files
206
05.06.2015
Подпи
сь
№п/
п
Исполнитель
Примечание
Версия
документ
а
Дата
8.
ГК-Фонд
содействия
реформировани
ю ЖКХ
В метод SetHouseLinkToOrganizations
добавлено обязательное поле
management_reason (основание взятия в
управления домом)
1.0.20
23.07.2015
9.
ГК-Фонд
содействия
реформировани
ю ЖКХ
В метод GetHouseProfileSF988 добавлен
справочник возможных значений
HouseEnergyEfficiencyClass988Enum
1.0.21
29.07.2015
ГК-Фонд
содействия
реформировани
ю ЖКХ
В таблицу 180 добавлены новые единицы
измерения: кВт/кв.м, Гкал/кв.м в мес.,
Гкал/кв.м. в год
1.0.22
13.08.2015
1.0.23
02.10.2015
1.0.24
07.10.2015
1.0.25
15.10.2015
10.
11.
12.
13.
ГК-Фонд
содействия
реформировани
ю ЖКХ
ГК-Фонд
содействия
реформировани
ю ЖКХ
ГК-Фонд
содействия
реформировани
ю ЖКХ
1.
Смена типа поля porch_number номер подъезда (Таблица 221) на
стороковый тип «character
varying (255)».
2.
Таблица 138 переименован
параметр с license_file_id на
license_document_file_id.
3.
Условия записи данных по КУ и
текст ошибки №1054 изменены.
Добавлен пункт о строгом соблюдении
порядка следования параметров в тексте
запроса (стр. 16)
1.
Изменен тип поля
«date_of_responsibility» с
«timestamp(0) without time zone»
на «date».
2.
Исправлено описание: тип поля
«license_receipt_date» - date.
3.
Реализована возможность
добавления файла описания
тарифа в коммунальных услугах
14.
ГК-Фонд
содействия
реформировани
ю ЖКХ
Добавлены новые значения в справочники
«HouseFoundationTypeEnum»,
«UnitOfMeasureEnum»,
«HouseHeatingTypeEnum».
1.0.26
12.11.2015
15.
ГК-Фонд содействия
реформировани
ю ЖКХ
В таблицу №177 в тип
«HouseCommunalServiceTypeEnum»
добавлено новое значение «Обращение с
твердыми коммунальными отходами»
1.0.27
11.01.2016
16.
ГК-Фонд
содействия
реформировани
ю ЖКХ
В тип «HouseService» добавлен новый
параметр «costs» (Таблица 185). Параметр
«plan_cost_per_unit» вынесен в новый тип
«HouseServicesCost».
1.0.28
18.01.2016
207
Подпи
сь
№п/
п
Исполнитель
Примечание
Версия
документ
а
Дата
16.
ГК-Фонд
содействия
реформировани
ю ЖКХ
В таблицу 180 добавлены новые единицы
измерения: 1 пролёт, 10 погонных метров,
10 шт., 100 кв.м., 100 куб.м., 100 погонных
метров, 100 шт., 1000 кв.м., 1 м фальца.
1.0.29
28.01.2016
17
ГК-Фонд
содействия
реформировани
ю ЖКХ
В «HouseType988Enum» добавлен новый
тип «Жилой дом (индивидуальноопределенное здание)». Переименовано
значение «Общежитие» на
«Специализированный жилищный фонд».
1.0.30
10.02.2016
1.0.31
10.03.2016
1.0.32
15.03.2016
18
19
ГК-Фонд
содействия
реформировани
ю ЖКХ
ГК-Фонд
содействия
реформировани
ю ЖКХ
1.
В справочники
«HouseHeatingTypeEnum» и
«HouseHotWaterTypeEnum»
добавлено значение
"Индивидуальный тепловой пункт
(ИТП)".
2.
В справочник
«UnitOfMeasureEnum» добавлено
значение «Квартира».
3.
Добавлены условия заполнения
для параметра «licenses».
4.
Добавлена универсальная ошибка
с номером 9999 для читабельности
текста возникающих ошибок
1. В справочник
«HouseRoofingTypeEnum»
добавлено значение
«Безрулонная железобетонная
крыша»
2. Увеличен размер типа
cost_per_unit на decimal 15.3
(HouseServiceReportVolume)
208
Подпи
сь
Скачать