Метод SetNewCompany – В разработке

Описание метода

Метод подачи запроса на регистрацию новой управляющей организации. Подтверждение регистрации управляющей организации производит модератор Фонда согласно регламенту.

 

Входные данные

В таблице представлены входные параметры метода (Таблица 44).

Таблица 44 – Входные параметры метода SetNewCompany

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetNewCompanyIn	inn	character varying	12	Да	ИНН
	NewCompanyData	NewCompanyProfileData		Да	Массив данных. (Описано в Таблица 45)

Описание типа NewCompanyProfileData:

Таблица 45– Массив данных (NewCompanyProfileData) метода SetNewCompany

Категория	Параметр	Тип	Max символов	Обязательность	Описание
NewCompanyProfileData	name_full	character varying	255	Да	Полное наименование
	name_short	character varying	255	Да	Краткое наименование
	okopf	Okopf		Да	ОКОПФ. Передается код всероссийского справочника ОКОПФ в формате «2 80 17». (Описано в Таблица 41)
	surname	character varying	255	Да	Фамилия
	middlename	character varying	255	Да	Отчество
	firstname	character varying	255	Да	Имя
	position	character varying	255	Да	Должность
	ogrn	character varying	255		ОГРН
	date_assignment_ogrn	date			Дата регистрации
	name_authority_assigning_ogrn	text			Наименование органа, принявшего решение о регистрации
	legal_address	FiasAddress		Да	Идентификатор юридического адреса (Описано в Таблица 19)
	actual_address	FiasAddress		Да	Идентификатор фактического адреса (Описано в Таблица 19)
	post_address	FiasAddress		Да	Идентификатор почтового адреса (Описано в Таблица 19)
	phone	text	255	Да	Телефон
	email	character varying	255		Электронный адрес. Формат: example@mail.ru.
	site	text	2500		Интернет сайт
	proportion_sf	decimal	15.2		Доля участия в уставном капитале Субъекта РФ, %
	proportion_mo	decimal	15.2		Доля участия в уставном капитале муниципального образования, %

Выходные параметры

В таблице представлены выходные параметры метода (Таблица 46).

Таблица 46– Выходные параметры метода SetNewCompany

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SoapFault	code	integer			Код результата запроса
	name	text			Наименование
	description	text			Описание

Пример вызова метода

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>

      <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_document_literal" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

    <faultcode>SOAP-ENV:Client</faultcode>

    <faultstring>Mandatory field is null</faultstring>

    <detail xsi:type="ns1:ErrorDetails">

       <code>1009</code>

       <name>Mandatory field is null</name>

       <description>Обязательное поле «sessionId» не заполнено</description>

    </detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Отсутствие SoapFault означает успешное выполнение запроса.

Ошибки

Таблица 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	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1010	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно

 

Метод GetHouseList

Описание метода

Метод получения списка домов, находящихся в управлении организации с соответствующим ИНН (по каждому дому возвращается идентификатор дома и адрес по ФИАС). Внешняя система может получать список домов в управлении организаций, по которым разрешена подписка.

В результате запроса получения списка домов в управлении API - сервис может вернуть несколько домов с одинаковым адресом. Внешняя система вправе раскрывать информацию как по всем своим домам-дублям также и по одному из домов.

Необходимо прекратить управление домами, которым внешняя система не нашла соответствия в своей системе.

 

Входные данные

В таблице представлены входные параметры метода (Таблица 48).

Таблица 48 – Входные параметры метода GetHouseList

Категория	Параметр	Тип	Max символов	Обязательность	Описание
GetHouseList	inn	character varying	12	Да	ИНН

 

Выходные параметры

В таблице представлены выходные параметры метода (Таблица 49).

Таблица 49– Выходные параметры метода GetHouseList

Категория	Параметр	Тип	Max символов	Обязательность	Описание
GetHouseListResponse	house_id	integer			Идентификатор дома
	full_address	FullAddress			Адрес дома (Описано в Таблица 50)
SoapFault	code	integer			Код результата запроса
	name	text			Наименование
	description	text			Описание

Таблица 50– Описание типа FullAddress

Категория	Параметр	Тип	Max символов	Обязательность	Описание
FullAddress	region_id	character varying	36		Идентификатор региона (GUID по ФИАС, aolevel = 1)
	region_formal_name	character varying	120		Формализованное наименование региона (ФИАС)
	region_short_name	character varying	12		Краткое наименование типа региона (ФИАС)
	region_code	character varying	17		Код региона из КЛАДР 4.0.
	area_id	character varying	36		Идентификатор района (GUID по ФИАС, aolevel = 3)
	area_formal_name	character varying	120		Формализованное наименование района (ФИАС)
	area_short_name	character varying	12		Краткое наименование типа района (ФИАС)
	area_code	character varying	17		Код района из КЛАДР 4.0.
	city1_id	character varying	36		Идентификатор города (GUID по ФИАС, aolevel = 4).
	city1_formal_name	character varying	120		Формализованное наименование города (ФИАС)
	city1_short_name	character varying	12		Краткое наименование типа города (ФИАС)
	city1_code	character varying	17		Код города из КЛАДР 4.0.
	city2_id	character varying	36		Идентификатор внутригородской территории (GUID по ФИАС, aolevel = 5).
	city2_formal_name	character varying	120		Формализованное наименование внутригородской территории (ФИАС)
	city2_short_name	character varying	12		Краткое наименование внутригородской территории (ФИАС)
	city2_code	character varying	17		Код внутригородской территории из КЛАДР 4.0.
	city3_id	character varying	36		Идентификатор населенного пункта (GUID по ФИАС, aolevel = 6).
	city3_formal_name	character varying	120		Формализованное наименование населенного пункта (ФИАС)
	city3_short_name	character varying	12		Краткое наименование населенного пункта (ФИАС)
	city3_code	character varying	17		Код населенного пункта из КЛАДР 4.0.
	street_id	character varying	36		Идентификатор улицы (GUID по ФИАС, aolevel = 7)
	street_formal_name	character varying	120		Формализованное наименование улицы (ФИАС)
	street_short_name	character varying	12		Краткое наименование типа улицы (ФИАС)
	street_code	character varying	17		Код улицы из КЛАДР 4.0.
	additional_territory	character varying	36		Идентификатор дополнительной территории (GUID по ФИАС, aolevel = 90)
	additional_territory_formal_name	character varying	120		Формализованное наименование дополнительной территории (ФИАС)
	additional_territory_short_name	character varying	12		Краткое наименование типа дополнительной территории (ФИАС)
	additional_territory_code	character varying	17		Код дополнительной территории из КЛАДР 4.0.
	house_number	text			Номер дома
	building	text			Строение
	block	text			Корпус

Пример вызова метода

SOAP-запрос:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.reformagkh.ru/api_document_literal">

<soapenv:Header>

<authenticate>29r2r9ln074jsnigave0pl3ue5</authenticate>

</soapenv:Header>

<soapenv:Body>

<api:GetHouseList>

    <inn>?</inn>

</api:GetHouseList>

</soapenv:Body>

</soapenv:Envelope>

 

SoapFault:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.reformagkh.ru/api_document_literal" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

    <faultcode>SOAP-ENV:Client</faultcode>

    <faultstring>Unauthorized</faultstring>

    <detail xsi:type="ns1:ErrorDetails">

       <code>401</code>

       <name>Unauthorized</name>

       <description>Неавторизованный запрос</description>

    </detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Отсутствие SoapFault означает успешное выполнение запроса.

 

Ошибки

Таблица 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	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно