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

 

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

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

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

 

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

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

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

Категория	Параметр	Тип	Max символов	Обязательность	Описание
SetFileToHouseProfileIn	house_id	bigint		Да	Идентификатор дома
	profile_part_id	ProfilePartsEnum		Да	Идентификатор раздела, к которому относится файл (Возможные значения Таблица 105)
	file	FileObject			Файл. (Описано в Таблица 101)

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

Тип	Идентификатор	Название раздела
ProfilePartsEnum	12	Выполняемые работы
	13	Выполнение обязательств
	14	Стоимость услуг
	15	Средства ТСЖ или ЖСК
	16	Условия оказания услуг ТСЖ или ЖСК
	21	Файлы (акты), которые прикрепляются при смене состояния дома (на состояние «аварийный» и из состояния «аварийный»)

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

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

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

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

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

<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:SetFileToHouseProfile>

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

Ошибки

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

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