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

 

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

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

 

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
GetFilesInfoFromCompanyProfileIn	inn	character varying	12	Да	ИНН управляющей организации
	reporting_period_id	bigint		Да	Идентификатор отчетного периода
	profile_part_id	integer			Идентификатор раздела, к которому относится файл (список названий разделов описан в Таблица 109) Есть возможность запросить файлы нескольких разделов, для этого передаем список идентификаторов разделов. При запросе всех файлов анкеты значения для данного параметра указываем NULL

Таблица 109– Разделы анкеты управляющей организации

Идентификатор	Значение	Название раздела
1	prosecute_documents_copies	Overview (Копии документов о применении мер административного воздействия, а также мер, принятых для устранения нарушений, повлекших применение административных санкций)
2	additional_files	Overview (Дополнительная информация)
3	annual_financial_statements	financial_indicators (Годовая бухгалтерская отчетность)
4	revenues_expenditures_estimates	financial_indicators (Сметы доходов и расходов ТСЖ или ЖСК)
5	performance_report	financial_indicators (Отчет о выполнении сметы доходов и расходов)
6	general_meetings_protocol	financial_indicators (Протоколы общих собраний членов товарищества или кооператива, заседаний правления и ревизионной комиссии)
7	audit_commision_report	financial_indicators (Заключения ревизионной комиссии (ревизора) товарищества или кооператива по результатам проверки годовой бухгалтерской (финансовой) отчетности)
8	audit_reports	financial_indicators (Аудиторские заключения)
9	management_contract	management_activities (Проект договора управления)
10	services_cost	management_activities (Стоимость услуг)
11	tariffs	management_activities (Тарифы)

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
FileInfo	file_id	bigint		Да	Идентификатор файла
	name	character varying	255	Да	Название файла
	extension	character varying	255	Да	Расширение файла
	size	integer			Размер файла
	create_date	date		Да	Дата добавления файла в анкету
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: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>

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

Ошибки

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