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

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

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

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetUnlinkFromOrganizationIn	house_id	bigint		Да	Идентификатор дома
	date_stop	date		При stop_reason_type =1, поле обязательно	Дата прекращения обслуживания
	stop_reason_type	ContractStopReasonEnum		Да	Основание прекращения обслуживания (Описано в Таблица 53)
	stop_reason	text		При stop_reason_type =1, поле обязательно	Причина завершения обслуживания

 

 

Таблица 53– Возможные значения ContractStopReasonEnum

Тип	Идентификатор	Значения
ContractStopReasonEnum	1	finished contract (Действие договора обслуживания прекращено)
	2	added by error (Дом был включен в список по ошибке)

 

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

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

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

Категория	Параметр	Тип	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: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 означает успешное выполнение запроса.

 

Ошибки

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

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже.
1004	House wasn’t found	Дом с указанным идентификатором не найден
1011	House is not in company	Дом, находится в управлении другой организации «ИНН, НАЗВАНИЕ», по которой нет подписки
1036	House unlinked already	Управление домом уже прекращено
1005	INN wasn’t found	Управляющая организация с указанным ИНН не найдена
1013	Missing management date	Не заполнена дата начала управления домом. Прежде чем прекратить управление домом, Вам необходимо заполнить дату начала управления с помощью метода SetHouseProfile.
1009	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1010	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно

 

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

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

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

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetHouseLinkToOrganizationIn	house_id	bigint		Да	Идентификатор дома
	inn	character varying	12	Да	ИНН управляющей организации
	date_start	date		Да	Дата начала управления
	plan_date_stop	date			Плановая дата прекращения управления домом

 

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

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

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

Категория	Параметр	Тип	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: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 означает успешное выполнение запроса.

 

Ошибки

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