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

 

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

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

При условии, что Вы администратор УО подтверждение запроса на раскрытие информации проставиться автоматически.

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetRequestForSubmitIn	inns	character varying	12	Да	На вход передается список ИНН управляющих организаций, с запросом о разрешении раскрытия информации по указанной организации

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetRequestForSubmitInnStatus	inn	character varying	12		ИНН управляющей организации
	status	SetRequestForSubmitInnStatusEnum			Идентификатор статуса запроса внешней системы. (Возможные значения в Таблица 9)
SoapFault	code	integer			Код результата запроса
	name	text			Наименование
	description	text			Описание

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

Тип	Идентификатор	Значения
SetRequestForSubmitInnStatusEnum	0	Success. (Ошибок нет. Заявка подана)
	1	Missing INN
	2	INN is not valid (Указан некорректный ИНН)
	3	Request have been already submitted (Запрос на подписку был уже подан ранее)

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

SOAP-запрос:

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

<soapenv:Header>

<authenticate>o0tnkvsrs9c79hrhmdslqrg3b0</authenticate>

</soapenv:Header>

<soapenv:Body>

<api:SetRequestForSubmit>

    <inns>

       <!--Zero or more repetitions:-->

       <item>7702707386</item>

    </inns>

</api:SetRequestForSubmit>

</soapenv:Body>

</soapenv:Envelope>

 

SoapFault:

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

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

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

    <faultstring>Unauthorized</faultstring>

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

       <code>401</code>

       <name>Unauthorized</name>

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

    </detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

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

Ошибки

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

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже
1011	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1012	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно

 

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

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

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

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
RequestState	inn	character varying	12	Да	ИНН управляющей организации
	date_created	timestamp(0)		Да	Дата подачи запроса внешней системой
	status	RequestStatus		Да	Идентификатор статуса запроса (Возможные значения в Таблица 12)
	update_date	timestamp(0)		Да	Дата обработки заявки
SoapFault	code	integer			Код результата запроса
	name	text			Наименование
	description	text			Описание

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

Тип	Идентификатор	Значения
RequestStatus	1	approved(Заявка подтверждена)
	2	declined(Заявка отклонена)
	3	pending(В ожидании рассмотрения)

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

SOAP-запрос:

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

<soapenv:Header>

<authenticate>nteu389j2k4d76c9p6fl0oal93</authenticate>

</soapenv:Header>

<soapenv:Body>

<api:GetRequestList/>

</soapenv:Body>

</soapenv:Envelope>

 

SoapFault:

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

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

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

    <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 означает успешное выполнение запроса.

Ошибки

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

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже.
1011	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено