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

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

Метод добавления нового дома с соответствующим адресом по ФИАС (GUID). Внешняя система на вход подает GUID улицы, если дом без улицы, то на вход подается GUID населенного пункта. Проверка существования дома с указанным адресом.

 

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetNewHouseIn	address	FiasAddress		Да	Адрес дома (GUID по ФИАС) (Описано в Таблица 19)
	state	HouseStateEnum		Да	Признак состояния дома (возможные значения в Таблица 61)

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetNewHouseOut	house_id	integer			Идентификатор дома
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: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:

<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 – Результаты вызова метода SetNewHouse

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже.
1014	Missing city	Населенный пункт с указанным идентификатором не найден
1015	Missing street	Улица с указанным идентификатором не найдена
1018	House is already exist	Дом с указанным адресом уже существует
1009	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1010	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно

 

Метод GetHouseInfo

 

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

Метод получения идентификатора дома с соответствующим адресом по ФИАС. По одному адресу может быть несколько домов, например, снесенные. Возвращаем все дома.

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

 

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
GetHouseInfo	fias_address	FiasAddress			Адрес дома по ФИАС (Описано в Таблица 19)

 

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
HouseInfo	house_id	integer		Да	Идентификатор дома
	full_address	FullAddress			Адрес дома (Описано в Таблица 50)
	inn	character varying	12		ИНН текущей организации, в управлении которой находится дом
	state	HouseStateEnum		Да	Идентификатор состояния (Описано в Таблица 61)
	stage	HouseStageEnum		Да	Идентификатор стадия жизненного цикла дома (Описано в Таблица 62)
	is_drifting_from	date			Дата сноса дома. Дата возвращается, только когда стадия дома «снесен»
SoapFault	code	integer			Код результата запроса
	name	text			Наименование
	description	text			Описание

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

SOAP-запрос:

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

<soapenv:Header>

<authenticate>ev4sin4te6anc6949udv23n482</authenticate>

</soapenv:Header>

<soapenv:Body>

<api:GetHouseInfo>

    <address>

       <!--You may enter the following 6 items in any order-->

       <city_id>?</city_id>

       <street_id>?</street_id>

       <house_number>?</house_number>

       <building>?</building>

       <block>?</block>

       <room_number>?</room_number>

    </address>

</api:GetHouseInfo>

</soapenv:Body>

</soapenv:Envelope>

 

SoapFault:

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

 <SOAP-ENV:Body>

<SOAP-ENV:Fault>

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

  <faultstring>Mandatory field is null</faultstring>

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

     <code>1009</code>

     <name>Mandatory field is null</name>

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

  </detail>

</SOAP-ENV:Fault>

 </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

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

Ошибки

Таблица 98 – Результаты вызова метода GetHouseInfo

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже
1014	Missing city	Населенный пункт с указанным идентификатором не найден
1015	Missing street	Улица с указанным идентификатором не найдена
1033	House wasn’t found	Дом с указанным адресом не найден
1009	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1010	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно