Архитектура электронного правительства: Единая архитектура – это методологический подход при создании системы управления государства, который строится...
Своеобразие русской архитектуры: Основной материал – дерево – быстрота постройки, но недолговечность и необходимость деления...
Топ:
Характеристика АТП и сварочно-жестяницкого участка: Транспорт в настоящее время является одной из важнейших отраслей народного хозяйства...
Генеалогическое древо Султанов Османской империи: Османские правители, вначале, будучи еще бейлербеями Анатолии, женились на дочерях византийских императоров...
Техника безопасности при работе на пароконвектомате: К обслуживанию пароконвектомата допускаются лица, прошедшие технический минимум по эксплуатации оборудования...
Интересное:
Принципы управления денежными потоками: одним из методов контроля за состоянием денежной наличности является...
Уполаживание и террасирование склонов: Если глубина оврага более 5 м необходимо устройство берм. Варианты использования оврагов для градостроительных целей...
Как мы говорим и как мы слушаем: общение можно сравнить с огромным зонтиком, под которым скрыто все...
Дисциплины:
2021-10-05 | 29 |
5.00
из
|
Заказать работу |
|
|
Описание метода
Метод получения списка файлов из заданного раздела текущей анкеты дома с соответствующим идентификатором дома. Внешняя система может получать файлы по текущим анкетам своих домов (дома, находящиеся в управлении организаций, по которым разрешена подписка).
Входные данные
В таблице представлены входные параметры метода (Таблица 112).
Таблица 112 – Входные параметры метода GetFilesInfoFromHouseProfile
Категория | Параметр | Тип | Max символов | Обязательность | Описание |
GetFilesInfoFromHouseProfileIn
| house_id | bigint | Да | Идентификатор дома | |
profile_part_id | integer | Идентификатор раздела, к которому относится файл (список названий разделов описан в Таблица 113) Есть возможность запросить файлы нескольких разделов, для этого передаем список идентификаторов разделов. При запросе всех файлов анкеты значения для данного параметра указываем NULL (<profile_part_id xsi:nil ="true"/>) |
Таблица 113– Разделы анкеты дома
Идентификатор | Значение | Название раздела |
12 | contract_periodic_data | Jobs (Выполняемые работы) |
13 | contract_periodic_data | Responsibility (Выполнение обязательств) |
14 | contract_periodic_data | cost_service (Стоимость услуг) |
15 | contract_periodic_data | resources_tsz_zsk (Средства ТСЖ или ЖСК) |
16 | contract_periodic_data | terms_service_tsz_zsk (Условия оказания услуг ТСЖ или ЖСК) |
21 | mkd_overview | alarm_reason (Файлы (акты), которые прикрепляются при смене состояния дома на состояние «аварийный» и из состояния «аварийный») |
Выходные параметры
В таблице представлены выходные параметры метода (Таблица 114).
Таблица 114– Выходные параметры метода GetFilesInfoFromHouseProfile
Категория | Параметр | Тип | 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:GetFilesInfoFromHouseProfile 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>
</api:GetFilesInfoFromHouseProfile>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 115 – Результаты вызова метода GetFilesInfoFromHouseProfile
Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
401 | Unauthorized | Неавторизованный запрос |
403 | Forbidden | Нет прав на выполнение запроса |
500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже. |
1004 | House wasn’t found | Дом с указанным идентификатором не найден |
1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
Метод GetFileByID – В разработке
Описание метода
Метод получения файла с соответствующим идентификатором. Внешняя система может получать файлы с соответствующим идентификатором из текущей/архивной анкеты организаций, по которым внешней системе разрешена подписка на раскрытие. Внешняя система может получать файлы, с соответствующим идентификатором, текущих анкет домов, которые в управлении организации, по которым разрешена подписка.
|
Входные данные
В таблице представлены входные параметры метода (Таблица 116).
Таблица 116 – Входные параметры метода GetFileByID
Категория | Параметр | Тип | Max символов | Обязательность | Описание |
GetFileByIDIn | file_id | bigint | Да | Идентификатор файла |
Выходные параметры
В таблице представлены выходные параметры метода (Таблица 117).
Таблица 117– Выходные параметры метода GetFileByID
Категория | Параметр | Тип | Max символов | Обязательность | Описание |
GetFileByIDOut | file | FileObject | Файл. (Описано в Таблица 101) | ||
SoapFault | code | integer | Код результата запроса | ||
name | text | Наименование | |||
description | text | Описание |
Таблица 118 – Описание типа FileObject
Категория | Параметр | Тип | Max символов | Обязательность | Описание |
FileObject | name | character varying | Да | Название файла | |
data | string | Да | Файл. Текст, содержимое зашифровано B64 |
Пример вызова метода
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:GetFileByID soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<file_id xsi:type="xsd:int">?</file_id>
</api:GetFileByID>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 119 – Результаты вызова метода GetFileByID
Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
401 | Unauthorized | Неавторизованный запрос |
500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже. |
1035 | Missing file | Файл с указанным идентификатором не найден |
1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
|
|
|
Поперечные профили набережных и береговой полосы: На городских территориях берегоукрепление проектируют с учетом технических и экономических требований, но особое значение придают эстетическим...
Историки об Елизавете Петровне: Елизавета попала между двумя встречными культурными течениями, воспитывалась среди новых европейских веяний и преданий...
Автоматическое растормаживание колес: Тормозные устройства колес предназначены для уменьшения длины пробега и улучшения маневрирования ВС при...
Индивидуальные и групповые автопоилки: для животных. Схемы и конструкции...
© cyberpedia.su 2017-2024 - Не является автором материалов. Исключительное право сохранено за автором текста.
Если вы не хотите, чтобы данный материал был у нас на сайте, перейдите по ссылке: Нарушение авторских прав. Мы поможем в написании вашей работы!