Механическое удерживание земляных масс: Механическое удерживание земляных масс на склоне обеспечивают контрфорсными сооружениями различных конструкций...
Археология об основании Рима: Новые раскопки проясняют и такой острый дискуссионный вопрос, как дата самого возникновения Рима...
Топ:
Характеристика АТП и сварочно-жестяницкого участка: Транспорт в настоящее время является одной из важнейших отраслей народного...
История развития методов оптимизации: теорема Куна-Таккера, метод Лагранжа, роль выпуклости в оптимизации...
Особенности труда и отдыха в условиях низких температур: К работам при низких температурах на открытом воздухе и в не отапливаемых помещениях допускаются лица не моложе 18 лет, прошедшие...
Интересное:
Распространение рака на другие отдаленные от желудка органы: Характерных симптомов рака желудка не существует. Выраженные симптомы появляются, когда опухоль...
Отражение на счетах бухгалтерского учета процесса приобретения: Процесс заготовления представляет систему экономических событий, включающих приобретение организацией у поставщиков сырья...
Влияние предпринимательской среды на эффективное функционирование предприятия: Предпринимательская среда – это совокупность внешних и внутренних факторов, оказывающих влияние на функционирование фирмы...
Дисциплины:
 2021-10-05 |
 32 |
из
5.00
|
Заказать работу |
|
|
|
|
Описание метода
Метод удаления файла с соответствующим идентификатором. Внешняя система может удалять файлы из текущей/архивной анкеты только тех организаций, по которым внешней системе разрешена подписка на раскрытие. Внешняя система может удалять файлы из текущей анкеты домов, которые в управлении организации, по которым разрешена подписка.
Входные данные
В таблице представлены входные параметры метода (Таблица 120).
Таблица 120 – Входные параметры метода SetFileDeleted
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| SetFileDeletedIn | file_id | bigint | Да | Идентификатор файла |
Выходные параметры
В таблице представлены выходные параметры метода (Таблица 121).
Таблица 121– Выходные параметры метода SetFileDeleted
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| 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:SetFileDeleted soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<file_id xsi:type="xsd:int">?</file_id>
</api:SetFileDeleted>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 122 – Результаты вызова метода SetFileDeleted
| Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
| 401 | Unauthorized | Неавторизованный запрос |
| 403 | Forbidden | Нет прав на выполнение запроса |
| 500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже. |
| 1035 | Missing file | Файл с указанным идентификатором не найден |
| 1005 | INN wasn’t found | Управляющая организация с указанным ИНН не найдена |
| 1021 | No permissions | У внешней системы нет разрешения на раскрытие данных от управляющей организации |
| 1007 | Missing reporting period | Отчетный период с указанным идентификатором не найден |
| 1004 | House wasn’t found | Дом с указанным идентификатором не найден |
| 1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
| 1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
Метод GetCompanyProfile
Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации с соответствующим ИНН за указанный отчетный период.
Входные данные
В таблице представлены входные параметры метода (Таблица 123).
Таблица 123 – Входные параметры метода GetCompanyProfile
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetCompanyProfileIn | inn | character varying | 12 | Да | ИНН управляющей организации |
| reporting_period_id | bigint | Да | Идентификатор отчетного периода |
Выходные параметры
В таблице представлены выходные параметры метода (Таблица 124).
Таблица 124– Выходные параметры метода GetCompanyProfile
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetCompanyProfileOut | GetCompanyProfileResponse | Да | Массив данных (Описано в Таблица 125) |
Таблица 125–Параметры GetCompanyProfileResponse
| Категория | Параметр | Тип | Max символов | Обязательность | Описание | |
| GetCompanyProfileResponse
| company_profile_data | CompanyProfileData | Да | Массив данных (Описано в Таблица 18) | ||
| inn | character varying | 12 | Да | ИНН | ||
| name_full | character varying | Да | Полное наименование юридического лица | |||
| name_short | character varying | Да | Краткое наименование юридического лица |
Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>4be5tmhhmrla5nsuf4depd5o91</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfile>
<inn>?</inn>
<reporting_period_id>?</reporting_period_id>
</api:GetCompanyProfile>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 126 – Результаты вызова метода G etCompanyProfile
| Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
| 401 | Unauthorized | Неавторизованный запрос |
| 403 | Forbidden | Нет прав на выполнение запроса |
| 500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже. |
| 1007 | Missing reporting period | Отчетный период с указанным идентификатором не найден |
| 1005 | INN wasnt found | Управляющая организация с указанным ИНН не найдена |
| 1027 | Missing company profile in this reporting period | Анкета управляющей организации за указанный отчетный период не найдена |
| 1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
| 1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
Метод GetHouseProfile
Описание метода
Метод получения данных анкеты (текущей/архивной) дома с соответствующим идентификатором дома.
Входные данные
В таблице представлены входные параметры метода (Таблица 127).
Таблица 127 – Входные параметры метода GetHouseProfile
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetHouseProfileIn | house_id | bigint | Да | Идентификатор дома | |
| reporting_period_id | bigint | Да | Идентификатор отчетного периода |
Выходные параметры
|
|
GetHouseProfileOut вызывает массив данных GetHouseProfileResponse (описано в Таблица 128).
Таблица 128 – Выходные параметры метода GetHouseProfile
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetHouseProfileResponse | house_profile_data | HouseProfileData | Да | Массив данных (Описано в Таблица 60) | |
| full_address | FullAddress | Да | Адрес дома (Описано в Таблица 50) | ||
| stage | HouseStageEnum | Да | Идентификатор стадии жизненного цикла дома (Описано в Таблица 62) | ||
| inn | character varying | 12 | ИНН текущей организации, в управлении которой находится дом |
Пример вызова метода
SOAP-запрос:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.reformagkh.ru/api_document_literal">
<soapenv:Header>
<authenticate>tmkoa8v8thbrnkuqlnope5b8c7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfile>
<house_id>?</house_id>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
</api:GetHouseProfile>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 129 – Результаты вызова метода GetHouseProfile
| Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
| 401 | Unauthorized | Неавторизованный запрос |
| 403 | Forbidden | Нет прав на выполнение запроса |
| 500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже |
| 1004 | House wasn’t found | Дом с указанным идентификатором не найден |
| 1007 | Missing reporting period | Отчетный период с указанным идентификатором не найден |
| 1040 | Missing house profile in this reporting period | Анкета дома за указанный отчетный период не найдена |
| 1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
| 1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
|
|
Метод GetCompanyProfileSF
Описание метода
Метод получения данных анкеты (текущей и архивной) управляющей организации по указанному субъекту федерации за указанный отчетный период. Чтение данных постраничное, на одной странице передаются 100 анкет организаций.
Входные данные
В таблице представлены входные параметры метода (Таблица 130).
Таблица 130 – Входные параметры метода GetCompanyProfileSF
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetCompanyProfileSFIn | region_id | character varying | 255 | Да | Уникальный идентификатор региона (GUID из ФИАС) |
| page_number | integer | Номер страницы. По умолчанию, будет возвращаться первая страница. | |||
| reporting_period_id | integer | Идентификатор отчетного периода |
Выходные параметры
В таблице представлены выходные параметры метода (Таблица 131).
Таблица 131– Выходные параметры метода GetCompanyProfileSF
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetCompanyProfileSFResponse | data | ArrayOfGetCompanyProfileResponse | Да | Массив данных | |
| page_number | integer | Да | Номер страницы | ||
| page_count | integer | Да | Количество страниц |
Массив данных ArrayOfGetCompanyProfileResponse вызывает GetCompanyProfileResponse (Описано в Таблица 125).
Пример вызова метода
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>gpj0kj0ds4j71vlr6hcmkcgva7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetCompanyProfileSF soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<region_id xsi:type="xsd:string">0c089b04-099e-4e0e-955a-6bf1ce525f1a</region_id>
<page_number xsi:type="xsd:int"></page_number>
<reporting_period_id xsi:type="xsd:int">8</reporting_period_id>
</api:GetCompanyProfileSF>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 132 – Результаты вызова метода G etCompanyProfile SF
| Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
| 401 | Unauthorized | Неавторизованный запрос |
| 403 | Forbidden | Нет прав на выполнение запроса |
| 500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже. |
| 1037 | Missing region | Субъект федерации с указанным идентификатором не найден |
| 1038 | Page wasnt found | Страница с указанным номером не найдена |
| 1017 | No permission to access | Нет доступа на чтение по указанному Субъекту Федерации |
| 1007 | Missing reporting period | Отчетный период с указанным идентификатором не найден |
| 1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
| 1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
Метод GetHouseProfileSF
|
|
Описание метода
Метод получения данных анкеты (текущей/архивной) дома по указанному субъекту федерации. Чтение данных постраничное, на одной странице передаются 100 анкет домов.
Входные данные
В таблице представлены входные параметры метода (Таблица 133).
Таблица 133 – Входные параметры метода GetHouseProfileSF
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetHouseProfileSFIn | region_id | character varying | 255 | Да | Уникальный идентификатор региона (GUID из ФИАС) |
| reporting_period_id | bigint | Да | Идентификатор отчетного периода | ||
| page_number | integer | Номер страницы. По умолчанию, будет возвращаться первая страница. |
Выходные параметры
GetHouseProfileSFOut вызывает GetHouseProfileSFResponse (описано в Таблица 134).
Таблица 134– Выходные параметры метода GetHouseProfileSF
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetHouseProfileSFResponse | data | ArrayOfGetHouseProfileResponse | Да | Массив данных (Описано в Таблица 128). | |
| page_number | integer | Да | Номер страницы | ||
| page_count | integer | Да | Количество страниц |
Массив данных ArrayOfGetHouseProfileResponse вызывает GeHouseProfileResponse (Описано в Таблица 135).
Таблица 135 – Параметры GetHouseProfileResponse
| Категория | Параметр | Тип | Max символов | Обязательность | Описание |
| GetHouseProfileResponse | house_profile_data | HouseProfileData | Да | Массив данных (Описано в Таблица 60) | |
| full_address | FullAddress | Да | Адрес дома (Описано в Таблица 50) | ||
| stage | HouseStageEnum | Да | Идентификатор стадии жизненного цикла дома (Описано в Таблица 62) | ||
| inn | character varying | 12 | ИНН текущей организации, в управлении которой находится дом | ||
| house_id | bigint | Да | Идентификатор дома |
Пример вызова метода
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>gpj0kj0ds4j71vlr6hcmkcgva7</authenticate>
</soapenv:Header>
<soapenv:Body>
<api:GetHouseProfileSF soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<region_id xsi:type="xsd:string">0c089b04-099e-4e0e-955a-6bf1ce525f1a</region_id>
<reporting_period_id xsi:type="xsd:int">?</reporting_period_id>
<page_number xsi:type="xsd:int"></page_number>
</api:GetHouseProfileSF>
</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 означает успешное выполнение запроса.
Ошибки
Таблица 136 – Результаты вызова метода GetHouseProfile SF
| Code (Код результата запроса) | Name (Наименование) | Description (Описание) |
| 401 | Unauthorized | Неавторизованный запрос |
| 403 | Forbidden | Нет прав на выполнение запроса |
| 500 | Internal Server Error | Внутренняя ошибка сервера. Сервер неспособен выполнить запрос. Попробуйте обратиться позже |
| 1037 | Missing region | Субъект федерации с указанным идентификатором не найден |
| 1007 | Missing reporting period | Отчетный период с указанным идентификатором не найден |
| 1040 | Missing house profile in this reporting period | Анкета дома за указанный отчетный период не найдена |
| 1038 | Page wasnt found | Страница с указанным номером не найдена |
| 1017 | No permission to access | Нет доступа на чтение по указанному Субъекту Федерации |
| 1009 | Mandatory field is null | Обязательное поле «НАЗВАНИЕ ПОЛЯ» не заполнено |
| 1010 | Field "NAME" is not valid | Поле «НАЗВАНИЕ ПОЛЯ» заполнено не верно |
|
|
|
Двойное оплодотворение у цветковых растений: Оплодотворение - это процесс слияния мужской и женской половых клеток с образованием зиготы...
Механическое удерживание земляных масс: Механическое удерживание земляных масс на склоне обеспечивают контрфорсными сооружениями различных конструкций...
Состав сооружений: решетки и песколовки: Решетки – это первое устройство в схеме очистных сооружений. Они представляют...
Биохимия спиртового брожения: Основу технологии получения пива составляет спиртовое брожение, - при котором сахар превращается...
© cyberpedia.su 2017-2024 - Не является автором материалов. Исключительное право сохранено за автором текста.
Если вы не хотите, чтобы данный материал был у нас на сайте, перейдите по ссылке: Нарушение авторских прав. Мы поможем в написании вашей работы!