close

Вход

Забыли?

вход по аккаунту

код для вставкиСкачать
ГК - Фонд содействия реформированию ЖКХ
РЕГЛАМЕНТ ЭЛЕКТРОННОГО ВЗАИМОДЕЙСТВИЯ С
ИНФОРМАЦИОННЫМИ СИСТЕМАМИ РЕГИОНАЛЬНОГО И
МУНИЦИПАЛЬНОГО УРОВНЯ В РАМКАХ ОБМЕНА ИНФОРМАЦИИ ПО
ПОСТАНОВЛЕНИЮ ПРАВИТЕЛЬСТВА РОССИЙСКОЙ ФЕДЕРАЦИИ ОТ
23 СЕНТЯБРЯ 2010 ГОДА №731
Версия 1.0.8
Москва 2015
СОДЕРЖАНИЕ
СОДЕРЖАНИЕ ..............................................................................................................................2
1
ОБЩИЕ СВЕДЕНИЯ ............................................................................................................3
2
СТРУКТУРА XML-ДОКУМЕНТОВ ...................................................................................4
3
ПЕРЕЧЕНЬ МЕТОДОВ.........................................................................................................5
4
СХЕМА ВЫЗОВА МЕТОДОВ .............................................................................................8
5
ОПИСАНИЕ МЕТОДОВ.....................................................................................................15
5.1
Метод Login ...................................................................................................................17
5.2
Метод Logout .................................................................................................................18
5.3
Метод SetRequestForSubmit .........................................................................................20
5.4
Метод GetRequestList ....................................................................................................22
5.5
Метод GetReportingPeriodsList.....................................................................................24
5.6
Метод SetCompanyProfile .............................................................................................25
5.7
Метод SetNewCompany ................................................................................................54
5.8
Метод GetHouseList ......................................................................................................59
5.9
Метод SetUnlinkFromOrganization ...............................................................................63
5.10 Метод SetHouseLinkToOrganization .............................................................................65
5.11 Метод SetHouseProfile ..................................................................................................67
5.12 Метод SetNewHouse ......................................................................................................96
5.13 Метод GetHouseInfo ......................................................................................................98
5.14 Метод SetFileToCompanyProfile .................................................................................101
5.15 Метод SetFileToHouseProfile ......................................................................................104
5.16 Метод GetFilesInfoFromCompanyProfile ...................................................................107
5.17 Метод GetFilesInfoFromHouseProfile......................................................................... 111
5.18 Метод GetFileByID ...................................................................................................... 113
5.19 Метод SetFileDeleted ................................................................................................... 115
5.20 Метод GetCompanyProfile .......................................................................................... 117
5.21 Метод GetHouseProfile ................................................................................................ 119
5.22 Метод GetCompanyProfileSF ......................................................................................121
5.23 Метод GetHouseProfileSF ...........................................................................................124
6 СОСТАВ ПОКАЗАТЕЛЕЙ АНКЕТ, КОТОРЫЕ НЕ МОГУТ ПРИНИМАТЬ
ЗНАЧЕНИЕ «0» ..........................................................................................................................127
7
СПИСОК ОШИБОК ПЕРЕДАЧИ ИНФОРМАЦИИ ......................................................130
8
ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ .......................................................................................133
2
1
ОБЩИЕ СВЕДЕНИЯ
Настоящий документ определяет форматы XML-документов, передаваемых в
электронной форме по телекоммуникационным каналам связи для обеспечения
интеграции системы «Реформа ЖКХ» с внешними системами.
В системе «Реформа ЖКХ» для взаимодействия с внешними системами реализован
API-сервис. API-сервис предоставляет возможность, внешним системам, раскрывать
информацию по управляющим организациям, которые дали на то разрешение, а также по
домам, находящимся в управлении.
API позволяет:
1)
авторизоваться для получения доступа к использованию API-методов;
2)
получить данные организаций, раскрывших сведения о своей деятельности
согласно Постановлению Правительства № 731 в «Реформа ЖКХ», и данные
обслуживаемых ими домов;
3)
загрузить (обновить) данные организаций, зарегистрированных в «Реформа
ЖКХ», отредактировать список обслуживаемых ими домов, загрузить данные об
обслуживаемых ими домах на «Реформа ЖКХ».
Для начала работы:
1)
внешняя система должна предварительно подать заявку в Фонд, после
рассмотрения, которой она (внешняя система) будет зарегистрирована в «Реформа
ЖКХ» и ей будут выданы соответствующие права на внешнее взаимодействие;
2)
внешняя система, с помощью вызова метода SetRequestForSubmit, должна
подать запрос на раскрытие управляющей организации. После одобрения заявки,
администратором организации, внешняя система может начать раскрытие данных
по анкете организации и анкетам домов в управлении.
Входные структуры данных GET и SET - методов передаются в теле запроса. API
«Реформа ЖКХ» поддерживает протокол SOAP (Simple Object Access Protocol). Обмен
данными по этому протоколу ведется посредством XML-сообщений.
При SOAP-протоколе генерируется WSDL-документ, описывающий формат
данных для взаимодействия.
API-сервис доступен для работы в будние дни с 18:00 до 23:45, в выходные дни с
08:00 до 23:45.
3
2
СТРУКТУРА XML-ДОКУМЕНТОВ
XML-документ состоит из строк, содержащих элементы и атрибуты, а также их
значения. Реквизиты XML-документа могут быть элементами или атрибутами. Элемент
является составной частью XML-документа, обычно представляющую собой некоторую
законченную смысловую единицу. Элемент может содержать один или несколько
вложенных элементов и/или атрибутов. Атрибут представляет собой составную часть
элемента, задающую его параметры. В XML-документе описывается пролог с указанием
кодировки UTF-8: <?xml version = “1.0” encoding = “UTF-8”?>.
Описание типов данных, используемых при определении полей документов.
Описание приведено в разделе описания методов. В графе "Категория" записывается
условное обозначение элемента сообщения. В графе "Параметр" записывается условное
обозначение атрибута или другого элемента, входящего в состав элемента. В графе "Тип"
для каждого атрибута указывается тип параметра. В графе "Max символов" указывается
длина атрибута. В графе "Обязательность" указывается обязательность поля на ввод.
"Обязательность" имеет следующие обозначения:
1) «Да» - обязательный атрибут;
2) « » - необязательный атрибут.
Обязательный атрибут – это атрибут, который должен обязательно присутствовать
в XML-документе. Необязательный атрибут – это атрибут, который может, как
присутствовать, так и отсутствовать в XML-документе.
В графе "Описание" указывается описание элемента или атрибута.
4
ПЕРЕЧЕНЬ МЕТОДОВ
3
Таблица 1– Описание методов API
Метод
Тип
Общий
Login
Название
Авторизация
Общий
Logout
Данные по API
взаимодействию
Импорт
SetRequestForSubmit
Экспорт GetRequestList
Справочники
Экспорт GetReportingPeriodList
Управляющая
организация
Экспорт GetCompanyProfile
Экспорт GetCompanyProfileSF
Импорт
SetCompanyProfile
Импорт
SetNewCompany
Экспорт GetHouseList
Назначение
Выполняет авторизацию
внешней системы и
открывает сеанс работы
Завершает авторизованный
сеанс работы внешней
системы
Подача запроса на
подписку (по списку ИНН)
Возвращает список
запросов подписки
внешней системы на
раскрытие данных,
поданных внешней
системой (с детализацией
статуса запроса)
Возвращает список
отчетных периодов
системы
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
с соответствующим ИНН
Возвращает данные анкеты
(текущей и архивной)
управляющей организации
по указанному субъекту
федерации за указанный
период
Изменяет данные по
текущей/архивной анкете
организации с
соответствующим ИНН за
указанный отчетный
период
Подает заявку на
регистрацию новой
управляющей организации
в системе
Возвращает список домов,
находящихся в управлении
организации с
Метод
Договора
Тип
Название
Импорт
SetUnlinkFromOrganization
Импорт
SetHouseLinkToOrganization
Многоквартирный Экспорт GetHouseProfile
дом
Экспорт GetHouseProfileSF
Импорт
SetHouseProfile
Импорт
SetNewHouse
Экспорт GetHouseInfo
Файлы
Импорт
SetFileInCompanyProfile
Импорт
SetFileInHouseProfile
6
Назначение
соответствующим ИНН.
(по каждому дому
возвращается
идентификатор дома и
адрес по ФИАС)
Прекращает управление
домом с соответствующим
идентификатором
Добавляет дом с
соответствующим
идентификатором в
управление организации с
соответствующим ИНН
Возвращает данные анкеты
(текущей) дома с
соответствующим
идентификатором дома
Возвращает данные анкеты
(текущей) дома по
указанному субъекту
федерации
Изменяет данные текущей
анкеты дома с
соответствующим
идентификатором дома
Добавляет новый дом в
систему с
соответствующим адресом
по ФИАС
Возвращает
идентификатор дома с
соответствующим адресом
по ФИАС
Добавляет новый файл в
заданный раздел анкеты
организации с
соответствующим ИНН за
указанный отчетный
период
Добавляет новый файл в
заданный раздел текущей
анкеты дома с
соответствующим
Метод
Тип
Название
Экспорт GetFilesFromCompanyProfile
Экспорт GetFilesFromHouseProfile
Экспорт GetFileById
Импорт
SetFileDeleted
7
Назначение
идентификатором дома
Возвращает список файлов
заданного раздела анкеты
организации с
соответствующим ИНН за
указанный отчетный
период
Возвращает список файлов
заданного раздела текущей
анкеты дома с
соответствующим
идентификатором дома
Возвращает файл с
соответствующим
идентификатором
Удаляет файл с
соответствующим
идентификатором
СХЕМА ВЫЗОВА МЕТОДОВ
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).
8
2.9
Получение
данных
анкеты
(текущей)
дома
с
соответствующим
идентификатором дома (1.1).
2.10 Получение данных анкеты (текущей и архивной) управляющей организации
по указанному субъекту федерации за указанный отчетный период (1.1).
2.11 Получение данных анкеты (текущей) дома по указанному субъекту федерации
(1.1).
УРОВЕНЬ №3
3.1 Раскрытие по анкете управляющей организации (SetCompanyProfile) не может
быть выполнено, пока не выполнены следующие методы: (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).
3.3
Добавление
файла
в
анкету
управляющей
организации
(SetFileToCompanyProfile) не может быть выполнено, пока не выполнены следующие
методы: (1.1), (2.1), (2.2), (2.4).
3.4
Получение
списка
файлов
анкеты
управляющей
организации
(GetFilesInfoFromCompanyProfile) не может быть выполнено, пока не выполнены
следующие методы: (1.1), (2.1), (2.2), (2.4).
УРОВЕНЬ №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) не может быть выполнено,
пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (2.9), (2.10), (4.1).
6.2 Добавление файла в анкету дома (SetFileToHouseProfile) не может быть
выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (4.1).
6.3 Получение списка файлов анкеты дома (GetFilesInfoFromHouseProfile) не может
быть выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (4.1).
9
УРОВЕНЬ №7
7.1 Получение файла с соответствующим идентификатором (GetFileByID) не может
быть выполнено, пока не выполнены следующие методы: (1.1), (2.1), (2.2), (2.5), (4.1),
(6.2).
7.2 Удаление файла из анкеты управляющей организации или анкеты дома
(SetFileDeleted) не может быть выполнено, пока не выполнены следующие методы: (1.1),
(2.1), (2.2), (2.5), (4.1), (6.2).
УРОВЕНЬ № 8
8.1. Завершение сеанса(Logout)
10
Рисунок 1 - Схема взаимодействия системы «Реформа ЖКХ» с внешней системой.
Часть 1
11
Рисунок 2– Схема взаимодействия системы «Реформа ЖКХ» с внешней
системой. Часть 2
12
Рисунок 3– Схема порядка вызова методов для раскрытия данных по анкеты
управляющей организации
13
Рисунок 4– Схема порядка вызова методов для раскрытия данных по анкеты
многоквартирного дома
14
ОПИСАНИЕ МЕТОДОВ
5
Для тестирования выполненности методов API развернут тестовый контур.
Переданные данные будут доступны для просмотра на Портале по раскрытию
информации по адресу http://p-api-beta.reformagkh.ru/
Доступны два стиля WSDL- документа:
1.
PC\ encoded
•
Внешним системам, которые проходят бета-тестирование API, доступен
WSDL – документ по адресу http://api-beta.reformagkh.ru/api/wsdl.
•
Внешние системы, которые прошли бета-тестирование API сайта Реформа
ЖКХ, могут начать работу с боевым контуром (адрес WSDL – документа
боевого контура: http://api.reformagkh.ru/api/wsdl).
2.
Document\ literal
•
Внешним системам, которые проходят бета-тестирование API, доступен
WSDL
–
документ
по
адресу
http://api-
beta.reformagkh.ru/api_document_literal/wsdl.
•
Внешние системы, которые прошли бета-тестирование API сайта Реформа
ЖКХ, могут начать работу с боевым контуром (адрес WSDL – документа
боевого контура: http://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-beta.reformagkh.ru/api"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header>
<authenticate>meulr41c6up5uoc2ehufeslc14</authenticate>
15
</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>
В методах раскрытия данных по анкетам (текущим и архивным) управляющей
организации и анкетам (текущим) домов в ее управлении передаются все значения
входных параметров, а не только те значения параметров, которые были изменены. В
случае, если значение поля не указано, система воспринимает это как поле на удаление, и
ранее введенное значение удалится.
16
5.1
Метод Login
1) Описание метода
Метод выполняет авторизацию внешней системы и открывает сеанс работы. Перед
началом работы должна быть проверка, что учетные данные пользователя существуют в
системе “Реформа ЖКХ”, не заблокированы и соответствуют внешней системе.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 2).
Таблица 2 – Входные параметры метода Login
Категория
LoginIn
Параметр
login
password
Тип
character
varying
character
varying
Max
Обязател
символов
ьность
255
Да
Да
255
Описание
Имя пользователя, для
ввода в систему.
Набор символов, для
подтверждения
личности или
полномочий.
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 3).
Таблица 3– Выходные параметры метода Login
Категория
Параметр
Тип
LoginOut
session_guid
SoapFault
code
name
description
character
varying
integer
text
text
Max
символов
36
Обязател
ьность
Описание
Получение временного
ключа для работы с API
Код результата запроса
Наименование
Описание
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.portal.dev/api">
<soapenv:Header/>
<soapenv:Body>
<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:Body>
</soapenv:Envelope>
17
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 4 – Результаты вызова метода Login
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
1002
Authentication failed
Логин не найден или логин не
соответствует паролю.
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
Ведутся технические работы.
Попробуйте обратиться позже
1030
API - service is temporarily
unavailable
API-сервис доступен с 18:00 до 23:45
по будням и с 08:00 до 23:45 по
выходным дням
5.2
Метод Logout
1) Описание метода
Метод завершает авторизованный сеанс работы внешней системы.
18
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 5).
Таблица 5– Выходные параметры метода Logout
Категория
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">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</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"
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) Ошибки
Таблица 6 – Результаты вызова метода Logout
Code
(Код результата
Name
(Наименование)
Description
(Описание)
19
запроса)
401
Authorization failed
Неавторизованный запрос
1009
Unauthorized
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
5.3
Метод SetRequestForSubmit
1) Описание метода
Метод подачи запроса на раскрытие данных. Внешняя система подает на вход
список ИНН управляющих организаций, по которым собирается раскрывать данные.
При условии, что Вы администратор УО подтверждение запроса на раскрытие
информации проставиться автоматически.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 7).
Таблица 7 – Входные параметры метода SetRequestForSubmit
Категория
SetRequest
ForSubmitI
n
Параметр
inn
Тип
character
varying
Max
Обязател
символов
ьность
12
Да
Описание
На вход передается
список ИНН
управляющих
организаций, с
запросом о разрешении
раскрытия информации
по указанной
организации
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 8).
Таблица 8– Выходные параметры метода SetRequestForSubmit
Категория
Параметр
SetRequest
ForSubmitI
nnStatus
inn
SoapFault
code
status
Тип
character
varying
SetRequest
ForSubmitI
nnStatusEn
um
integer
Max
символов
12
20
Обязател
ьность
Описание
ИНН управляющих
организаций
Идентификатор статуса
запроса внешней
системы. (Возможные
значения в Таблица 9)
Код результата запроса
name
description
Наименование
Описание
text
text
Таблица 9– Возможные значения SetRequestForSubmitInnStatusEnum
Тип
SetRequestForSubmitIn
nStatusEnum
Идентификатор
Значения
Success. (Ошибок нет. Заявка подана)
Missing INN
INN is not valid (Указан некорректный
ИНН)
Request have been already submitted
(Запрос на подписку был уже подан
ранее)
0
1
2
3
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:SetRequestForSubmit
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inns xsi:type="api:ArrayOfString" soapenc:arrayType="xsd:string[]"/>
</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"
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
21
Таблица 10 – Результаты вызова метода SetRequestForSubmit
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1012
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.4
Метод GetRequestList
1) Описание метода
Метод возвращает список запросов подписки на управляющую организацию,
поданных внешней системой (с детализацией статуса запроса).
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 11).
Таблица 11– Выходные параметры метода GetRequestList
Категория
RequestStat
e
Параметр
inn
date_created
status
update_date
SoapFault
code
name
description
Тип
character
varying
timestamp(0
)
RequestStat
us
Max
Обязател
символов
ьность
12
Да
Да
Да
Да
timestamp(0
)
integer
text
text
Описание
ИНН управляющей
организации
Дата подачи запроса
внешней системой
Идентификатор статуса
запроса
(Возможные значения в
Таблица 12)
Дата обработки заявки
Код результата запроса
Наименование
Описание
22
Таблица 12– Возможные значения GetRequestList
Тип
RequestStatus
Идентификатор
Значения
approved(Заявка подтверждена)
declined(Заявка отклонена)
pending(В ожидании рассмотрения)
1
2
3
3) Пример вызова метода
SOAP-запрос:
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:GetRequestList
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"
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) Ошибки
Таблица 13 – Результаты вызова метода GetRequestList
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
23
Попробуйте обратиться позже.
1011
5.5
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
Mandatory field is null
Метод GetReportingPeriodsList
1) Описание метода
Метод возвращает список отчетных периодов системы.
2) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 14).
Таблица 14– Выходные параметры метода GetReportingPeriodsList
Категория
Параметр
ReportingPe id
riod
Max
символов
bigint
date_start
date_end
name
code
name
description
Обязател
ьность
Да
Да
Да
Да
date
date
character
255
varying
ReportingPe
riodStateEn
um
integer
text
text
state
SoapFault
Тип
Да
Описание
Идентификатор
отчетного периода
Дата начала
Дата окончания
Наименование
Текущее состояние.
(Возможные значения в
Таблица 15)
Код результата запроса
Наименование
Описание
Таблица 15– Возможные значения ReportingPeriodStateEnum
Тип
ReportingPeriodStateE
num
Идентификатор
Значения
current (текущий)
1
2
archival (архивный)
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">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
24
</soapenv:Header>
<soapenv:Body>
<api:GetReportingPeriodList
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"
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) Ошибки
Таблица 16 – Результаты вызова метода GetReportingPeriodsList
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
5.6
Метод SetCompanyProfile
1) Описание метода
Метод изменяет данные по текущей/архивной анкете управляющей организации с
соответствующим ИНН за указанный отчетный период. Внешняя система может
обновлять анкеты только тех организаций, по которым разрешена подписка.
2) Входные данные
25
В таблице представлены входные параметры метода (Таблица 17).
Таблица 17 – Входные параметры метода SetCompanyProfile
Категор
Параметр
ия
SetComp inn
anyProfil
eIn
reporting_periods
_id
data
Тип
Max
символов
12
character
varying
bigint
Обязательн
ость
Да
ИНН
Идентификатор
отчетного
периода
Массив данных
(Описано в
Таблица 18)
Да
Да
CompanyProfi
leData
Описание
Описание типа CompanyProfileData:
Таблица 18– Массив данных(CompanyProfileData) метода SetCompanyProfile
Категория
CompanyPr
ofileData
Параметр
name_full
name_short
okopf
surname
middlename
firstname
position
ogrn
Тип
character
varying
character
varying
Okopf
character
varying
character
varying
character
varying
character
varying
character
varying
date
Max
Обязател
символов
ьность
255
Да
255
Описание
Полное наименование
Да
Краткое наименование
Да
255
Да
ОКОПФ. Передается
код всероссийского
справочника ОКОПФ в
формате «2 80 17».
(Возможные значения в
Таблица 41)
Фамилия
255
Да
Отчество
255
Да
Имя
255
Да
Должность
ОГРН
255
Дата регистрации
date_assignm
ent_ogrn
name_authori text
ty_assigning_
ogrn
legal_address FiasAddress
Да
26
Наименование органа,
принявшего решение о
регистрации
Идентификатор
юридического адреса
Категория
Параметр
Тип
Max
символов
Обязател
ьность
actual_addres
s
FiasAddress
Да
post_address
FiasAddress
Да
work_time
phone
email
text
text
character
varying
site
proportion_sf
text
numeric
5.2
proportion_m
o
numeric
5.2
Да
Да
255
255
additional_in text
fo
participation_ text
in_associatio
ns
srf_count
integer
mo_count
integer
offices_count
staff_regular
_total
staff_regular
_administrati
integer
integer
integer
27
Описание
(Описано в Таблица 19)
Идентификатор
фактического адреса
(Описано в Таблица 19)
Идентификатор
почтового адреса
(Описано в Таблица 19)
Режим работы
Телефон
Электронный адрес.
Формат:
[email protected]
Интернет сайт
Доля участия в
уставном капитале
Субъекта РФ, %
Доля участия в
уставном капитале
муниципального
образования, %
Дополнительная
информация
Сведения об участии в
саморегулируемых
организациях или в
объединениях ТСЖ и
ЖСК
Количество Субъектов
РФ, в которых
организация
осуществляет свою
деятельность
Количество
муниципальных
образований, в которых
организация
осуществляет свою
деятельность
Количество офисов
Штатная численность
на отчетную дату, чел.
Штатная численность
на отчетную дату,
Категория
Параметр
Тип
Max
символов
integer
staff_regular
_labor
integer
count_dismis
sed
count_dismis
sed_admins
numeric
5.2
numeric
5.2
count_dismis
sed_engineer
s
count_dismis
sed_workers
numeric
5.2
numeric
5.2
accidents_co
unt
integer
prosecute_co
unt
integer
prosecute_co
pies_of_docu
ments
text
Описание
административный
персонал, чел.
Штатная численность
на отчетную дату,
инженеры, чел.
Штатная численность
на отчетную дату,
рабочий персонал, чел.
Уволено за отчетный
период, чел.
Уволено за отчетный
период,
административный
персонал, чел.
Уволено за отчетный
период, инженеры, чел.
ve
staff_regular
_engineers
Обязател
ьность
Уволено за отчетный
период, рабочий
персонал, чел.
Число несчастных
случаев за отчетный
период
Число случаев
привлечения
организации к
административной
ответственности
Копии документов о
применении мер
административного
воздействия, а также
мер, принятых для
устранения нарушений,
повлекших применение
административных
санкций
Члены правления ТСЖ
tsg_managem text
ent_members
audit_commi text
sion_member
s
additional_in text
Члены ревизионной
комиссии
Дополнительные
28
Категория
Параметр
Тип
Max
символов
integer
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
income_of_u
sage
IncomeOfU
sage
income_of_k
u
IncomeOfK
u
Описание
сведения в
произвольной форме
Число жителей в
обслуживаемых домах
Количество домов под
управлением на
отчетную дату.
(Описано в Таблица 20)
Количество домов под
управлением на начало
периода. (Описано в
Таблица 21)
Общая площадь домов
под управлением на
отчетную дату.
(Описано в Таблица 22)
Общая площадь домов
под управлением на
начало периода.
(Описано в Таблица 23)
Средний
срок
обслуживания
многоквартирного
дома. (Описано в
Таблица 24)
Доходы, полученные за
оказание услуг по
управлению
многоквартирными
домами. (Описано в
Таблица 25)
Сумма доходов,
полученных от
использования общего
имущества за отчетный
период. (Описано в
Таблица 26)
Сумма доходов,
полученных от
использования общего
имущества за отчетный
период. (Описано в
Таблица 27)
fo_freeform
residents_cou
nt
count_houses
_under_mng_
report_date
Обязател
ьность
29
Категория
Параметр
Тип
spending_of_
mng
SpendingOf
Mng
Max
символов
ClaimsByR
so
net_assets
character
varying
255
annual_finan text
cial_statemen
ts
revenues_exp text
enditures_esti
mates
performance_ text
report
members_me
etings_minut
es
text
audit_commi
sion_report
text
audit_report
text
Описание
Расходы, полученные в
связи с оказанием услуг
по управлению
многоквартирными
домами. (Описано в
Таблица 28)
Выплаты по искам по
договорам управления
за отч
етный период.
(Описано в Таблица 29)
Выплата по искам РСО
за отчетный период.
(Описано в Таблица 30)
Чистые активы
управляющей
организации, тыс. руб.
Годовая бухгалтерская
отчетность
claims_by_co ClaimsByC
ntracts_mng
ontractsMn
g
claims_by_rs
o
Обязател
ьность
Сметы доходов и
расходов ТСЖ или
ЖСК
Отчет о выполнении
сметы доходов и
расходов
Протоколы общих
собраний членов
товарищества или
кооператива, заседаний
правления и
ревизионной комиссии
Заключения
ревизионной комиссии
(ревизора)
товарищества или
кооператива по
результатам проверки
годовой бухгалтерской
(финансовой)
отчетности
Аудиторские
заключения
30
Категория
Параметр
Тип
debt_for_mn
g
DebtForMn
g
debt_owners
numeric
debt_owners
_for_ku
DebtOwner
sForKu
debt_uo_for_
ku
DebtUoFor
Ku
debt_owners
_communal
numeric
charged_for_
mng
ChargedFor
Mng
charged_for_
resources
ChargedFor
Resources
spending_rep
air
SpendingRe
pair
spending_bea
ty
SpendingBe
auty
Max
символов
Обязател
ьность
Описание
Задолженность
собственников за
услуги управления на
отчетную дату.
(Описано в Таблица 31)
Просроченная
задолженность жителей
за услуги по
управлению на начало
отчетного периода
Задолженность
собственников за КУ на
отчетную дату.
(Описано в Таблица 32)
Задолженность
собственников за КУ на
отчетную дату.
(Описано в Таблица 33)
Просроченная
задолженность
собственников за
коммунальные услуги
на начало отчетного
периода, тыс. руб.
Взыскано с
собственников за
услуги управления за
отчетный период.
(Описано в Таблица 34)
Взыскано с
собственников за
поставленные ресурсы
за отчетный период.
(Описано в Таблица 35)
Объем средств,
затраченных на работы
по текущему ремонту
за отчетный период.
(Описано в Таблица 36)
Объем средств,
затраченных на работы
по благоустройству за
отчетный период.
15.2
15.2
31
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
spending_rep
air_invests
SpendingRe
pairInvests
payed_ku_by
_statements
PayedKuBy
Statements
payed_ku_by
_needs
PayedKuBy
Needs
management
_contract
services_cost
text
text
(Описано в Таблица 37)
Объем привлеченных
средств на ремонт,
модернизацию и
благоустройство за
отчетный период.
(Описано в Таблица 38)
Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период.
(Описано в Таблица 39)
Оплачено КУ по счетам
на общедомовые
нужды за отчетный
период. (Описано в
Таблица 40)
Проект договора
управления
Стоимость услуг
tariffs
text
Тарифы
Таблица 19– Описание типа 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
Max
символов
36
Обязател
ьность
36
Да
36
Описание
Идентификатор города
(GUID из ФИАС)
Идентификатор улицы
(GUID из ФИАС)
Номер дома
36
Строение
36
Корпус
Номер квартиры
36
Таблица 20– Описание типа CountHousesUnderMngReportDate
Категория
Параметр
Тип
Max
символов
32
Обязател
ьность
Описание
CountHouse count_houses numeric
sUnderMng _under_mng_
ReportDate report_date
5.2
Домов под
управлением на
отчетную дату. Всего
serviced_by_
tsg
numeric
5.2
Домов, обслуживаемых
ТСЖ, на отчетную дату
serviced_by_
tsg_uo
numeric
5.2
serviced_by_
owner_uo
numeric
5.2
serviced_by_
competition
numeric
5.2
Домов, обслуживаемых
по договору между
ТСЖ и управляющей
организацией, на
отчетную дату
Домов, обслуживаемых
по договору между
собственниками и
управляющей
организацией, на
отчетную дату
Домов, обслуживаемых
по результатам
открытого конкурса
органов местного
самоуправления, на
отчетную дату
Таблица 21– Описание типа CountHousesUnderMngStartPeriod
Категория
Параметр
Тип
CountHouse count_houses numeric
sUnderMng _under_mng_
StartPeriod start_period
Max
символов
5.2
serviced_by_
tsg
numeric
5.2
serviced_by_
tsg_uo
numeric
5.2
serviced_by_
owner_uo
numeric
5.2
Обязател
ьность
Описание
Количество домов под
управлением на начало
периода
Домов, обслуживаемых
ТСЖ, на начало
периода
Домов, обслуживаемых
по договору между
ТСЖ и управляющей
организацией, на
начало периода
Домов, обслуживаемых
по договору между
собственниками и
управляющей
33
Категория
Параметр
serviced_by_
competition
Тип
numeric
Max
символов
Обязател
ьность
Описание
организацией, на
начало периода
Домов, обслуживаемых
по результатам
открытого конкурса
органов местного
самоуправления, на
начало периода
5.2
Таблица 22– Описание типа SumSqHousesUnderMngReportDate
Категория
Параметр
Тип
SumSqHous sum_sq_hous numeric
esUnderMn es_under_mn
gReportDat g_report_date
e
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
Обязател
ьность
Описание
Общая площадь домов
под управлением на
отчетную дату,
тыс.кв.м.
Общая площадь домов
под управлением на
отчетную дату по
домам до 25 лет
Общая площадь домов
под управлением на
отчетную дату по
домам от 26 до 50 лет
Общая площадь домов
под управлением на
отчетную дату по
домам от 51 до 75 лет
Общая площадь домов
под управлением на
отчетную дату по
домам 76 лет и более
Общая площадь домов
под управлением на
отчетную дату по
аварийным домам
Таблица 23– Описание типа SumSqHousesUnderMngStartPeriod
Категория
Параметр
SumSqHous sum_sq_hous
esUnderMn es_under_mn
Тип
numeric
Max
символов
5.2
34
Обязател
ьность
Описание
Общая площадь домов
под управлением на
gStartPeriod g_start_perio
d
sum_sq_hous
es_concluded
_contracts
sum_sq_hous
es_terminate
d_contracts
начало периода
numeric
5.2
numeric
5.2
Изменение общей
площади домов за
отчетный период по
заключенным
договорам, кв.м.
Изменение общей
площади домов за
отчетный период по
расторгнутым
договорам, кв.м.
Таблица 24– Описание типа AvgTimeServiceMkd
Категория
Параметр
Тип
AvgTimeSe
rviceMkd
avg_time_ser
vice_mkd
numeric
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
Обязател
ьность
Описание
Средний срок
обслуживания
многоквартирного дома
Средний срок
обслуживания по
домам до 25 лет
Средний срок
обслуживания по
домам от 26 до 50 лет
Средний срок
обслуживания по
домам от 51 до 75 лет
Средний срок
обслуживания по
домам 76 лет и более
Средний срок
обслуживания по
аварийным домам
Таблица 25– Описание типа IncomeOfMng
Категория
Параметр
Тип
IncomeOfM income_of_m numeric
ng
ng
by_houses_2
numeric
Max
символов
5.2
5.2
35
Обязател
ьность
Описание
Доходы, полученные за
оказание услуг по
управлению
многоквартирными
домами, тыс.руб
Доход от управления за
Категория
Параметр
Тип
Max
символов
Обязател
ьность
отчетный период по
домам до 25 лет
Доход от управления за
отчетный период по
домам от 26 до 50 лет
Доход от управления за
отчетный период по
домам от 51 до 75 лет
Доход от управления за
отчетный период по
домам 76 лет и более
Доход от управления за
отчетный период по
аварийным домам
5
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
Описание
Таблица 26– Описание типа IncomeOfUsage
Категория
Параметр
Тип
IncomeOfU
sage
income_of_u
sage
numeric
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
36
Обязател
ьность
Описание
Сумма доходов,
полученных от
использования общего
имущества за отчетный
период, тыс.руб.
Доход от
использования общего
имущества за отчетный
период по домам до 25
лет
Доход от
использования общего
имущества за отчетный
период по домам от 26
до 50 лет
Доход от
использования общего
имущества за отчетный
период по домам от 51
до 75 лет
Доход от
использования общего
имущества за отчетный
период по домам 76 лет
и более
Категория
Параметр
by_houses_al
arm
Тип
numeric
Max
символов
5.2
Обязател
ьность
Обязател
ьность
Описание
Доход от
использования общего
имущества за отчетный
период по аварийным
домам
Таблица 27– Описание типа IncomeOfKu
Категория
Параметр
Тип
IncomeOfK
u
income_of_k
u
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
by_sewerage
numeric
5.2
Описание
Доход от
предоставления КУ за
отчетный период
Доход от
предоставления
отопления за отчетный
период
Доход от
предоставления
электричества за
отчетный период
Доход от
предоставления газа за
отчетный период
Доход от
предоставления
горячего
водоснабжения за
отчетный период
Доход от
предоставления
холодного
водоснабжения за
отчетный период
Доход от
предоставления
водоотведения за
отчетный период
Таблица 28– Описание типа SpendingOfMng
Категория
Параметр
SpendingOf
spending_of_
Тип
numeric
Max
символов
5.2
37
Обязател
ьность
Описание
Расходы на управление
Mng
mng
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
за отчетный период
Расходы на управление
за отчетный период по
домам до 25 лет
Расходы на управление
за отчетный период по
домам от 26 до 50 лет
Расходы на управление
за отчетный период по
домам от 51 до 75 лет
Расходы на управление
за отчетный период по
домам 76 лет и более
Расходы на управление
за отчетный период по
аварийным домам
Таблица 29– Описание типа ClaimsByContractsMng
Категория
ClaimsByC
ontractsMn
g
Параметр
Тип
claims_by_co numeric
ntracts_mng
claims_for_d
amage
Max
символов
5.2
numeric
5.2
claims_for_re numeric
fusal
5.2
claims_for_s
hort_shipmen
t
5.2
numeric
Обязател
ьность
Описание
Выплаты по искам по
договорам управления
за отчетный период,
тыс. руб.
Выплаты по искам по
компенсации
нанесенного ущерба
Выплаты по искам по
снижению платы в
связи с неоказанием
услуг
Выплаты по искам по
снижению платы в
связи с недопоставкой
ресурсов
Таблица 30– Описание типа ClaimsByRso
Категория
Параметр
Тип
ClaimsByR
so
claims_by_rs
o
by_heating
numeric
Max
символов
5.2
numeric
5.2
38
Обязател
ьность
Описание
Выплаты по искам РСО
за отчетный период
Выплаты по искам за
отопление за отчетный
период
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
by_sewerage
numeric
5.2
Выплаты по искам за
электричество за
отчетный период
Выплаты по искам за
газ за отчетный период
Выплаты по искам за
горячее водоснабжение
за отчетный период
Выплаты по искам за
холодное
водоснабжение за
отчетный период
Выплаты по искам за
водоотведение за
отчетный период
Таблица 31– Описание типа DebtForMng
Категория
Параметр
Тип
DebtForMn
g
debt_for_mn
g
numeric
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
numeric
5.2
39
Обязател
ьность
Описание
Просроченная
задолженность
собственников за
услуги управления на
отчетную дату, тыс.
руб.
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам до 25 лет
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам от 26 до 50 лет
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
домам от 51 до 75 лет
Просроченная
Категория
Параметр
Тип
Max
символов
Обязател
ьность
задолженность жителей
за услуги по
управлению за
отчетный период по
домам 76 лет и более
Просроченная
задолженность жителей
за услуги по
управлению за
отчетный период по
аварийным домам
6
by_houses_al
arm
numeric
Описание
5.2
Таблица 32– Описание типа DebtOwnersForKu
Категория
Параметр
Тип
DebtOwner
sForKu
debt_owners
_for_ku
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
40
Обязател
ьность
Описание
Просроченная
задолженность
собственников за КУ на
отчетную дату
Просроченная
задолженность
собственников за
отопление на отчетную
дату
Просроченная
задолженность
собственников за
электричество на
отчетную дату
Просроченная
задолженность
собственников за газ на
отчетную дату
Просроченная
задолженность
собственников за
горячее водоснабжение
на отчетную дату
Просроченная
задолженность
собственников за
холодное
водоснабжение на
Категория
Параметр
by_sewerage
Тип
numeric
Max
символов
Обязател
ьность
Описание
отчетную дату
Просроченная
задолженность
собственников за
водоотведение на
отчетную дату
5.2
Таблица 33– Описание типа DebtUoForKu
Категория
Параметр
Тип
DebtUoFor
Ku
debt_uo_for_
ku
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
41
Обязател
ьность
Описание
Просроченная
задолженность
организации за
предоставленные
коммунальные услуги,
накопленная за весь
период обслуживания
на отчетную дату
Задолженность
управляющей
организации за
отопление на отчетную
дату
Задолженность
управляющей
организации за
электричество на
отчетную дату
Задолженность
управляющей
организации за газ на
отчетную дату
Задолженность
управляющей
организации за горячее
водоснабжение на
отчетную дату
Задолженность
управляющей
организации за
холодное
водоснабжение на
отчетную дату
Категория
Параметр
Тип
by_sewerage
numeric
Max
символов
5.2
Обязател
ьность
Описание
Задолженность
управляющей
организации за
водоотведение на
отчетную дату
Таблица 34– Описание типа ChargedForMng
Категория
Параметр
Тип
ChargedFor
Mng
charged_for_
mng
numeric
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
42
Обязател
ьность
Описание
Сумма взысканной за
отчетный период
просроченной
задолженности
собственников
помещений и иных лиц,
пользующихся или
проживающих в
помещениях на
законных основаниях
за услуги по
управлению, тыс. руб.
Взыскано с
собственников за
услуги управления за
отчетный период по
домам до 25 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам от 26 до 50 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам от 51 до 75 лет
Взыскано с
собственников за
услуги управления за
отчетный период по
домам 76 лет и более
Взыскано с
собственников за
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
услуги управления за
отчетный период по
аварийным домам
Таблица 35– Описание типа ChargedForResources
Категория
Параметр
Тип
ChargedFor
Resources
charged_for_
resources
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
by_sewerage
numeric
5.2
Обязател
ьность
Описание
Взыскано с
собственников за КУ за
отчетный период
Взыскано с
собственников за
отопление за отчетный
период
Взыскано с
собственников за
электричество за
отчетный период
Взыскано с
собственников за газ за
отчетный период
Взыскано с
собственников за
горячее водоснабжение
за отчетный период
Взыскано с
собственников за
холодное
водоснабжение за
отчетный период
Взыскано с
собственников за
водоотведение за
отчетный период
Таблица 36– Описание типа SpendingRepair
Категория
Параметр
Тип
SpendingRe
pair
spending_rep
air
numeric
Max
символов
5.2
by_houses_2
numeric
5.2
43
Обязател
ьность
Описание
Объем работ по
ремонту за отчетный
период, тыс.руб.
Объем работ по
ремонту за отчетный
период по домам до 25
лет
Объем работ по
ремонту за отчетный
период по домам от 26
до 50 лет
Объем работ по
ремонту за отчетный
период по домам от 51
до 75 лет
Объем работ по
ремонту за отчетный
период по домам 76 лет
и более
Объем работ по
ремонтуза отчетный
период по аварийным
домам
5
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
Таблица 37– Описание типа SpendingBeauty
Категория
Параметр
Тип
SpendingBe
auty
spending_bea
ty
numeric
Max
символов
5.2
by_houses_2
5
numeric
5.2
by_houses_2
6_50
numeric
5.2
by_houses_5
1_75
numeric
5.2
by_houses_7
6
numeric
5.2
by_houses_al
arm
numeric
5.2
44
Обязател
ьность
Описание
Объем работ по
благоустройству за
отчетный период
Объем работ по
благоустройству за
отчетный период по
домам до 25 лет
Объем работ по
благоустройству за
отчетный период по
домам от 26 до 50 лет
Объем работ по
благоустройству за
отчетный период по
домам от 51 до 75 лет
Объем работ по
благоустройству за
отчетный период по
домам 76 лет и более
Объем работ по
благоустройству
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
отчетный период по
аварийным домам
Таблица 38– Описание типа SpendingRepairInvests
Категория
Параметр
Тип
SpendingRe
pairInvests
spending_rep
air_invests
numeric
Max
символов
5.2
subsidy
credits
fin_lising
numeric
numeric
numeric
5.2
5.2
5.2
fin_service
numeric
5.2
contributions numeric
_residents
other_sources numeric
5.2
Обязател
ьность
Описание
Объем привлеченных
средств за отчетный
период
Субсидии
Кредиты
Финансирование по
договорам лизинга
Финансирование по
энергосервисным
договорам
Целевые взносы
жителей
Другие источники
5.2
Таблица 39– Описание типа PayedKuByStatements
Категория
Параметр
Тип
PayedKuBy
Statements
payed_ku_by
_statements
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
45
Обязател
ьность
Описание
Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за отопление
по показаниям
общедомовых ПУ за
отчетный период
Оплачено за
электричество по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за газ по
показаниям
общедомовых ПУ за
отчетный период
Оплачено за горячее
водоснабжение по
Категория
Параметр
by_cold_wat
er
Тип
numeric
Max
символов
Обязател
ьность
Описание
показаниям
общедомовых ПУ за
отчетный период
Оплачено за холодное
водоснабжение по
показаниям
общедомовых ПУ за
отчетный период
5.2
Таблица 40– Описание типа PayedKuByNeeds
Категория
Параметр
Тип
PayedKuBy
Needs
payed_ku_by
_needs
numeric
Max
символов
5.2
by_heating
numeric
5.2
by_electro
numeric
5.2
by_gaz
numeric
5.2
by_hot_water
numeric
5.2
by_cold_wat
er
numeric
5.2
Обязател
ьность
Описание
Оплачено КУ по счетам
на общедомовые
нужды за отчетный
период
Оплачено за отопление
по счетам на
общедомовые нужды за
отчетный период
Оплачено за
электричество по
счетам на
общедомовые нужды за
отчетный период
Оплачено за газ по
счетам на
общедомовые нужды за
отчетный период
Оплачено за горячее
водоснабжение по
счетам на
общедомовые нужды за
отчетный период
Оплачено за холодное
водоснабжение по
счетам на
общедомовые нужды за
отчетный период
46
Таблица 41– Возможные значения 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
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
Значения
Хозяйственные товарищества
Полные товарищества
Товарищества на вере (коммандитные товарищества)
Хозяйственные общества
Общества с ограниченной или дополнительной
ответственностью
Общества с ограниченной ответственностью
Общества с дополнительной ответственностью
Акционерные общества
Открытые акционерные общества
Закрытые акционерные общества
Хозяйственные партнерства
Производственные кооперативы (артели)
Сельскохозяйственные производственные кооперативы
Производственные кооперативы (кроме
сельскохозяйственных производственных кооперативов)
Унитарные предприятия
Унитарные предприятия, основанные на праве оперативного
управления (казенные предприятия)
Федеральные казенные предприятия
Муниципальные казенные предприятия
Унитарные предприятия, основанные на праве
хозяйственного ведения
Федеральные государственные унитарные предприятия
Государственные унитарные предприятия субъектов
Российской Федерации
Муниципальные унитарные предприятия
Крестьянские (фермерские) хозяйства
Прочие юридические лица, являющиеся коммерческими
организациями
Потребительские кооперативы
Жилищные и жилищно-строительные кооперативы
Жилищные накопительные кооперативы
Кредитные потребительские кооперативы
Потребительские общества
Общественные организации (объединения)
Общественные движения
Органы общественной самодеятельности
Фонды
Некоммерческие партнерства
Ассоциации (союзы)
Ассоциации (союзы) экономического взаимодействия
47
Тип
Код
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
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) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 42).
Таблица 42– Выходные параметры метода SetCompanyProfile
Категория
SoapFault
Параметр
code
name
description
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
Описание
integer
text
text
4) Пример вызова метода
48
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>
<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>
49
<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>
</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>
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>
<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>
51
<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>
<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>
52
<management_contract
xsi:type="xsd:string">?</management_contract>
<services_cost xsi:type="xsd:string">?</services_cost>
<tariffs xsi:type="xsd:string">?</tariffs>
<name_full xsi:type="xsd:string">?</name_full>
<name_short xsi:type="xsd:string">?</name_short>
<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>
<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"
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>
53
<description>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 43 – Результаты вызова метода SetCompanyProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
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
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1021
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.7
Метод SetNewCompany
1) Описание метода
54
Метод подачи запроса на регистрацию новой управляющей организации.
Подтверждение регистрации управляющей организации производит модератор Фонда
согласно регламенту.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 44).
Таблица 44 – Входные параметры метода SetNewCompany
Категор
Параметр
ия
SetNewC inn
ompanyI
n
data
Тип
character
varying
NewCompany
ProfileData
Max
символов
12
Обязательн
ость
Да
Да
Описание
ИНН
Массив
данных.
(Описано в
Таблица 45)
Описание типа NewCompanyProfileData:
Таблица 45– Массив данных (NewCompanyProfileData) метода SetNewCompany
Категор
Параметр
ия
NewCom name_full
panyProf
ileData
name_short
okopf
surname
middlename
firstname
position
ogrn
Тип
character
varying
character
varying
Okopf
character
varying
character
varying
character
varying
character
varying
character
Max
символов
255
Обязательн
ость
Да
255
Да
Описание
255
Да
Полное
наименование
Краткое
наименование
ОКОПФ.
Передается код
всероссийского
справочника
ОКОПФ в
формате «2 80
17». (Описано в
Таблица 41)
Фамилия
255
Да
Отчество
255
Да
Имя
255
Да
Должность
Да
13
55
ОГРН
Категор
ия
Параметр
date_assignment_
ogrn
name_authority_a
ssigning_ogrn
Тип
Max
символов
Обязательн
ость
varying
date
text
legal_address
FiasAddress
Да
actual_address
FiasAddress
Да
post_address
FiasAddress
Да
phone
email
text
character
varying
site
proportion_sf
text
numeric
5.2
proportion_mo
numeric
5.2
255
255
3) Выходные параметры
56
Да
Да
Описание
Дата
регистрации
Наименование
органа,
принявшего
решение о
регистрации
Идентификатор
юридического
адреса
(Описано в
Таблица 19)
Идентификатор
фактического
адреса
(Описано в
Таблица 19)
Идентификатор
почтового
адреса
(Описано в
Таблица 19)
Телефон
Электронный
адрес. Формат:
[email protected]
u.
Интернет сайт
Доля участия в
уставном
капитале
Субъекта РФ,
%
Доля участия в
уставном
капитале
муниципальног
о образования,
%
В таблице представлены выходные параметры метода (Таблица 46).
Таблица 46– Выходные параметры метода 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="http://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetNewCompany
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">?</inn>
<newCompanyData xsi:type="api:NewCompanyProfileData">
<name_full xsi:type="xsd:string">?</name_full>
<name_short xsi:type="xsd:string">?</name_short>
<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>
<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>
57
<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>
</newCompanyData>
</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"
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 – Результаты вызова метода 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
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
58
Code
(Код результата
запроса)
1010
5.8
Name
(Наименование)
Description
(Описание)
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
Field "NAME" is not valid
Метод GetHouseList
1) Описание метода
Метод получения списка домов, находящихся в управлении организации с
соответствующим ИНН (по каждому дому возвращается идентификатор дома и адрес по
ФИАС). Внешняя система может получать список домов в управлении организаций, по
которым разрешена подписка.
В результате запроса получения списка домов в управлении API - сервис может
вернуть несколько домов с одинаковым адресом. Внешняя система вправе раскрывать
информацию как по всем своим домам-дублям также и по одному из домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 48).
Таблица 48 – Входные параметры метода GetHouseList
Категор
Параметр
ия
GetHous inn
eList
Тип
character
varying
Max
символов
12
Обязательн
ость
Да
Описание
ИНН
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 49).
Таблица 49– Выходные параметры метода GetHouseList
Категория
Параметр
Тип
GetHouseLi
stResponse
house_id
full_address
integer
FullAddress
SoapFault
code
name
description
integer
text
text
Max
символов
Обязател
ьность
Описание
Идентификатор дома
Адрес дома (Описано в
Таблица 50)
Код результата запроса
Наименование
Описание
Таблица 50– Описание типа FullAddress
Категория
Параметр
Тип
Max
символов
59
Обязател
ьность
Описание
Категория
FullAddress
Параметр
Тип
region_id
character
varying
region_forma
l_name
character
varying
Max
символов
36
120
region_short_ character
name
varying
region_code
character
varying
area_id
character
varying
12
area_formal_
name
character
varying
120
area_short_n
ame
area_code
character
varying
character
varying
character
varying
12
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_id
character
varying
36
city1_id
city2_id
17
36
17
36
17
36
60
Обязател
ьность
Описание
Идентификатор
региона
(GUID по ФИАС,
aolevel = 1)
Формализованное
наименование региона
(ФИАС)
Краткое наименование
типа региона (ФИАС)
Код региона из КЛАДР
4.0.
Идентификатор района
(GUID по ФИАС,
aolevel = 3)
Формализованное
наименование района
(ФИАС)
Краткое наименование
типа района (ФИАС)
Код района из КЛАДР
4.0.
Идентификатор города
(GUID по ФИАС,
aolevel = 4).
Формализованное
наименование города
(ФИАС)
Краткое наименование
типа города (ФИАС)
Код города из КЛАДР
4.0.
Идентификатор
внутригородской
территории
(GUID по ФИАС,
aolevel = 5).
Формализованное
наименование
внутригородской
территории (ФИАС)
Краткое наименование
внутригородской
территории (ФИАС)
Код внутригородской
территории из КЛАДР
4.0.
Идентификатор
населенного пункта
(GUID по ФИАС,
Категория
Параметр
Тип
city3_formal
_name
character
varying
120
city3_short_n
ame
character
varying
12
city3_code
character
varying
character
varying
17
character
varying
120
street_id
street_formal
_name
street_short_
name
street_code
Max
символов
12
additional_ter character
ritory_formal varying
_name
120
additional_ter
ritory_short_
name
additional_ter
ritory_code
character
varying
12
character
varying
17
Описание
aolevel = 6).
Формализованное
наименование
населенного пункта
(ФИАС)
Краткое наименование
населенного пункта
(ФИАС)
Код населенного
пункта из КЛАДР 4.0.
Идентификатор улицы
(GUID по ФИАС,
aolevel = 7)
Формализованное
наименование улицы
(ФИАС)
Краткое наименование
типа улицы (ФИАС)
Код улицы из КЛАДР
4.0.
Идентификатор
дополнительной
территории (GUID по
ФИАС, aolevel = 90)
Формализованное
наименование
дополнительной
территории (ФИАС)
Краткое наименование
типа дополнительной
территории (ФИАС)
Код дополнительной
территории из КЛАДР
4.0.
Номер дома
36
character
varying
character
varying
additional_ter character
ritory
varying
Обязател
ьность
17
36
house_numbe text
r
building
text
block
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.portal.dev/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
61
<soapenv:Body>
<api:GetHouseList
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">2452673519</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"
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) Ошибки
Таблица 51 – Результаты вызова метода 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
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
62
5.9
Метод SetUnlinkFromOrganization
1) Описание метода
Метод прекращения управления домом с соответствующим идентификатором.
Внешняя система может прекращать управление только теми домами, которые находятся
в управлении организаций, по которым внешней системе разрешена подписка на
раскрытие.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 52).
Таблица 52 – Входные параметры метода SetUnlinkFromOrganization
Категор
Параметр
ия
SetUnlin house_id
kFromOr
ganizatio date_stop
nIn
Тип
Max
символов
date
ContractStopR
easonEnum
stop_reason
text
Описание
Идентификатор
дома
Дата
При
stop_reason_t прекращения
ype =1, поле обслуживания
обязательно
Основание
Да
прекращения
обслуживания
(Описано в
Таблица 53)
Причина
При
stop_reason_t завершения
ype =1, поле обслуживания
bigint
stop_reason_type
Обязательн
ость
Да
обязательно
Таблица 53– Возможные значения ContractStopReasonEnum
Тип
ContractStopReasonEn
um
Идентификатор
Значения
finished contract (Действие договора
обслуживания прекращено)
added by error (Дом был включен в
список по ошибке)
1
2
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 54).
Таблица 54– Выходные параметры метода SetUnlinkFromOrganization
Категория
SoapFault
Параметр
code
name
Тип
Max
символов
Обязател
ьность
Описание
Код результата запроса
Наименование
integer
text
63
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://api.reformagkh.ru/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<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) Ошибки
Таблица 55 – Результаты вызова метода SetUnlinkFromOrganization
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
64
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
Попробуйте обратиться позже.
House wasn’t found
Дом с указанным идентификатором не
найден
1011
House is not in company
Дом, находится в управлении другой
организации «ИНН, НАЗВАНИЕ», по
которой нет подписки
1036
House unlinked already
Управление домом уже прекращено
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1013
Missing management date
Не заполнена дата начала управления
домом. Прежде чем прекратить
управление домом, Вам необходимо
заполнить дату начала управления с
помощью метода SetHouseProfile.
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1004
5.10 Метод SetHouseLinkToOrganization
1) Описание метода
Метод добавления дома, с соответствующим идентификатором, в управление
организации с соответствующим ИНН. Внешняя система может добавлять дома в
управление только тех организаций, по которым внешней системе разрешена подписка на
раскрытие.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 56).
Таблица 56 – Входные параметры метода SetHouseLinkToOrganization
Категор
Параметр
ия
SetHouse house_id
LinkToO
rganizati inn
onIn
Тип
Max
символов
bigint
character
varying
date_start
date
plan_date_stop
date
12
Обязательн
ость
Да
Да
Да
65
Описание
Идентификатор
дома
ИНН
управляющей
организации
Дата начала
управления
Плановая дата
прекращения
Категор
ия
Параметр
Тип
Max
символов
Обязательн
ость
Описание
управления
домом
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 57).
Таблица 57– Выходные параметры метода SetHouseLinkToOrganization
Категория
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:SetHouseLinkToOrganization
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<inn xsi:type="xsd:string">?</inn>
<date_start xsi:type="xsd:date">?</date_start>
<plan_date_stop xsi:type="xsd:date">?</plan_date_stop>
</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 означает успешное выполнение запроса.
66
5) Ошибки
Таблица 58 – Результаты вызова метода SetHouseLinkToOrganization
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1005
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
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.11 Метод SetHouseProfile
1) Описание метода
Метод
изменяет
данные
текущей
анкеты
дома
с
соответствующим
идентификатором дома. Внешняя система может изменять данные текущих анкет домов в
управлении организаций, по которым разрешена подписка. Проверка на принадлежность
дома управляющей организации, по которой есть разрешение на подписку раскрытия
данных.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 59).
Таблица 59 – Входные параметры метода SetHouseProfile
Категор
Параметр
ия
SetHouse house_id
Тип
Max
символов
bigint
67
Обязательн
ость
Да
Описание
Идентификатор
дома
Категор
Параметр
ия
ProfileIn data
Тип
Max
символов
HouseProfile
Data
Обязательн
ость
Да
Описание
Массив данных
(Описано в
Таблица 60)
Таблица 60– Массив данных (HouseProfileData) метода SetHouseProfile
Категор
Параметр
ия
HousePr area_total
ofileData
Тип
numeric
Max
символов
15.2
numeric
15.2
area_non_resident numeric
al
15.2
common_space_a
rea
numeric
15.2
cadastral_number
text
exploitation_start
_year
state
text
project_type
character
varying
character
varying
255
individual_name
character
varying
255
house_type
HouseTypeEn
um
wall_material
HouseWallMa
terialEnum
area_residental
location_descripti
on
Обязательн
ость
Да
Да
HouseStateEn
um
255
68
Описание
Общая
площадь
помещений
В том числе
жилых
помещений
Общая
площадь
нежилых
помещений
помещений
общего
пользования
Кадастровый
номер
Год ввода в
эксплуатацию
Идентификатор
состояния дома
(Описано в
Таблица 61)
Серия, тип
проекта
Описание
местоположени
я
Индивидуально
е наименование
дома
Идентификатор
типа жилого
дома
(Описано в
Таблица 63)
Идентификатор
материала
Категор
ия
Параметр
Тип
Max
символов
floor_type
HouseFloorTy
peEnum
storeys_count
entrance_count
integer
integer
elevators_count
integer
area_private
area_municipal
numeric
numeric
15.2
15.2
area_national
numeric
15.2
area_land
numeric
15.2
area_territory
numeric
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
numeric
15.2
thermal_normativ
e_expense
numeric
15.2
energy_efficiency
HouseEnergy
69
Обязательн
ость
Описание
несущих стен
(Описание в
Таблица 64)
Идентификатор
типа
перекрытий
(Описание в
Таблица 65)
Этажность
Количество
подъездов
Количество
лифтов
Частная
Муниципальна
я
Государственн
ая
Площадь
участка, м2
Площадь
придомовой
территории, м2
Инвентарный
номер
Количество
квартир
Количество
жителей
Количество
лицевых счетов
Конструктивны
е особенности
дома
фактический
удельный
расход,
Вт/М3Сград
нормативный
удельный
расход,
Вт/М3Сград
Идентификатор
Категор
ия
Параметр
Тип
Max
символов
Обязательн
ость
EfficiencyClas
sEnum
energy_audit_dat
e
date
privatization_start
_date
deterioration_tota
l
deterioration_fou
ndation
deterioration_bear
ing_walls
deterioration_floo
r
emergency_date
date
emergency_numb
er
character
varying
255
emergency_reaso
n
character
varying
255
numeric
15.2
numeric
15.2
numeric
15.2
numeric
15.2
date
70
При
состоянии
дома
«аварийный
» (state like
‘alarm’), это
поле
обязательно
на ввод
При
состоянии
дома
«аварийный
» (state like
‘alarm’), это
поле
обязательно
на ввод
При
состоянии
дома
«аварийный
» (state like
‘alarm’), это
Описание
класса
энергоэффекти
вности
(Описано в
Таблица 66)
Дата
проведения
энергетическог
о аудита
Дата начала
приватизации
Общая степень
износа
Степень износа
фундамента
Степень износа
несущих стен
Степень износа
перекрытий
Дата документа
о признании
дома
аварийным
Номер
документа о
признании
дома
аварийным
Основание
признания
дома
аварийным
Категор
ия
Параметр
Тип
emergency_after
character
varying
facade
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
Max
символов
255
Обязательн
ость
поле
обязательно
на ввод
При
состоянии
дома
«аварийный
» (state like
‘alarm’), это
поле
обязательно
на ввод
Описание
Дальнейшее
использование
Фасад
(Описано в
Таблица 67)
Кровля
(Описано в
Таблица 68)
Подвал
(Описание в
Таблица 69)
Помещения
общего
пользования
(Описание в
Таблица 71)
Мусоропровод
ы (Описание в
Таблица 72)
Система
отопления
(Описание в
Таблица 73)
Система
горячего
водоснабжения
(Описание в
Таблица 76)
Система
холодного
водоснабжения
(Описание в
Таблица 78)
71
Категор
ия
Параметр
Тип
sewerage_system
SewerageSyst
em
electricity_system
ElectricitySyst
em
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
Описание
Система
водоотведения
(канализация).
(Описание в
Таблица 80)
Система
электроснабже
ния (Описание
в Таблица 82)
Система
газоснабжения
(Описание в
Таблица 84)
Лифт
(Описание в
Таблица 86)
Управление
(Описание в
Таблица 87)
Поставщик
отопления
(Описание в
Таблица 89)
Поставщик
электричества
(Описание в
Таблица 89)
Поставщик газа
(Описание в
Таблица 89)
Поставщик
горячей воды
(Описание в
Таблица 89)
Поставщик
холодной воды
(Описание в
Таблица 89)
Поставщик
водоотведения
(Описание в
Таблица 89)
Финансы
management_cont ManagementC
ract
ontract
heating_provider
Обязательн
ость
Finance
72
Категор
ия
Параметр
Тип
Max
символов
Обязательн
ость
Описание
(Описание в
Таблица 90)
Таблица 61– Возможные значения HouseStateEnum
Тип
HouseStateEnum
Идентификатор
Значения
1
2
3
4
normal
warning
alarm
noinfo
Таблица 62– Возможные значения HouseStageEnum
Тип
HouseStageEnum
Идентификатор
Значения
1
2
exploited
decommissioned – пока запретили
изменение
drifting – пока запретили изменение
3
Таблица 63– Возможные значения HouseTypeEnum
Тип
HouseTypeEnum
Идентификатор
Значения
Общежитие
Объект индивидуального жилищного
строительства
Жилой дом блокированной застройки
Многоквартирный дом
1
2
3
4
Таблица 64– Возможные значения HouseWallMaterialEnum
Тип
HouseWallMaterialEnu
m
Идентификатор
Значения
Нет данных
Каменные, кирпичные
Панельные
Блочные
Смешанные
Монолитные
Деревянные
Прочие
1
2
3
4
5
6
7
8
Таблица 65– Возможные значения HouseFloorTypeEnum
Тип
HouseFloorTypeEnum
Идентификатор
Значения
Нет данных
Железобетонные
1
2
73
Деревянные
Смешанные
3
4
Таблица 66– Возможные значения HouseEnergyEfficiencyClassEnum
Тип
HouseEnergyEfficiency
ClassEnum
Идентификатор
Значения
Нет данных
Не присвоен
A
B
B+
B++
C
D
E
1
2
3
4
5
6
7
8
9
Таблица 67– Описание типа Facade
Тип
Facade
Параметр
Тип
area_total
numeric
Max
символов
15.2
area_plastere
d
area_unplaste
red
area_panel
numeric
15.2
numeric
15.2
numeric
15.2
area_tiled
numeric
15.2
area_lined_si
ding
numeric
15.2
area_wooden
numeric
15.2
area_insulate
d_decorative
_plaster
numeric
15.2
area_insulate
d_tiles
numeric
15.2
area_insulate
numeric
15.2
Обязател
ьность
Описание
Площадь фасада общая,
м2
Площадь фасада
оштукатуренная, м2
Площадь фасада
неоштукатуренная, м2
Площадь фасада
панельная, м2
Площадь фасада,
облицованная плиткой,
м2
Площадь фасада,
облицованная
сайдингом, м2
Площадь фасада
деревянная, м2
Площадь утепленного
фасада с отделкой
декоративной
штукатуркой, м2
Площадь утепленного
фасада с отделкой
плиткой, м2
Площадь утепленного
74
Тип
Параметр
Тип
Max
символов
Обязател
ьность
фасада с отделкой
сайдингом, м2
Площадь отмостки, м2
Площадь остекления
мест общего
пользования (дерево),
м2
Площадь остекления
мест общего
пользования (пластик),
м2
d_siding
area_riprap
area_glazing
_common_w
ooden
numeric
numeric
15.2
15.2
area_glazing
_common_pl
astic
numeric
15.2
area_glazing
_individual_
wooden
area_door_fil
lings_metal
numeric
15.2
numeric
15.2
area_door_fil
lings_others
last_overhaul
_date
numeric
15.2
Описание
Площадь
индивидуального
остекления (дерево), м2
Площадь
металлических дверных
заполнений, м2
Площадь иных дверных
заполнений, м2
Год проведения
последнего
капитального ремонта
text
Таблица 68– Описание типа Roof
Тип
Roof
Параметр
Тип
area_total
numeric
Max
символов
15.2
area_pitched
_slate
area_pitched
_metal
numeric
15.2
numeric
15.2
area_pitched
_others
area_flat
numeric
15.2
numeric
15.2
last_overhaul
_date
text
75
Обязател
ьность
Описание
Площадь кровли общая,
м2
Площадь кровли
шиферная скатная, м2
Площадь кровли
металлическая скатная,
м2
Площадь кровли иная
скатная, м2
Площадь кровли
плоская, м2
Год проведения
последнего
капитального ремонта
кровли
Таблица 69– Описание типа Basement
Тип
Basement
Параметр
Тип
basement_sta
ge
BasementSt
ageEnum
basement_are
a
numeric
basement_las
t_overhaul_d
ate
text
Max
символов
Обязател
ьность
Описание
Сведения о подвале
(Возможные значения в
Таблица 70)
Площадь подвальных
помещений (включая
помещения подвала и
техподполье, если оно
требует ремонта), м2
Год проведения
последнего
капитального ремонта
подвальных помещений
15.2
Таблица 70– Возможные значения BasementStageEnum
Тип
BasementStageEnum
Идентификатор
Значения
нет данных
отсутствует
эксплуатируемый
неэксплуатируемый
1
2
3
4
Таблица 71– Описание типа CommonSpace
Категория
Параметр
Тип
CommonSp
ace
common_spa
ce_area
numeric
common_spa
ce_overhaul_
date
text
Max
символов
15.2
Обязател
ьность
Max
символов
Обязател
ьность
Описание
Площадь помещений
общего пользования,
м2
Год проведения
последнего ремонта
помещений общего
пользования
Таблица 72– Описание типа Chute
Категория
Chute
Параметр
chute_count
Тип
Описание
Количество
мусоропроводов в доме
Год проведения
последнего
капитального ремонта
мусоропроводов
integer
chute_last_ov text
erhaul_date
76
Таблица 73– Описание типа HeatingSystem
Категория
Параметр
Тип
HeatingSyst
em
system_name
HeatingSyst
emNameEn
um
bigint
elevators
system_lengt
h
numeric
last_overhaul
_date
text
Max
символов
Обязател
ьность
Описание
Идентификатор типа
(Возможные значения в
Таблица 74)
Количество
элеваторных узлов
системы отопления
Длина трубопроводов
системы отопления, м
10.2
input_points_ integer
count
Год проведения
последнего
капитального ремонта
системы отопления
Количество точек ввода
отопления
control_node
s_count
integer
Количество узлов
управления отоплением
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Количество
общедомовых приборов
учета отопления
Идентификатор
отпуска отопления
(Возможные значения в
Таблица 75)
Таблица 74– Возможные значения HeatingSystemNameEnum
Тип
HeatingSystemNameEn
um
Идентификатор
Значения
нет данных
отсутствует
центральное
автономное
поквартирное
печное
1
2
3
4
5
6
Таблица 75– Возможные значения ProvisioningEnum
Тип
ProvisioningEnum
Идентификатор
Значения
нет данных
1
77
по нормативам или квартирным ПУ
по показаниям общедомовых ПУ
2
3
Таблица 76– Описание типа HotWaterSystem
Категория
Параметр
HotWaterSy system_name
stem
system_lengt
h
last_overhaul
_date
Тип
Max
символов
Обязател
ьность
Тип
(Возможные значения в
Таблица 77)
Длина трубопроводов
системы горячего
водоснабжения, м
Год проведения
последнего
капитального ремонта
системы горячего
водоснабжения
Количество точек ввода
горячей воды
HotWaterSy
stemNameE
num
numeric
10.2
text
input_points_ integer
count
control_node
s_count
integer
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество узлов
управления поставкой
горячей воды
Количество
общедомовых приборов
учета горячей воды
Отпуск горячей воды
производится
(Возможные значения в
Таблица 75)
Таблица 77– Возможные значения HotWaterSystemNameEnum
Тип
HotWaterSystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованная открытая
централизованная закрытая
поквартирная
автономная
1
2
3
4
5
6
78
Таблица 78– Описание типа ColdWaterSystem
Категория
Параметр
ColdWaterS system_name
ystem
system_lengh
t
last_overhaul
_date
Тип
Max
символов
Обязател
ьность
Тип
(Возможные значения в
Таблица 79)
Длина трубопроводов
системы холодного
водоснабжения, м
Год проведения
последнего
капитального ремонта
системы холодного
водоснабжения
Количество точек ввода
холодной воды
ColdWaterS
ystemName
Enum
numeric
10.2
text
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета холодной воды
Отпуск холодной воды
производится
(Возможные значения в
Таблица 75)
Таблица 79– Возможные значения ColdWaterSystemNameEnum
Тип
ColdWaterSystemNam
eEnum
Идентификатор
Значения
нет данных
отсутствует
централизованное
автономное
1
2
3
4
Таблица 80– Описание типа SewerageSystem
Категория
Параметр
SewerageSy system_name
stem
system_lengt
h
last_overhaul
_date
Тип
Max
символов
Обязател
ьность
Описание
Идентификатор типа
(Возможные значения в
Таблица 81)
Длина трубопроводов
системы
водоотведения, м
Год проведения
последнего
капитального ремонта
SewerageSy
stemNameE
num
numeric
10.2
text
79
системы водоотведения
(канализации)
Таблица 81– Возможные значения SewerageSystemNameEnum
Тип
SewerageSystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованная
автономная
1
2
3
4
Таблица 82– Описание типа ElectricitySystem
Категория
Параметр
Тип
ElectricityS
ystem
system_name
ElectricityS
ystemName
Enum
system_lengt
h
numeric
last_overhaul
_date
text
Max
символов
Обязател
ьность
Система
электроснабжения
(Возможные значения в
Таблица 83)
Длина сетей в местах
общего пользования, м
10.2
Год проведения
последнего капремонта
системы
электроснабжения
Количество точек ввода
электричества
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета электричества
Отпуск электричества
производится
(Возможные значения в
Таблица 75)
Таблица 83– Возможные значения ElectricitySystemNameEnum
Тип
ElectricitySystemName
Enum
Идентификатор
Значения
нет данных
отсутствует
централизованное
комбирированное
1
2
3
4
80
Таблица 84– Описание типа GasSystem
Категория
Параметр
Тип
GasSystem
system_name
GasSystem
NameEnum
system_lengt
h
numeric
10.2
system_lengt
h_no_require
ments
last_overhaul
_date
numeric
10.2
Max
символов
Обязател
ьность
Вид системы
газоснабжения
(Возможные значения в
Таблица 85)
Длина сетей
соответствующих
требованиям
Длина сетей не
соответствующих
требованиям
Год проведения
последнего капремонта
системы газоснабжения
Количество точек ввода
газа
text
input_points_ integer
count
metering_dev
ices_count
integer
provisioning
Provisionin
gEnum
Описание
Количество
общедомовых приборов
учета газа
Отпуск газа
производится
(Возможные значения в
Таблица 75)
Таблица 85– Возможные значения GasSystemNameEnum
Тип
GasSystemNameEnum
Идентификатор
Значения
нет данных
отсутствует
централизованное
1
2
3
Таблица 86– Описание типа Lift
Категория
Lift
Параметр
porch_numbe
r
factory_num
ber
stops_count
capacity
date_exploita
tion
Тип
character
varying
character
varying
integer
integer
text
Max
символов
255
Обязател
ьность
Описание
номер подъезда
заводской номер
255
количество остановок
грузоподъемность, кг
год ввода в
эксплуатацию
81
Категория
Параметр
Тип
date_last_rep
air
plan_period
text
manufacturer
text
character
varying
Max
символов
Обязател
ьность
Описание
год проведения
последнего капремонта
плановый срок замены
(вывода из
эксплуатации)
изготовитель
255
Таблица 87– Описание типа ManagementContract
Категория
Параметр
Managemen contract_type
tContract
date_start
Тип
Max
символов
date
Плановая дата
прекращения
обслуживания дома по
договору управления
Выполняемые работы
Выполнение
обязательств
Примечание
Стоимость услуг
Средства ТСЖ или
ЖСК
Условия оказания услуг
ТСЖ или ЖСК
plan_date_sto date
p
text
text
notice
service_cost
resources_tsz
_zsk
terms_service
_tsz_zsk
text
text
text
Описание
Тип договора
управления
(Возможные значения в
Таблица 88)
Дата начала
обслуживания дома по
договору управления
ContractTy
peEnum
jobs
responsibility
Обязател
ьность
text
Таблица 88– Возможные значения ContractTypeEnum
Тип
ContractTypeEnum
Идентификатор
Значения
обслуживаемых ТСЖ
обслуживаемых по договору между
ТСЖ и управляющей организацией
обслуживаемых по договору между
собственниками и управляющей
организацией
обслуживаемых по результатам
открытого конкурса органов местного
1
2
3
4
82
Тип
Идентификатор
Значения
самоуправления
обслуживаемых по договору
управления между застройщиком и
управляющей организацией,
отобранной по результатам открытого
конкурса органом местного
самоуправления
обслуживаемых по договору
управления специализированным
жилищным фондом военных городков
Минобороны РФ
5
6
Таблица 89– Описание типа 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
Таблица 90– Описание типа Finance
Категория
Finance
Параметр
Тип
income_man
agement
numeric
Max
символов
15.2
income_man
agement_co
mmon_prope
rty
management
_costs
numeric
15.2
numeric
15.2
debt_owners
numeric
15.2
83
Обязател
ьность
Описание
Доход от управления за
отчетный период, тыс.
руб.
Доход от управления
общим имуществом за
отчетный период, тыс.
руб.
Расходы на управление
за отчетный период,
тыс. руб.
Задолженность
Категория
Параметр
Тип
Max
символов
numeric
15.2
payment_clai
ms_compens
ation
payment_clai
ms_refusal
numeric
15.2
numeric
15.2
payment_clai
ms_not_deliv
ered
numeric
15.2
repair_work
numeric
15.2
beautification
_work
numeric
15.2
raised_funds
_subsidies
numeric
15.2
raised_funds
_credits
numeric
15.2
raised_funds
_leasing
numeric
15.2
raised_funds
_energy_serv
ice
numeric
15.2
Описание
собственников за
услуги управления на
отчетную дату, тыс.
руб.
Взыскано с
собственников за
услуги управления за
отчетный период, тыс.
руб.
Иски по компенсации
нанесенного ущерба
_total
charged_own
ers_total
Обязател
ьность
Иски по снижению
платы в связи с
неоказанием услуг
Иски по снижению
платы в связи с
недопоставкой
ресурсов
Объем работ по
ремонту за отчетный
период, тыс. руб.
Объем работ по
благоустройству за
отчетный период, тыс.
руб.
Объем привлеченных
средств за отчетный
период, тыс. руб.
(субсидии)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(кредиты)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(финансирование по
договорам лизинга)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(финансирование по
84
Категория
Параметр
Тип
Max
символов
raised_funds
_contribution
s
numeric
15.2
raised_funds
_others
numeric
15.2
income_supp
ly_heating
numeric
15.2
income_supp
ly_electricity
numeric
15.2
income_supp
ly_gaz
numeric
15.2
income_supp
ly_hot_water
numeric
15.2
income_supp
ly_cold_wate
r
numeric
15.2
income_supp
ly_wastewate
r
numeric
15.2
Обязател
ьность
Описание
энергосервисным
договорам)
Объем привлеченных
средств за отчетный
период, тыс. руб.
(целевые взносы
жителей)
Объем привлеченных
средств за отчетный
период, тыс. руб. (иные
источники)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб.
(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
тыс. руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Доход от поставки
КУ за отчетный период,
85
Категория
Параметр
Тип
Max
символов
debt_owners
_heating
numeric
15.2
debt_owners
_electricity
numeric
15.2
debt_owners
_gaz
numeric
15.2
debt_owners
_hot_water
numeric
15.2
debt_owners
_cold_water
numeric
15.2
debt_owners
_wastewater
numeric
15.2
charged_serv
ices_heating
numeric
15.2
Обязател
ьность
Описание
тыс. руб.
(водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (электричество)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Задолженность
собственников за КУ на
отчетную дату, тыс.
руб. (водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
86
Категория
Параметр
Тип
Max
символов
charged_serv numeric
ices_electricit
y
15.2
charged_serv
ices_gaz
numeric
15.2
charged_serv
ices_hot_wat
er
numeric
15.2
charged_serv
ices_cold_wa
ter
numeric
15.2
charged_serv
ices_wastewa
ter
numeric
15.2
paid_services
_heating
numeric
15.2
paid_services
numeric
15.2
Обязател
ьность
Описание
собственников за КУ за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб.(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Взыскано с
собственников за КУ за
отчетный период, тыс.
руб. (водоотведение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
87
Категория
Параметр
Тип
Max
символов
numeric
15.2
paid_services
_hot_water
numeric
15.2
paid_services
_cold_water
numeric
15.2
paid_resourc
es_heating
numeric
15.2
paid_resourc
es_electricity
numeric
15.2
Описание
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб.(электричество)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено КУ по
показаниям
общедомовых ПУ за
отчетный период, тыс.
руб. (холодное
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (отопление)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (электричество)
_electricity
paid_services
_gaz
Обязател
ьность
88
Категория
Параметр
Тип
paid_resourc
es_gaz
numeric
Max
символов
15.2
paid_resourc
es_hot_water
numeric
15.2
paid_resourc
es_cold_wate
r
numeric
15.2
Обязател
ьность
Описание
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (газ)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (горячее
водоснабжение)
Мой дом – Финансы –
Коммунальные услуги
– Оплачено ресурсов по
счетам на
общедомовые нужды за
отчетный период, тыс.
руб. (холодное
водоснабжение)
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 91).
Таблица 91– Выходные параметры метода 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">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
89
<api:SetHouseProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<inn xsi:type="xsd:string">?</inn>
<data xsi:type="api:HouseProfileData">
<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>
</address>
<area_total xsi:type="xsd:float">?</area_total>
<area_residental xsi:type="api:Decimal152">?</area_residental>
<area_non_residental
xsi:type="api:Decimal152">?</area_non_residental>
<cadastral_number xsi:type="xsd:string">?</cadastral_number>
<state xsi:type="api:HouseStateEnum">?</state>
<project_type xsi:type="xsd:string">?</project_type>
<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="api:Decimal152">?</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>
<emergency_date xsi:type="xsd:date">?</emergency_date>
<emergency_number xsi:type="xsd:string">?</emergency_number>
90
<emergency_reason xsi:type="xsd:string">?</emergency_reason>
<emergency_after xsi:type="xsd:string">?</emergency_after>
<last_overhaul_date
xsi:type="xsd:string">?</last_overhaul_date>
<facade xsi:type="api:Facade">
<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>
<area_glazing_individual_wooden
xsi:type="api:Decimal152">?</area_glazing_individual_wooden>
<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">
<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">
<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">
<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">
<chute_count xsi:type="xsd:int">?</chute_count>
<chute_last_overhaul_date
xsi:type="xsd:string">?</chute_last_overhaul_date>
91
</chute>
<heating_system xsi:type="api:HeatingSystem">
<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">
<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">
<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">
<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>
<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>
</sewerage_system>
<electricity_system xsi:type="api:ElectricitySystem">
<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">
<system_name xsi:type="api:GasSystemNameEnum">?</system_name>
92
<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">
<contract_type
xsi:type="api:ContractTypeEnum">?</contract_type>
<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">
<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">
<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">
<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">
<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">
<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>
93
<additional_info xsi:type="xsd:string">?</additional_info>
</cold_water_provider>
<drainage_provider xsi:type="api:Provider">
<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>
</drainage_provider>
<finance xsi:type="api:Finance">
<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>
94
<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>
<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 означает успешное выполнение запроса.
95
5) Ошибки
Таблица 92 – Результаты вызова метода SetHouseProfile
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 УО, ИНН,
НАЗВАНИЕ», по которой нет
подписки
1011
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1012
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.12 Метод SetNewHouse
1) Описание метода
Метод добавления нового дома с соответствующим адресом по ФИАС (GUID).
Внешняя система на вход подает GUID улицы, если дом без улицы, то на вход подается
GUID населенного пункта. Проверка существования дома с указанным адресом.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 93).
96
Таблица 93 – Входные параметры метода SetNewHouse
Категор
Параметр
ия
SetNew
address
HouseIn
state
Тип
Max
символов
FiasAddress
Обязательн
ость
Да
Описание
Адрес дома
(GUID по
ФИАС)
(Описано в
Таблица 19)
Признак
состояния дома
(возможные
значения в
Таблица 61)
Да
HouseStateEn
um
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 94).
Таблица 94– Выходные параметры метода SetNewHouse
Категория
SetNewHou
seOut
SoapFault
Параметр
Тип
Max
символов
Обязател
ьность
Описание
house_id
integer
Идентификатор дома
code
name
description
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:SetNewHouse
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<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>
</address>
<state xsi:type="api:HouseStateEnum">?</state>
</api:SetNewHouse>
</soapenv:Body>
</soapenv:Envelope>
SoapFault:
97
<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) Ошибки
Таблица 95 – Результаты вызова метода 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
Is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.13 Метод GetHouseInfo
1) Описание метода
Метод получения идентификатора дома с соответствующим адресом по ФИАС. По
одному адресу может быть несколько домов, например, снесенные. Возвращаем все дома.
98
В результате запроса получения информации по дому API - сервис может вернуть
несколько домов с одинаковым адресом. Необходимо выбрать дом, который находится в
управлении организации, по которой внешняя система раскрывает информацию. Если
таких домов несколько, то внешняя система вправе раскрывать информацию как по всем
своим домам-дублям также и по одному из домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 96).
Таблица 96 – Входные параметры метода GetHouseInfo
Категор
Параметр
ия
GetHous fias_address
eInfo
Тип
Max
символов
Обязательн
ость
Описание
Адрес дома по
ФИАС
(Описано в
Таблица 19)
FiasAddress
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 97).
Таблица 97– Выходные параметры метода GetHouseInfo
Категория
HouseInfo
SoapFault
Параметр
Тип
Max
символов
Обязател
ьность
Да
house_id
full_address
integer
FullAddress
inn
character
varying
state
HouseState
Enum
Да
stage
HouseStage
Enum
Да
is_drifting_fr
om
date
code
name
description
integer
text
text
12
4) Пример вызова метода
99
Описание
Идентификатор дома
Адрес дома (Описано в
Таблица 50)
ИНН текущей
организации, в
управлении которой
находится дом
Идентификатор
состояния (Описано в
Таблица 61)
Идентификатор стадия
жизненного цикла дома
(Описано в Таблица 62)
Дата сноса дома. Дата
возвращается, только
когда стадия дома
«снесен»
Код результата запроса
Наименование
Описание
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.portal.dev/api">
<soapenv:Header>
<authenticate
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseInfo
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<address xsi:type="api:FiasAddress">
<city_id xsi:type="xsd:string">d5f593b0-68df-4ab2-82bc3646924a4741</city_id>
<street_id xsi:type="xsd:string">h7f592b0-68df-4ab2-82bc3646924a4734</street_id>
<house_number xsi:type="xsd:string">13</house_number>
<building xsi:type="xsd:string">1</building>
<block xsi:type="xsd:string">a</block>
<room_number xsi:type="xsd:string">32</room_number>
</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"
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) Ошибки
Таблица 98 – Результаты вызова метода GetHouseInfo
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
100
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
500
Internal Server Error
1014
Missing city
Населенный пункт с указанным
идентификатором не найден
1015
Missing street
Улица с указанным идентификатором
не найдена
House wasn’t found
1033
Дом с указанным адресом не найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.14 Метод SetFileToCompanyProfile
1) Описание метода
Метод добавления файла в заданный раздел текущей/архивной анкеты организации
с соответствующим ИНН за указанный отчетный период. Внешняя система может
добавлять файлы в анкеты организаций, по которым разрешена подписка на раскрытие.
Допустимые расширения файлов: .odt, .ods, .odp, .doc, .docx, .xls, .xlsx, .ppt, .pptx,
.txt, .dat, .jpg, .jpeg, .png, .pdf, .gif, .tif.
Максимальный размер файла: 15Мб.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 99).
Таблица 99 – Входные параметры метода SetFileToCompanyProfile
Категор
Параметр
ия
SetFileT reporting_period_
oCompa id
nyProfile
inn
In
Тип
Max
символов
bigint
character
varying
profile_part_id
ProfilePartsEn
um
file
FileObject
12
Обязательн
ость
Да
Да
Да
101
Описание
Идентификатор
отчетного
периода
ИНН
управляющей
организации
Идентификатор
раздела, к
которому
относится файл
(Возможные
значения в т).
Файл.
Категор
ия
Параметр
Тип
Max
символов
Обязательн
ость
Описание
(Описано в
Таблица 101)
Таблица 100– Возможные значения ProfilePartsEnum
Тип
ProfilePartsEnum
Идентификатор
Название раздела
Копии документов о применении мер
административного воздействия, а
также мер,
принятых для устранения нарушений,
повлекших применение
административных санкций
Дополнительная информация
Годовая бухгалтерская отчетность
Сметы доходов и расходов ТСЖ или
ЖСК
Отчет о выполнении сметы доходов и
расходов
Протоколы общих собраний членов
товарищества или кооператива,
заседаний правления и ревизионной
комиссии
Заключения ревизионной комиссии
(ревизора) товарищества или
кооператива по результатам проверки
годовой бухгалтерской (финансовой)
отчетности
Аудиторские заключения
Проект договора управления
Стоимость услуг
Тарифы
1
2
3
4
5
6
7
8
9
10
11
Таблица 101 – Описание типа FileObject
Категор
Параметр
ия
FileObje name
ct
data
Тип
Max
символов
character
varying
string
Обязательн
ость
Да
Да
3) Выходные параметры
102
Описание
Название
файла
Файл. Текст,
содержимое
зашифровано
B64
В таблице представлены выходные параметры метода (Таблица 102).
Таблица 102– Выходные параметры метода SetFileToCompanyProfile
Категория
FileInfo
Параметр
file_id
name
extension
SoapFault
size
create_date
code
name
description
Тип
bigint
character
varying
character
varying
integer
date
integer
text
text
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
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetFileToCompanyProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<inn xsi:type="xsd:string">?</inn>
<profile_part_id xsi:type="xsd:int">?</profile_part_id>
<file_object xsi:type="api:FileObject">
<name xsi:type="xsd:string">?</name>
<data xsi:type="xsd:string">?</data>
</file_object>
</api:SetFileToCompanyProfile>
</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>
103
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 103 – Результаты вызова метода SetFileToCompanyProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1021
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1022
Extension is not valid
Файл с таким расширение не допустим
к загрузке
1023
File Size Limit Exceeded
Размер загружаемого файла превышает
15MB
1027
Missing company profile in
this reporting period
Анкета управляющей организации за
указанный отчетный период не найдена
1028
Part is not in company profile
Указан раздел "ИДЕНТИФИКАТОР
РАЗДЕЛА", который не относится к
анкете управляющей организации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.15 Метод SetFileToHouseProfile
1) Описание метода
104
Метод добавления нового файла в заданный раздел текущей анкеты дома с
соответствующим идентификатором дома. Внешняя система может добавлять файлы в
анкеты домов, которыми управляют организации, по которым внешней системе разрешена
подписка на раскрытие.
Допустимые расширения файлов: .odt, .ods, .odp, .doc, .docx, .xls, .xlsx, .ppt, .pptx,
.txt, .dat, .jpg, .jpeg, .png, .pdf, .gif, .tif. Максимальный размер файла: 15Мб.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 104).
Таблица 104 – Входные параметры метода SetFileToHouseProfile
Категория
Параметр
Тип
SetFileToH
ouseProfile
In
house_id
profile_part_i
d
bigint
ProfileParts
Enum
file
FileObject
Max
символов
Обязател
ьность
Да
Да
Описание
Идентификатор дома
Идентификатор
раздела, к которому
относится файл
(Возможные значения
Таблица 105)
Файл. (Описано в
Таблица 101)
Таблица 105– Возможные значения ProfilePartsEnum
Тип
ProfilePartsEnum
Идентификатор
Название раздела
Выполняемые работы
Выполнение обязательств
Стоимость услуг
Средства ТСЖ или ЖСК
Условия оказания услуг ТСЖ или ЖСК
Файлы (акты), которые прикрепляются
при смене состояния дома (на
состояние «аварийный» и из состояния
«аварийный»)
12
13
14
15
16
21
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 106).
Таблица 106– Выходные параметры метода SetFileToHouseProfile
Категория
FileInfo
Параметр
file_id
name
Тип
bigint
character
varying
Max
символов
Обязател
ьность
Описание
Идентификатор файла
Название файла
255
105
extension
SoapFault
size
create_date
code
name
description
character
varying
integer
date
integer
text
text
Расширение файла
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
xsi:type="xsd:string">r3r3ct27sala7p283h4btkpe75</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:SetFileToHouseProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<profile_part_id xsi:type="xsd:int">?</profile_part_id>
<file_object xsi:type="api:FileObject">
<name xsi:type="xsd:string">?</name>
<data xsi:type="xsd:string">?</data>
</file_object>
</api:SetFileToHouseProfile>
</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) Ошибки
106
Таблица 107 – Результаты вызова метода SetFileToHouseProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1021
No permission
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1022
Extension is not valid
Файл с таким расширение не допустим
к загрузке
1023
File Size Limit Exceeded
Размер загружаемого файла превышает
15MB
1026
Part is not in house profile
Указан раздел "ИДЕНТИФИКАТОР
РАЗДЕЛА", который не относится к
анкете дома
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
1010
5.16 Метод GetFilesInfoFromCompanyProfile
1) Описание метода
Метод получения списка файлов из заданного раздела текущей/архивной анкеты
организации с соответствующим ИНН за указанный отчетный период. Внешняя система
может получать список файлов только по анкетам организаций, по которым у внешней
системы есть подписка.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 108).
107
Таблица 108 – Входные параметры метода GetFilesInfoFromCompanyProfile
Категория
GetFilesInf
oFromCom
panyProfile
In
Параметр
inn
reporting_per
iod_id
profile_part_i
d
Тип
character
varying
bigint
Max
Обязател
символов
ьность
12
Да
Да
Описание
ИНН управляющей
организации
Идентификатор
отчетного периода
Идентификатор
раздела, к которому
относится файл (список
названий разделов
описан в Таблица 109)
Есть возможность
запросить файлы
нескольких разделов,
для этого передаем
список
идентификаторов
разделов. При запросе
всех файлов анкеты
значения для данного
параметра указываем
NULL
integer
Таблица 109– Разделы анкеты управляющей организации
Идентификатор
Значение
1
prosecute_documents_copies
2
additional_files
3
annual_financial_statements
4
revenues_expenditures_estim
ates
5
performance_report
6
general_meetings_protocol
108
Название раздела
Overview (Копии документов о
применении мер административного
воздействия, а также мер,
принятых для устранения
нарушений, повлекших применение
административных санкций)
Overview (Дополнительная
информация)
financial_indicators (Годовая
бухгалтерская отчетность)
financial_indicators (Сметы доходов и
расходов ТСЖ или ЖСК)
financial_indicators (Отчет о
выполнении сметы доходов и
расходов)
financial_indicators (Протоколы
общих собраний членов
товарищества или кооператива,
заседаний правления и ревизионной
комиссии)
7
audit_commision_report
8
audit_reports
9
management_contract
10
services_cost
11
tariffs
financial_indicators (Заключения
ревизионной комиссии (ревизора)
товарищества или кооператива по
результатам проверки годовой
бухгалтерской (финансовой)
отчетности)
financial_indicators (Аудиторские
заключения)
management_activities (Проект
договора управления)
management_activities (Стоимость
услуг)
management_activities (Тарифы)
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 110).
Таблица 110– Выходные параметры метода GetFilesInfoFromCompanyProfile
Категория
FileInfo
Параметр
file_id
name
size
create_date
bigint
character
varying
character
varying
integer
date
code
name
description
integer
text
text
extension
SoapFault
Тип
255
Обязател
ьность
Да
Да
Идентификатор файла
Название файла
255
Да
Расширение файла
Max
символов
Да
Описание
Размер файла
Дата добавления файла
в анкету
Код результата запроса
Наименование
Описание
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:GetFilesInfoFromCompanyProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">?</inn>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<profile_part_id xsi:type="xsd:int">?</profile_part_id>
109
</api:GetFilesInfoFromCompanyProfile>
</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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 111 – Результаты вызова метода GetFilesInfoFromCompanyProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1020
External system has no
request
Внешняя система не подписана на
раскрытие данных по управляющей
организации
1021
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
110
5.17 Метод GetFilesInfoFromHouseProfile
1) Описание метода
Метод получения списка файлов из заданного раздела текущей анкеты дома с
соответствующим идентификатором дома. Внешняя система может получать файлы по
текущим анкетам своих домов (дома, находящиеся в управлении организаций, по которым
разрешена подписка).
2) Входные данные
В таблице представлены входные параметры метода (Таблица 112).
Таблица 112 – Входные параметры метода GetFilesInfoFromHouseProfile
Категория
Параметр
GetFilesInf house_id
oFromHous profile_part_i
eProfileIn
d
Тип
Max
символов
bigint
integer
Обязател
ьность
Да
Описание
Идентификатор дома
Идентификатор
раздела, к которому
относится файл (список
названий разделов
описан в Таблица 113)
Есть возможность
запросить файлы
нескольких разделов,
для этого передаем
список
идентификаторов
разделов. При запросе
всех файлов анкеты
значения для данного
параметра указываем
NULL
Таблица 113– Разделы анкеты дома
Идентификатор
12
Значение
contract_periodic_data
13
contract_periodic_data
14
contract_periodic_data
15
contract_periodic_data
16
contract_periodic_data
21
mkd_overview
Название раздела
Jobs (Выполняемые работы)
Responsibility (Выполнение
обязательств)
cost_service (Стоимость услуг)
resources_tsz_zsk (Средства ТСЖ или
ЖСК)
terms_service_tsz_zsk (Условия
оказания услуг ТСЖ или ЖСК)
alarm_reason (Файлы (акты), которые
111
прикрепляются при смене состояния
дома на состояние «аварийный» и из
состояния «аварийный»)
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 114).
Таблица 114– Выходные параметры метода GetFilesInfoFromHouseProfile
Категория
FileInfo
Параметр
file_id
name
size
create_date
bigint
character
varying
character
varying
integer
date
code
name
description
integer
text
text
extension
SoapFault
Тип
255
Обязател
ьность
Да
Да
Идентификатор файла
Название файла
255
Да
Расширение файла
Max
символов
Да
Описание
Размер файла
Дата добавления файла
в анкету
Код результата запроса
Наименование
Описание
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:GetFilesInfoFromHouseProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">?</house_id>
<profile_part_id xsi:type="xsd:int">?</profile_part_id>
</api:GetFilesInfoFromHouseProfile>
</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>
112
<description>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 115 – Результаты вызова метода GetFilesInfoFromHouseProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.18 Метод GetFileByID
1) Описание метода
Метод получения файла с соответствующим идентификатором. Внешняя система
может получать файлы с соответствующим идентификатором из текущей/архивной
анкеты организаций, по которым внешней системе разрешена подписка на раскрытие.
Внешняя система может получать файлы, с соответствующим идентификатором, текущих
анкет домов, которые в управлении организации, по которым разрешена подписка.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 116).
Таблица 116 – Входные параметры метода GetFileByID
Категория
Параметр
Тип
Max
символов
113
Обязател
ьность
Описание
GetFileByI
DIn
file_id
Идентификатор файла
Да
bigint
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 117).
Таблица 117– Выходные параметры метода GetFileByID
Категория
GetFileByI
DOut
SoapFault
Параметр
Тип
Max
символов
Обязател
ьность
Описание
file
FileObject
Файл. (Описано в
Таблица 101)
code
name
description
integer
text
text
Код результата запроса
Наименование
Описание
Таблица 118 – Описание типа 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"
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"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
114
<faultstring>Mandatory field is null</faultstring>
<detail xsi:type="ns1:ErrorDetails">
<code>1009</code>
<name>Mandatory field is null</name>
<description>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 119 – Результаты вызова метода GetFileByID
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
Unauthorized
Неавторизованный запрос
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1035
Missing file
Файл с указанным идентификатором не
найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
401
5.19 Метод SetFileDeleted
1) Описание метода
Метод удаления файла с соответствующим идентификатором. Внешняя система
может удалять файлы из текущей/архивной анкеты только тех организаций, по которым
внешней системе разрешена подписка на раскрытие. Внешняя система может удалять
файлы из текущей анкеты домов, которые в управлении организации, по которым
разрешена подписка.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 120).
Таблица 120 – Входные параметры метода SetFileDeleted
Категория
Параметр
Тип
Max
символов
115
Обязател
ьность
Описание
Категория
SetFileDele
tedIn
Параметр
file_id
Тип
Max
символов
bigint
Обязател
ьность
Да
Описание
Идентификатор файла
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 121).
Таблица 121– Выходные параметры метода SetFileDeleted
Категория
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:SetFileDeleted
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<file_id xsi:type="xsd:int">?</file_id>
</api:SetFileDeleted>
</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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
116
5) Ошибки
Таблица 122 – Результаты вызова метода SetFileDeleted
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже.
1035
Missing file
Файл с указанным идентификатором не
найден
1005
INN wasn’t found
Управляющая организация с
указанным ИНН не найдена
1021
No permissions
У внешней системы нет разрешения на
раскрытие данных от управляющей
организации
1007
Missing reporting period
Отчетный период с указанным
идентификатором не найден
1004
House wasn’t found
Дом с указанным идентификатором не
найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.20
Метод GetCompanyProfile
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
с соответствующим ИНН за указанный отчетный период.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 123).
Таблица 123 – Входные параметры метода GetCompanyProfile
Категория
Параметр
GetCompan inn
yProfileIn
reporting_per
iods_id
Тип
character
varying
bigint
Max
Обязател
символов
ьность
12
Да
Да
117
Описание
ИНН управляющей
организации
Идентификатор
отчетного периода
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 124).
Таблица 124– Выходные параметры метода GetCompanyProfile
Категория
Параметр
GetCompan
yProfileOut
GetCompany
ProfileRespo
nse
Тип
Max
символов
Обязател
ьность
Да
Описание
Массив данных
(Описано в Таблице
Таблица 130)
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-beta.reformagkh.ru/api">
<soapenv:Header>
<authenticate>mla4954hknhrftqrobbaufdq42</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<inn xsi:type="xsd:string">7018007264</inn>
<reporting_period_id xsi:type="xsd:int">8</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"
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
118
Таблица 125 – Результаты вызова метода GetCompanyProfile
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
Анкета управляющей организации за
указанный отчетный период не найдена
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.21 Метод GetHouseProfile
1) Описание метода
Метод
получения
данных
анкеты
(текущей)
дома
с
соответствующим
идентификатором дома.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 126).
Таблица 126 – Входные параметры метода GetHouseProfile
Категория
GetHouseP
rofileIn
Параметр
house_id
Тип
Max
символов
bigint
Обязател
ьность
Да
Описание
Идентификатор дома
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 127).
119
Таблица 127– Выходные параметры метода GetHouseProfile
Категор
Параметр
ия
GetHous data
eProfileR
esponse
full_address
Тип
Max
символов
HouseProfile
Data
Обязательн
ость
Да
FullAddress
Да
stage
HouseStageEn
um
Да
inn
character
varying
12
Описание
Массив данных
(Описано в
Таблица 60)
Адрес дома
(Описано в
Таблица 50)
Идентификатор
стадии
жизненного
цикла дома
(Описано в
Таблица 62)
ИНН текущей
организации, в
управлении
которой
находится дом
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-beta.reformagkh.ru/api">
<soapenv:Header>
<authenticate>mla4954hknhrftqrobbaufdq42</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfile
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<house_id xsi:type="xsd:int">8951041</house_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"
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
120
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 128 – Результаты вызова метода GetHouseProfile
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
500
House wasn’t found
1004
Дом с указанным идентификатором не
найден
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
5.22 Метод GetCompanyProfileSF
1) Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации
по указанному субъекту федерации за указанный отчетный период. Чтение данных
постраничное, на одной странице передаются 100 анкет организаций.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 129).
Таблица 129 – Входные параметры метода GetCompanyProfileSF
Категория
Параметр
GetCompan region_id
yProfileSFI
n
page_number
reporting_per
Тип
character
varying
Max
Обязател
символов
ьность
Да
255
integer
integer
121
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
Идентификатор
Категория
Параметр
Тип
Max
символов
Обязател
ьность
Описание
отчетного периода
iod_id
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 130).
Таблица 130– Выходные параметры метода GetCompanyProfileSF
Категория
GetCompan
yProfileRes
ponse
Параметр
data
inn
Тип
CompanyPr
ofileData
character
varying
Max
символов
Обязател
ьность
Да
Да
12
Описание
Массив данных
(Описано в Таблица 18)
ИНН
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-beta.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"
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
122
5) Ошибки
Таблица 131 – Результаты вызова метода 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
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
123
5.23 Метод GetHouseProfileSF
1) Описание метода
Метод получения данных анкеты (текущей) дома по указанному субъекту
федерации. Чтение данных постраничное, на одной странице передаются 100 анкет домов.
2) Входные данные
В таблице представлены входные параметры метода (Таблица 132).
Таблица 132 – Входные параметры метода GetHouseProfileSF
Категория
GetHouseP
rofileSFIn
Параметр
Тип
region_id
character
varying
page_number
integer
Max
Обязател
символов
ьность
Да
255
Описание
Уникальный
идентификатор региона
(GUID из ФИАС)
Номер страницы. По
умолчанию, будет
возвращаться первая
страница.
3) Выходные параметры
В таблице представлены выходные параметры метода (Таблица 133).
Таблица 133– Выходные параметры метода GetHouseProfileSF
Категор
Параметр
ия
GetHous data
eProfileR
esponse
full_address
Тип
Max
символов
HouseProfile
Data
Обязательн
ость
Да
FullAddress
Да
stage
HouseStageEn
um
Да
inn
character
varying
house_id
bigint
12
Да
4) Пример вызова метода
124
Описание
Массив данных
(Описано в
Таблица 60)
Адрес дома
(Описано в
Таблица 50)
Идентификатор
стадии
жизненного
цикла дома
(Описано в
Таблица 62)
ИНН текущей
организации, в
управлении
которой
находится дом
Идентификатор
дома
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-beta.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>
<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"
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>Обязательное поле «НАЗВАНИЕ ПОЛЯ» не
заполнено</description>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Отсутствие SoapFault означает успешное выполнение запроса.
5) Ошибки
Таблица 134 – Результаты вызова метода GetHouseProfileSF
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Нет прав на выполнение запроса
500
Internal Server Error
Внутренняя ошибка сервера. Сервер
неспособен выполнить запрос.
Попробуйте обратиться позже
1037
Missing region
Субъект федерации с указанным
идентификатором не найден
125
1038
Page wasnt found
Страница с указанным номером не
найдена
1017
No permission to access
Нет доступа на чтение по указанному
Субъекту Федерации
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" is not valid
Поле «НАЗВАНИЕ ПОЛЯ» заполнено
не верно
126
СОСТАВ ПОКАЗАТЕЛЕЙ АНКЕТ, КОТОРЫЕ НЕ МОГУТ
6
ПРИНИМАТЬ ЗНАЧЕНИЕ «0»
В Таблица 135 представлены показатели анкеты управляющей организации,
которые не могут принимать значение «0».
Таблица 135 – Состав показателей анкеты управляющей организации
Наименование в wsdl
документе
Наименование поля
Группа показателей «Реквизиты»
Организационная форма
okopf
ИНН
inn
Юридический адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Фактический адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Почтовый адрес (редактирование в
дополнительном модальном окне)
Населенный пункт
city_id
Улица
street_id
Группа показателей «Сведения о
государственной регистрации»
ОГРН или ОГРНИП
ogrn
Дата присвоения ОГРН (ОГРНИП)
date_assignment_ogrn
Раздел «Общие сведения об
организации»
Количество субъектов РФ
srf_count
Количество муниципальных образований
mo_count
Количество офисов
offices_count
В тТаблица 135 представлены показатели анкеты многоквартирного дома, которые
не могут принимать значение «0».
Таблица 136 – Состав показателей анкеты многоквартирного дома
Наименование в wsdl
документе
Наименование поля
Раздел «Общая характеристика»
127
Тип жилого дома
house_type
Состояние дома
state
Дата начала приватизации
privatization_start_date
Материал стен
wall_material
Тип перекрытий
floor_type
Этажность
storeys_count
Количество подъездов
entrance_count
Группа показателей «Удельная
тепловая характеристика здания»
Класс энергоэффективности здания
Дата проведения энергетического аудита
energy_efficiency
energy_audit_date
Группа показателей «Подвал»
Сведения о подвале
basement_stage
Группа показателей «Система
отопления»
Система отопления
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
горячего водоснабжения»
Система горячего водоснабжения
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
холодного водоснабжения»
Система холодного водоснабжения
Отпуск ресурсов производится
system_name
provisioning
Группа показателей «Система
канализации»
Система водоотведения (канализации)
system_name
Группа показателей «Система
электроснабжения»
Система электроснабжения
system_name
128
Отпуск ресурсов производится
provisioning
Группа показателей «Система
газоснабжения»
Вид системы газоснабжения
Отпуск ресурсов производится
system_name
provisioning
Раздел «Лифты»
Номер подъезда
porch_number
Количество остановок
stops_count
Грузоподъемность
capacity
Плановый срок замены (вывода из
эксплуатации)
plan_period
Раздел «Управление»
Тип договора
contract_type
Дата начала обслуживания дома по
договору управления
date_start
Плановая дата завершения обслуживания:
plan_date_stop
Раздел «Поставщики услуг»
ИНН
Inn
129
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>
Таблица 137 – Список ошибок
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
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
external system
Пользователь не соответствует
внешней системе
1007
Missing reporting period
Отчетный период с указанным
130
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
идентификатором не найден
1008
House is managed by any
organization
Дом не в управлении
1009
Mandatory field is null
Обязательное поле «НАЗВАНИЕ
ПОЛЯ» не заполнено
1010
Field "NAME" 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
Файл с таким расширение не допустим
к загрузке
1023
File Size Limit Exceeded
Размер загружаемого файла превышает
15MB
131
Code
(Код результата
запроса)
Name
(Наименование)
Description
(Описание)
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-сервис доступен с 18:00 до 23:45
по будням и с 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 wasnt found
Страница с указанным номером не
найдена
132
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 выполняется, когда осуществляется запись данных.
ИНН
–
идентификационный
номер
налогоплательщик
Цифровой
код,
упорядочивающий учёт налогоплательщиков в Российской Федерации.
ФИАС - федеральная информационная адресная система. Классификатор содержит
адресные элементы и историю их изменения: регионы, районы, города, городские округа,
населенные пункты, улицы, дома.
ЖКХ - жилищно-коммунальное хозяйство. Комплекс отраслей экономики,
обеспечивающий функционирование инженерной инфраструктуры различных зданий в
населённых пунктах, создающий удобства и комфортабельность проживания и
нахождения в них людей путём предоставления им широкого спектра услуг.
ТСЖ – товарищество собственников жилья. Юридическое лицо, некоммерческая
организация,
созданная
на
основе
объединения
собственников
помещений
многоквартирного дома или собственников соседних участков с жилыми строениями
(домами) для совместного управления теми помещениями этого дома и землями, которые
находятся в совместном владении и пользовании, а также для ведения хозяйственной
деятельности в таком доме и на земле, находящейся в совместном владении, в форме
эксплуатации общего имущества, строительства дополнительных помещений и объектов
133
общего имущества, а также сдачи в аренду, внаём части общего имущества в
многоквартирном доме или общего земельного участка.
ЖСК - жилищно-строительный кооператив (жилищный кооператив). Объединение
людей или организаций, с целью строительства жилья, а также для управления жильем.
ОКОПФ – общероссийский классификатор организационно-правовых форм. В
классификаторе каждой организационно-правовой форме соответствует двухразрядный
цифровой код.
GUID
(Globally
Unique
Identifier)
статистически
уникальный
128-битный
идентификатор. Его главная особенность — уникальность, которая позволяет создавать
расширяемые сервисы и приложения без опасения конфликтов, вызванных совпадением
идентификаторов.
134
1/--страниц
Пожаловаться на содержимое документа