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

 

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

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

Допустимые расширения файлов:.odt,.ods,.odp,.doc,.docx,.xls,.xlsx,.ppt,.pptx,.txt,.dat,.jpg,.jpeg,.png,.pdf,.gif,.tif.

Максимальный размер файла: 15Мб.

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetFileToCompanyProfileIn	reporting_period_id	bigint		Да	Идентификатор отчетного периода
	inn	character varying	12	Да	ИНН управляющей организации
	profile_part_id	ProfilePartsEnum		Да	Идентификатор раздела, к которому относится файл (Возможные значения в Таблица 100)
	file	FileObject			Файл. (Описано в Таблица 101)

 

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

Тип	Идентификатор	Название раздела
ProfilePartsEnum	1	Копии документов о применении мер административного воздействия, а также мер, принятых для устранения нарушений, повлекших применение административных санкций
	2	Дополнительная информация
	3	Годовая бухгалтерская отчетность
	4	Сметы доходов и расходов ТСЖ или ЖСК
	5	Отчет о выполнении сметы доходов и расходов
	6	Протоколы общих собраний членов товарищества или кооператива, заседаний правления и ревизионной комиссии
	7	Заключения ревизионной комиссии (ревизора) товарищества или кооператива по результатам проверки годовой бухгалтерской (финансовой) отчетности
	8	Аудиторские заключения
	9	Проект договора управления
	10	Стоимость услуг
	11	Тарифы

 

Таблица 101 – Описание типа FileObject

Категория	Параметр	Тип	Max символов	Обязательность	Описание
FileObject	name	character varying		Да	Название файла
	data	string		Да	Файл. Текст, содержимое зашифровано B64

 

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

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

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

Категория	Параметр	Тип	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:SetFileToCompanyProfile soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

   <reporting_period_id xsi:type="xsd:int">?</reporting_period_id>

   <inn xsi:type="xsd:string">?</inn>

   <profile_part_id xsi:type="xsd:int">?</profile_part_id>

   <file_object xsi:type="api:FileObject">

     <name xsi:type="xsd:string">?</name>

      <data xsi:type="xsd:string">?</data>

   </file_object>

</api:SetFileToCompanyProfile>

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

Ошибки

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

Code (Код результата запроса)	Name (Наименование)	Description (Описание)
401	Unauthorized	Неавторизованный запрос
403	Forbidden	Нет прав на выполнение запроса
500	Internal Server Error	Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже.
1005	INN wasn’t found	Управляющая организация с указанным ИНН не найдена
1020	External system has no request	Внешняя система не подписана на раскрытие данных по управляющей организации
1021	No permissions	У внешней системы нет разрешения на раскрытие данных от управляющей организации
1022	Extension is not valid	Файл с таким расширение не допустим к загрузке
1023	File Size Limit Exceeded	Размер загружаемого файла превышает 15MB
1027	Missing company profile in this reporting period	Анкета управляющей организации за указанный отчетный период не найдена
1028	Part is not in company profile	Указан раздел "ИДЕНТИФИКАТОР РАЗДЕЛА", который не относится к анкете управляющей организации
1009	Mandatory field is null	Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено
1010	Field "NAME" is not valid	Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно