API - документация для разработчиков
Для упрощения процедуры размещения информации на портале ГИС ЖКХ мы предоставляем доступ ко всем функциям API ГИС ЖКХ через RESTful API (обмен данными в JSON-формате или XML-формате через защищённый протокол HTTPS).
Текущая версия API ГИС ЖКХ: 15.4.0.1
Текущая версия API ГИС ЖКХ: 15.4.0.1
Оглавление
- 1. Авторизация
- 2. Формат передачи данных
- 3. Возможные ответы от сервера
-
4. Список методов
-
Договоры управления, уставы и договоры ресурсоснабжения
- Получить договора управления (асинхронно)
- Получить статусы договоров управления (асинхронно)
- Получить договора ресурсоснабжения (асинхронно)
- Получить договора ресурсоснабжения (постранично) (асинхронно)
- Получить объекты договоров ресурсоснабжения (асинхронно)
- Получить объекты договоров ресурсоснабжения (постранично) (асинхронно)
- Получить краткую информацию о договорах ресурсоснабжения (асинхронно)
- Получить список договоров общего имущества (асинхронно)
- Создать сведения о размерах плат за услуги/работы по договору управления (асинхронно)
- Обновить договора управления дома (асинхронно)
- Обновить устав дома (асинхронно)
-
Запросы о наличии задолженности за ЖКУ
- Получить запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)
- Получить подзапросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)
- Создать запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)
- Создать ответы на запросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)
-
Капитальный Ремонт
- Получить счета регионального оператора и специальные счета (асинхронно)
- Получить договора на выполнение работ (оказание услуг) по капитальному ремонту (асинхронно)
- Получить решения/информацию о порядке представления платежных документов (асинхронно)
- Получить информацию о размере фонда (асинхронно)
- Создать/внести изменения в информацию о размере фондов (асинхронно)
- Создать информацию о совершенных операциях и остатках по счетам (асинхронно)
-
Платежные документы
- Получить платёжные документы (асинхронно)
- Получить страховые продукты (асинхронно)
- Получить перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)
- Получить перечень документов «Извещение о принятии к исполнению распоряжения» (постранично) (асинхронно)
- Получить информацию о состоянии расчетов с РСО/ИКУ (асинхронно)
- Создать информацию о состоянии расчетов с ИКУ (асинхронно)
- Создать информацию о состоянии расчетов с РСО (асинхронно)
- Создать перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)
- Создать платёжные документы (асинхронно)
- Cоздать или изменить страховые продукты (асинхронно)
- Создать запрос на квитирование (асинхронно)
- Внести оплаты (асинхронно)
- Отозвать платёжные документы (асинхронно)
- Удалить страховые продукты (асинхронно)
- Отменить квитирование (асинхронно)
- Отменить оплаты (асинхронно)
-
Сервис обмена сведениями о работах и услугах
- Получить тарифы ЖКУ (асинхронно)
- Получить список работ (асинхронно)
- Получить план работ (асинхронно)
- Получить сведения о выполненных работах и услугах (асинхронно)
- Получить информацию об оценке качества работ и услуг (асинхронно)
- Создать/измененить основные сведения по перечню работ (асинхронно)
- Создать актуальные планы по перечню работ/услуг (асинхронно)
- Создать сведения о выполненных работах и услугах (асинхронно)
- Создать информацию об оценке качества работ и услуг (асинхронно)
- Аннулировать основные сведения по перечню работ (асинхронно)
- Отменить основные сведения по перечню работ (асинхронно)
-
Справочники НСИ поставщика информации
- Получить данные справочников поставщика информации (1, 51, 59, 219) (асинхронно)
- Получить данные справочников поставщика информации (постранично) (асинхронно)
- Изменить элементы справочника 1 «Дополнительные услуги» (асинхронно)
- Изменить элементы справочника 51 «Коммунальные услуги» (асинхронно)
- Создание главного коммунального ресурса (ветки) (асинхронно)
- Изменение главного коммунального ресурса (ветки). (асинхронно)
- Удаление главного коммунального ресурса справочника 337 "Коммунальные ресурсы, потребляемые при использовании и содержании общего имущества в многоквартирном доме" (асинхронно)
- Востановление главного коммунального ресурса справочника 337 "Коммунальные ресурсы, потребляемые при использовании и содержании общего имущества в многоквартирном доме" (асинхронно)
- Изменить элементы справочника «Работ и услуг» (асинхронно)
-
Договоры управления, уставы и договоры ресурсоснабжения
Авторизация
Для того, чтобы вызвать любую функцию API РосКвартала, вам необходимо сформировать GET/POST запрос, обязательно используя полученный в личном кабинете API-ключ(Карточка компании). API-ключ можно передавать двумя способами:
-
С помощью HTTP-заголовка Authorization (предпочтительный способ). Для этого в набор HTTP-заголовков запроса вам необходимо добавить
Authorization: xxxxxxxxxxxxxxxxxx, где xxxxxxxxxxxxxxxxxx — ваш API-ключ
-
Передать как один из параметров в строке запроса. Например:
https://api.roskvartal.ru/api/organizations/get?apiKey=xxxxxxxxxxxxxxxxxx, где xxxxxxxxxxxxxxxxxx — ваш API-ключ
Формат передачи данных
- Используется кодировка UTF-8
- При передаче данных в формате XML для перечислений(Enum) необходимо использовать строковые значения
-
В запросах необходимо добавлять HTTP-заголовки
- Для JSON: Accept: application/json и Content-Type: application/json
- Для XML: Accept: application/xml и Content-Type: application/xml
Возможные ответы от сервера
В случае успешного выполнения функции в ответ будет возвращен HTTP-код 200 (OK) или 204 (NoContent). Если запрос по каким-либо причинам не удалось выполнить, то API может вернуть следующие HTTP-коды:
- 400 (Bad Request) — неверно сформированный запрос, обычно эта ошибка связана с опечатками в запросе;
- 401 (Unauthorized) — в запросе не был указан API-ключ;
- 403 (Forbidden) — доступ к выполнению той или иной функции запрещён (для указанного API-ключа);
- 406 (Not Acceptable) — в запросе присутствуют ошибки, которые не может обработать API ГИС ЖКХ;
- 500 (Internal Server Error) — произошла ошибка на сервер по независящим от пользователя причинам, если в течении долгого времени ошибка не проходит, то мы рекомендуем обратиться в нашу службу поддержки.
Ответ с HTTP-кодом 204 (NoContent) придет в случае, когда в ГИС ЖКХ нет объектов для экспорта.
Список методов
-
Договоры управления, уставы и договоры ресурсоснабжения
-
POST: /api/management/getAsync вернуться к оглавлениюПолучить договора управления (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейContractGuid Корневой идентификатор договора (не меняется от версии к версии) string (обязательное) 1 ContractVersionGuid Идентификатор версии договора string (обязательное) 1 CharterGuid Корневой идентификатор устава (не меняется от версии к версии) string (обязательное) 1 CharterVersionGuid Идентификатор версии устава в ГИС ЖКХ string (обязательное) 1 OrgGuid Идентификатор организации на ГИС string (обязательное) 1 ПоследовательностьUoGuid Идентификатор УО в ГИС ЖКХ string (обязательное) 1 FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 SigningDate Дата заключения ДУ string (опциональное) 1 LastVersionOnly Настройка для экспорта только крайней версии ДУ/устава. Если элемент не указан, экспорту подлежат все версии документа boolean (опциональное) 1 КонецКонецОтветПараметр Описание Тип Contract Договор управления FullContractDto Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецCharter Устав FullCharterDto Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонец -
POST: /api/management/status/getAsync вернуться к оглавлениюПолучить статусы договоров управления (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений SearchCriterias Критерии поиска. Не более 100 элементов array[ManagementSearchCriteria] (обязательное) 100 Заполните одно из полейКонецOrgGuid Идентификатор организации на ГИС string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип ContractStatus ContractStatusDto CharterStatus CharterStatusDto -
POST: /api/management/resourceContract/getAsync вернуться к оглавлениюПолучить договора ресурсоснабжения (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейContractGuid Идентификатор версии договора ресурсоснабжения в ГИС ЖКХ string (обязательное) 1000 ContractRootGuid Идентификаторы договоров ресурсоснабжения в ГИС ЖКХ array[string] (обязательное) 1000 ПоследовательностьContractNumber Номер договора string (опциональное) 1 FiasHouseGuid Адрес дома Глобальный уникальный идентификатор дома по ФИАС string (опциональное) 1 ExportContractRootGUID Для установки следующей 1000 договоров постраничного метода (при первичном экспорте не заполняется) string (опциональное) 1 ContractSubject Предмет договора BaseResourceContractSubjectDto (опциональное) 100 SigningDateEnd Дата заключения "По" string (опциональное) 1 SigningDateStart Дата заключения "С" string (опциональное) 1 КонецКонецОтветПараметр Описание Тип ContractGuid Идентификатор версии договора ресурсоснабжения в ГИС ЖКХ string ContractRootGuid Идентификатор договора ресурсоснабжения в ГИС ЖКХ string ContractState Состояние договора string VersionNumber Номер версии договора string VersionStatus Статус версии договора string TerminateDate Дата расторжения, прекращения действия устава string TerminateReason Ссылка на НСИ "54 Причина расторжения договора" (реестровый номер 54) NsiRef ReasonOfAnnulment Аннулирование string IsContract Договор не является публичным и/или присутствует заключенный на бумажном носителе или в электронной форме boolean ContractNumber Номер договора string SigningDate Дата заключения string EffectiveDate Дата вступления в силу string ContractAttachment Договор ресурсоснабжения и приложения к договору array[AttachmentTypeDto] ComptetionDate Дата окончания действия string AutomaticRollOverOneYear Автоматически пролонгировать договор на один год при наступлении даты окончания действия boolean IndefiniteTerm Договор заключен на неопределенный срок boolean PeriodStart Начало периода PeriodDto PeriodEnd Конец периода PeriodDto ContractBase Ссылка на НСИ "Основание заключения договора" (реестровый номер 58) array[NsiRef] ApartmentBuildingOwner Собственник или пользователь жилого (нежилого) помещения в МКД ApartmentBuildingOwnerDto LivingHouseOwner Собственник или пользователь жилого дома (домовладения) LivingHouseOwnerDto Offer Договор оферта boolean Organization Управляющая организация DrsoRegOrgDto IsPlannedVolume Наличие в договоре планового объема и режима подачи поставки ресурсов boolean PlannedVolumeType Тип ведения планового объема и режима подачи: D - в разрезе договора. O - в разрезе объектов жилищного фонда. string ContractSubject Предмет договора array[ResourceContractSubjectDto] CountingResource Коммерческий учет ресурса осуществляет: R(SO)- РСО. P(roprietor)-Исполнитель коммунальных услуг. Заполняется, если второй стороной договора является управляющая организация string SpecifyingQualityIndicators Показатели качества коммунальных ресурсов и температурный график ведутся: D - в разрезе договора. O - в разрезе объектов жилищного фонда. string Quality Показатель качества (содержащийся в справочнике показателей качества). Если показатели указываются в разрезе договора, то ссылка на ОЖФ не заполняется. Если показатели указываются в разрезе ОЖФ, то ссылка на ОЖФ обязательна. array[QualityDto] OtherQualityIndicator Иной показатель качества коммунального ресурса (не содержащийся в справочнике показателей качества). Если показатели указываются в разрезе договора, то ссылка на ОЖФ не заполняется. Если показатели указываются в разрезе ОЖФ, то ссылка на ОЖФ обязательна. array[OtherQualityIndicatorDto] PlannedVolume Плановый объем и режим подачи за год. array[PlannedVolumeDto] BillingDate Срок представления (выставления) платежных документов, не позднее. Является обязательным, если вторая сторона договора отличается от "Управляющая организация" и договор не является публичным и/или присутствует заключенный на бумажном носителе или в электронной форме. BillingDateDto PaymentDate Срок внесения платы, не позднее. Является обязательным, если вторая сторона договора отличается от "Управляющая организация" и договор не является публичным и/или присутствует заключенный на бумажном носителе или в электронной форме. PaymentDateDto ProvidingInformationDate Срок предоставления информации о поступивших платежах, не позднее. Является обязательным, если второй стороной договора является «Управляющая организация», «Коммерческий учет ресурса осуществляет» = «РСО» и договор не является публичным и/или присутствует заключенный на бумажном носителе или в электронной форме. ProvidingInformationDateDto -
POST: /api/management/resourceContract/getAsyncPaginal вернуться к оглавлениюПолучить договора ресурсоснабжения (постранично) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ContractGuid Идентификатор версии договора ресурсоснабжения в ГИС ЖКХ string (опциональное) Не указано ContractNumber Номер договора string (опциональное) Не указано ContractRootGuid Идентификаторы договоров ресурсоснабжения в ГИС ЖКХ array[string] (опциональное) Не указано FiasHouseGuid Адрес дома Глобальный уникальный идентификатор дома по ФИАС string (опциональное) Не указано ExportContractRootGUID Для установки следующей 1000 договоров постраничного метода (при первичном экспорте не заполняется) string (опциональное) Не указано ContractSubject Предмет договора BaseResourceContractSubjectDto (опциональное) Не указано SigningDateEnd Дата заключения "По" string (опциональное) Не указано SigningDateStart Дата заключения "С" string (опциональное) Не указано OrgGuid Идентификатор организации string (опциональное) Не указано MessageGuid Уникальный идентификатор запроса string (опциональное) Не указано ОтветПараметр Описание Тип ResourceContracts Договоры ресурсоснабжения array[ResourceContractDto] ExportContractRootGUID Ссылка на следующую 1000 договоров string -
POST: /api/management/resourceObject/getAsync вернуться к оглавлениюПолучить объекты договоров ресурсоснабжения (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор сообщения string (опциональное) 1 Заполните одно из полейFiasHouseGuid Адрес дома Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 ПоследовательностьExportObjectGuid Идентификатор объекта жилищного фонда в ГИС ЖКХ для установки экспорта следующей 1000 ОЖФ При первичном экспорте не заполняется string (опциональное) 1 Заполните одно из полейContractGuid Идентификатор версии договора ресурсоснабжения в ГИС ЖКХ string (обязательное) 1 ContractRootGuid Идентификатор договора ресурсоснабжения в ГИС ЖКХ string (обязательное) 1 КонецКонецКонецОтветПараметр Описание Тип ObjectAddress Объект жилищного фонда в договоре ресурсоснабжения array[ObjectAddressDto] ExportObjectGuid Идентификатор объекта жилищного фонда в ГИС ЖКХ для установки экспорта следующей 1000 ОЖФ string IsLastPage Последняя страница экспорта boolean -
POST: /api/management/resourceObject/getAsyncPaginal вернуться к оглавлениюПолучить объекты договоров ресурсоснабжения (постранично) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ContractGuid Идентификатор версии договора ресурсоснабжения в ГИС ЖКХ string (опциональное) Не указано ContractRootGuid Идентификатор договора ресурсоснабжения в ГИС ЖКХ string (опциональное) Не указано ExportObjectGuid Идентификатор объекта жилищного фонда в ГИС ЖКХ для установки экспорта следующей 1000 ОЖФ При первичном экспорте не заполняется string (опциональное) Не указано FiasHouseGuid Адрес дома Глобальный уникальный идентификатор дома по ФИАС string (опциональное) Не указано OrgGuid Идентификатор зарегистрированной организации string (опциональное) Не указано MessageGuid Уникальный идентификатор сообщения string (опциональное) Не указано ОтветПараметр Описание Тип ObjectAddress Объекты жилищного фонда в договоре ресурсоснабжения array[ObjectAddressDto] ExportObjectGuid Идентификатор страницы для получения следующей 1000 ОЖФ string -
POST: /api/management/briefResourceContract/getAsync вернуться к оглавлениюПолучить краткую информацию о договорах ресурсоснабжения (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений NextPageContractRootGuid Корневой идентификатор договора ресурсоснабжения в ГИС ЖКХ для установки экспорта следующей страницы с договорами. При первичном экспорте не заполняется string (опциональное) 1 NextPageObjectGuid Идентификатор объекта жилищного фонда в ГИС ЖКХ для установки экспорта следующей страницы с ОЖФ внутри договора с идентиифкатором, указанным в NextPageContractRootGUID. При первичном экспорте не заполняется string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейOrgEntityGuid Организация, заключившая договор string (обязательное) 1 Criteria Критерии поиска array[ResourceContractCriteriaDto] (обязательное) 10 Заполните одно из полейПоследовательностьКонецКонецКонецОтветПараметр Описание Тип IsLastPage Последняя страница экспорта boolean NextPageContractRootGuid Идентификатор договора ресурсоснабжения для экспорта следующей страницы договоров string NextPageObjectGuid Идентификатор объекта жилищного фонда в ГИС ЖКХ для экспорта следующей страницы ОЖФ string Contracts Краткая информация ДРСО array[BriefResourceContractDto] -
POST: /api/management/publicPropertyContract/getAsync вернуться к оглавлениюПолучить список договоров общего имущества (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 IsFromCache Вернуть результат из кэша (не запрашивая из ГИС) boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Entrepreneur Физическое лицо Entrepreneur OrgRootGuid Организация string FiasHouseGuid Адрес. Глобальный уникальный идентификатор дома по ФИАС string ContractNumber Номер договора string Date Дата договора string StartDate Дата начала действия договора string EndDate Планируемая дата окончания действия договора string ContractObject Предмет договора string Comments Комментарий string Payment Размер платы за предоставление в пользование части общего имущества собственников помещений в МКД в месяц number MoneySpentDirection Направление расходования средств, внесенных за пользование частью общего имущества string ContractAttachment Документы договора (Договор/дополнительные соглашения) array[AttachmentTypeDto] RentAgrConfirmationDocument Протокол собрания собственников array[RentAgrConfirmationDocument] ContractGuid Корневой идентификатор договора (не меняется от версии к версии) string StatusContract Состояние договора string ContractVersionGuid Идентификатор версии договора string VersionNumber Номер версии string StatusVersion Статус версии string PaymentInterval Период внесения платы по договору о предоставлении в пользование части общего имущества собственников помещений в многоквартирном доме PaymentInterval Заполните одно из полейКонецЗаполните одно из полейКонецAgreementPayments Сведения о внесении платы и задолженности array[AgreementPayment] -
POST: /api/management/paymentsInfo/createAsync вернуться к оглавлениюСоздать сведения о размерах плат за услуги/работы по договору управления (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Contracts Cведения о размере платы array[ContractPaymentsInfoDto] (обязательное) 100 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/management/updateAsync вернуться к оглавлениюОбновить договора управления дома (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Contracts Договоры управления по дому array[UpdateContractDto] (обязательное) 100 Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип ContractGuid Корневой идентификатор договора (не меняется от версии к версии) string ContractStatus Статус ДУ в ГИС ЖКХ string ContractVersionGuid Идентификатор версии договора string ContractObjects Управляемый объекты array[ContractStatusObjectDto] State Состояние документа string VersionNumber Номер версии string -
POST: /api/management/updateCharterAsync вернуться к оглавлениюОбновить устав дома (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений CharterGuid Идентификатор устава string (обязательное) 1 CharterVersionGuid Идентификатор версии устава(не нужно указывать, будет получен автоматически) string (опциональное) 1 СonclusionDate Дата присвоения ОГРН TCН/ТСЖ/ кооперативу (Организации поставщика данных) string (обязательное) 1 AutomaticRollOver Автоматически продлить срок оказания услуг на один год. Для автоматического продления указывается значение true. boolean (опциональное) 1 Attachments Документы устава array[AttachmentTypeDto] (обязательное) 1 ContractObjects Объект управления. Если устав является бессрочным элемент Дата окончания предоставления жилищных услуг необходимо заполнить значением "5000" array[ContractObjectShort] (опциональное) 1000 Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) Не указано Заполните одно из полейMeetingProtocol Протокол собрания собственников MeetingProtocolDto (обязательное) 1 NoCharterApproveProtocol Протокол, содержащий решение об утверждении устава, отсутствует (при значениии True MeetingProtocol необзяательны) boolean (обязательное) 1 КонецОтветПараметр Описание Тип CharterGuid Корневой идентификатор устава (не меняется от версии к версии) string CharterStatus Статус устава в ГИС ЖКХ: Project - проект Approved - утвержден Terminated - расторгнут/закрыт Annul - аннулирован Reviewed - рассмотрен ApprovalProcess - на утверждении Rejected - отклонен string CharterVersionGuid Идентификатор версии устава в ГИС ЖКХ string ContractObjects Управляемый объекты array[ContractStatusObjectDto] State Состояние документа: Running - действующий NotRunning - не действующий Expired - истек срок действия string VersionNumber Номер версии string
-
-
Дома
-
POST: /api/houses/getAsync вернуться к оглавлениюПолучить дом (для УО/РСО) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 IsFromCache Вернуть результат из кэша (не запрашивая из ГИС) boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип HouseUniqueNumber Уникальный номер дома на ГИС string ModificationDate Дата изменения string ApartmentHouse Многоквартирный дом ApartmentHouseDto Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецLivingHouse Жилой дом LivingHouseDto Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецКонецFiasHouseGuid Дом блочной застройки? string -
POST: /api/houses/updateAsync вернуться к оглавлениюОбновить дом (для УО) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений InheritMissingValues Поле для запроса с обновлением данных, то отсутствующие в дельте значения будут подгружены из предыдущей версии сущности. В противном случае отсутствующие значения будут сброшены в NULL. boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейApartmentHouse Многоквартирный дом ApartmentHouseDto (обязательное) 1 Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецLivingHouse Жилой дом LivingHouseDto (обязательное) 1 Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецКонецКонецОтветПараметр Описание Тип ApartmentHouse Многоквартирный дом ApartmentHouseDto Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецLivingHouse Жилой дом LivingHouseDto Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецКонецInheritMissingValues Поле для запроса с обновлением данных, то отсутствующие в дельте значения будут подгружены из предыдущей версии сущности. В противном случае отсутствующие значения будут сброшены в NULL. boolean OrgGuid Идентификатор зарегистрированной организации string MessageGuid Уникальный идентификатор запроса string
-
-
Запросы о наличии задолженности за ЖКУ
-
POST: /api/debtRequest/getAsync вернуться к оглавлениюПолучить запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейRequestGuids Идентификаторы запросов о наличии задолженности за ЖКУ array[string] (обязательное) 100 RequestNumbers Номера запросов, присвоенных ГИС ЖКХ array[string] (обязательное) 100 ПоследовательностьRequestCreationPeriod Период создания запроса в ГИС ЖКХ. CommonDebtRequestPeriodDto (обязательное) 1 PeriodOfSendingRequest Период направления запроса поставщикам ЖКУ. CommonDebtRequestPeriodDto (опциональное) 1 PeriodOfResponseDate Период крайнего срока ответа на запрос CommonDebtRequestPeriodOpenDto (опциональное) 1 Applicant Информация о заявителе ExportDebtRequestApplicantDto (опциональное) 1 HouseGuids Фиасы домов, по которым осуществляется запрос array[string] (опциональное) 100 RequestStatuses Статусы запросов в ГИС ЖКХ: 0 - Проект, 1 - В обработке, 2 - Направлен, 3 - Получен ответ, 4 - Отозван array[string] (опциональное) 4 RequestResults Результаты выполнения запросов о наличии задолженности за ЖКУ (НСИ #357) array[NsiRef] (опциональное) ∞ ExportRequestGuid Идентификатор, используемый для экспорта 2-го и последующих блоков данных. string (опциональное) 1 КонецКонецОтветПараметр Описание Тип Requests Данные запросов о наличии задолженности за ЖКУ array[ExportDebtRequestDto] NotFoundRequests Запросы о наличии задолженности за ЖКУ, данные о которых не найдены в ГИС ЖКХ ExportNotFoundDebtRequestDto PagedOutput Параметры, необходимые для экспорта следующего блока данных ExportDebtRequestPagedOutputDto -
POST: /api/debtRequest/subRequest/getAsync вернуться к оглавлениюПолучить подзапросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 IsIncludeResponses Включить в результат сведения об ответах на запросы о задолженности по ЖКУ? boolean (опциональное) 1 Заполните одно из полейRequestNumbers Номера запросов о наличии задолженности за ЖКУ, направленных в ГИС ЖКХ array[string] (обязательное) 100 SubRequestGuids Идентификаторы подзапросов, сформированных ГИС ЖКХ array[string] (обязательное) 100 ПоследовательностьPeriodOfSendingRequest Период направления запроса поставщикам ЖКУ. CommonDebtRequestPeriodDto (обязательное) 1 HouseGuids Идентификаторы домов в Реестре адресных объектов ГИС ЖКХ, с которыми связаны запросы о наличии задолженности array[string] (опциональное) 100 RequestStatuses Статусы запросов, направленных в ГИС ЖКХ: 0 - Направлен, 1 - Получен ответ, 2 - Отозван array[string] (опциональное) 2 ResponseStatuses Статусы ответов на подзапросы, сформированные ГИС ЖКХ: 0 - Ответ не отправлен, 1 - Ответ отправлен, 2 - Ответ сформирован автоматически array[string] (опциональное) 2 ExportSubRequestGuid Идентификатор, используемый для экспорта 2-го и последующих блоков данных. string (опциональное) 1 КонецКонецОтветПараметр Описание Тип SubRequests Данные подзапросов о наличии задолженности за ЖКУ array[ExportDebtSubRequestDto] NotFoundSubRequests Запросы и подзапросы о наличии задолженности за ЖКУ, данные о которых не найдены в ГИС ЖКХ ExportNotFoundDebtSubRequestDto PagedOutput Параметры, необходимые для экспорта следующего блока данных ExportDebtRequestPagedOutputDto -
POST: /api/debtRequest/createAsync вернуться к оглавлениюСоздать запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Actions Операции над запросами о наличии задолженности за ЖКУ array[ImportDebtRequestActionDto] (обязательное) 100 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/debtRequest/responses/createAsync вернуться к оглавлениюСоздать ответы на запросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Actions Действия с ответами на подзапросы о наличии задолженности array[ImportDebtSubRequestResponseActionDto] (обязательное) 100 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Капитальный Ремонт
-
POST: /api/capitalRepair/getAsync вернуться к оглавлениюПолучить счета регионального оператора и специальные счета (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений AccountInfo Информация о счетах региональных операторов и специальных счетах AccountInfo (обязательное) 1 Заполните одно из полейПоследовательностьКонецКонецOperationAndBalance Отобразить информацию о совершенных операциях и остатках OperationAndBalanceFilter (обязательное) 1 Заполните одно из полейПоследовательностьКонецКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип AccountGuid Идентификатор счета string AccountKind Вид счета (ссылка на НСИ "Вид счета" Код 62) NsiRef OpenDate Дата открытия счета string Details Реквизиты счета array[AccountDetails] FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string DocForAccountOpening Справка об открытии специального счета array[AttachmentTypeDto] CloseDate Дата закрытия специального счета/счета регионального оператора string Status Статус string OperationWithBalance Информация о совершенных операциях и остатках по счету array[OperationAndBalance] OperationWithBalanceIsAbsent За указанный период нформация о совершенных операциях и остатках по счету отсутствует boolean -
POST: /api/capitalRepair/getContractsAsync вернуться к оглавлениюПолучить договора на выполнение работ (оказание услуг) по капитальному ремонту (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейContractGuids Идентификатор договора в ГИС ЖКХ string (обязательное) 1000 Заполните одно из полейStartDate Дата договора С string (обязательное) 1 EndDate Дата договора ПО string (опциональное) 1 КонецКонецОтветПараметр Описание Тип Payments Сведения об оплате array[PaymentInfoDto] Certificates Акты array[CertificateDto] Status Статус договора string ExecutionStatus Статус исполнения договора string ContractGuid Идентификатор договора в ГИС ЖКХ string PlanGuid Идентификатор КПР в ГИС ЖКХ string Number Номер договора string Date Дата договора string StartDate Дата начала выполнения работ string EndDate Дата окончания выполнения работ string Sum Сумма договора number OrgRootEntityGuid Идентификатор корневой сущности организации в реестре организаций Если Заказчиком является Юридическое лицо / ИП string IndividualName ФИО Если Заказчиком является Физическое лицо string PerformerOrgRootEntityGuid Исполнитель string Works Список работ договора array[WorkContractDto] AttachContract Файлы договора array[AttachmentTypeDto] WarrantyMonthCount Гарантийный срок (месяцев) integer AttachOutlay Файлы сметной документации array[AttachmentTypeDto] TenderInetAddress Адрес страницы в сети Интернет, на которой размещена информация об отборе подрядных организаций string Dissolve Сведения о расторжении DissolveContractDto -
POST: /api/capitalRepair/decisions/getAsync вернуться к оглавлениюПолучить решения/информацию о порядке представления платежных документов (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейDecisionGuid Идентификатор решения/информации о порядке представления платежных документов в ГИС ЖКХ array[string] (обязательное) 1000 FiasHouseGuids Глобальный уникальный идентификатор дома по ФИАС array[string] (обязательное) 1000 ПоследовательностьDateEffectiveFrom Дата вступления в силу С string (обязательное) 1 DateEffectiveTo Дата вступления в силу ПО string (обязательное) 1 КонецКонецОтветПараметр Описание Тип FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string EffectiveDate Дата вступления в силу string Reason Основание Reason Model Модель выставления платежных документов string OrgRootEntityGuid Организация, уполномоченная на выставление платежных документов string TermForGranting Срок представления платежных документов string TermDay Число к сроку предоставления, по документации от 1 до 30 integer TermQualification Уточнение к сроку предоставления string DecisionGuid Идентификатор решения о выборе способа формирования фонда капитального ремонта string Status Статус решения string -
POST: /api/capitalRepair/fundSize/getAsync вернуться к оглавлениюПолучить информацию о размере фонда (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор организации string (обязательное) 1 MessageGuid Идентификатор запроса string (опциональное) 1 Заполните одно из полейFundSizeInfoGuids Идентификаторы информации о размере фондов капитального ремонта array[string] (обязательное) 1000 ПоследовательностьQuarterPeriodFrom Отчетный период - с string (опциональное) 1 QuarterPeriodTo Отчетный период - по string (опциональное) 1 Заполните одно из полейFiasHouseGuids Глобальный уникальный идентификатор дома по ФИАС array[string] (обязательное) 1000 Oktmo ОКТМО OKTMORefTypeDto (обязательное) 1 КонецКонецКонецОтветПараметр Описание Тип Status Статус версии string FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string Oktmo ОКТМО string QuarterPeriod Отчетный период string StartBalance Размер фонда на начало отчетного периода number EndBalance Размер фонда на конец отчетного периода number SentOnCapitalRepair Размер средств, направленных на капитальный ремонт за отчетный период number DebtForPerformedWork Размер задолженности за выполненные работы по капитальному ремонту по состояния на конец отчетного периода number PremisesInfo Информация по помещениям. При изменении информации о размере фонда необходимо присылать всю информацию по помещениям в актуальном состоянии array[PremisesInfoDto] FundSizeInfoGuid Идентификатор информации о размере фондов капитального ремонта string TransportGuid Транспортный идентификатор string -
POST: /api/capitalRepair/fundSize/createAsync вернуться к оглавлениюСоздать/внести изменения в информацию о размере фондов (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FundSizeInfos Информация о размере фонда капитального ремонта array[FundSizeInfoDto] (обязательное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/capitalRepair/operationAndBalance/createAsync вернуться к оглавлениюСоздать информацию о совершенных операциях и остатках по счетам (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OperationAndBalance Информация о совершенных операциях и остатках по счетам array[OperationAndBalanceDto] (обязательное) 1000 Заполните одно из полейПоследовательностьКонецКонецЗаполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Лицевые счета
-
POST: /api/account/getAsync вернуться к оглавлениюПолучить лицевые счета (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений IsWithoutClosed Без лицевых счетов, которые уже закрыты boolean (опциональное) 1 IsFromCache Вернуть результат из кэша (не запрашивая из ГИС) boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 AccountGuid Идентификатор лицевого счета string (обязательное) 1 AccountGuids Идентификаторы лицевых счетов array[string] (обязательное) 1000 ServiceId Идентификатор ЖКУ string (обязательное) 1 UnifiedAccountNumber ЕЛС string (обязательное) 1 UnifiedAccountNumbers ЕЛС array[string] (обязательное) 1000 КонецОтветПараметр Описание Тип AccountGuid Guid лицевого счета string ServiceId Идентификатор услуги string UnifiedAccountNumber Единый лицевой счет(ЕЛС) string Obligations Cведения об обязательствах array[AccountObligation] Number Номер лицевого счета string IsUo Лицевой счет для оплаты за жилое помещение и коммунальные услуги boolean IsRso Лицевой счет для оплаты за коммунальные услуги boolean IsTko Лицевой счет ТКО boolean IsCr Лицевой счет для оплаты капитального ремонта boolean IsRc Лицевой счет РКЦ boolean IsOgVorOms Лицевой счет ОГВ/ОМС boolean CreationDate Дата начала действия ЛС string LivingPersonsNumber Количество проживающих integer TotalSquare Общая площадь для ЛС(для УО является обязательным полем, для остальных необязательно) number ResidentialSquare Жилая площадь number HeatedArea Отапливаемая площадь number Closed Счет закрыт ClosedAccount Accommodations Помещения array[Accommodation] Заполните одно из полейКонецAccountReasons Конкретизация оснований ЛС (договоров ресурсоснабжения и/или договоров социального найма) AccountReasonsImportTypeDto ПоследовательностьКонецPayerInfo Сведения о плательщике AccountPayerInfo Заполните одно из полейЗаполните одно из полейКонецКонецTransportGuid Транспортный идентификатор, используется для выгрузки ЛС пачкой string -
POST: /api/account/createAsync вернуться к оглавлениюСоздать лицевые счета (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Accounts Лицевые счета array[AccountDto] (обязательное) 100 Заполните одно из полейКонецПоследовательностьКонецЗаполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип AccountGuid Guid лицевого счета string UnifiedAccountNumber Единый лицевой счет (ЕЛС) string ServiceId Идентификатор услуги string TransportGuid Транспортный сертификат string -
POST: /api/account/update вернуться к оглавлениюОбновить лицевые счета (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Accounts Лицевые счета array[UpdateAccountDto] (обязательное) 100 Заполните одно из полейКонецПоследовательностьКонецЗаполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип AccountGuid Guid лицевого счета string UnifiedAccountNumber Единый лицевой счет (ЕЛС) string ServiceId Идентификатор услуги string TransportGuid Транспортный сертификат string
-
-
Лицензии субъекта РФ
-
POST: /api/licenses/getAsync вернуться к оглавлениюПолучить лицензии (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейLicenseNumbers Номера лицензий array[string] (обязательное) ∞ ПоследовательностьRegionCode Код субьекта (2 цифры) string (опциональное) 1 Заполните одно из полейOgrn ОГРН string (обязательное) 1 OgrnIP ОГРНИП string (обязательное) 1 КонецКонецКонецОтветПараметр Описание Тип LicenseGUID Идентификатор лицензии в системе string LicenseVersion Версия лицензии string LicenseNumber Номер лицензии string LicenseRegDate Дата регистрации лицензии string LicenseStatus Статус лицензии: A - ACTIVE - включена в реестр, действующая F - FINISHED - включена в реестр, действие прекращено в зависимости от даты окончания действия лицензии C - CANCELED - аннулирована R - REJECTED - отменена в зависимости от основания string LicensingAuthority Наименование лицензирующего органа LicensingAuthorityDto AccompanyingDocument Документы лицензионного дела array[FullAccompanyingDocumentDto] RegionFIASGuid Адрес осуществления лицензируемого вида деятельности (код по ФИАС) string AdditionalInformation Дополнительная информация string LicenseOrganization Информация о лицензиате LicenseOrganizationDto LicensableTypeOfActivity Лицензируемый вид деятельности с указанием выполняемых работ, оказываемых услуг, составляющих лицензируемый вид деятельности string House Информация о домах array[HouseDto]
-
-
Обращения
-
POST: /api/appeals/getAsync вернуться к оглавлениюПолучить список обращений с ответами (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейAppealGuids Идентификаторы обращений в системе ГИС ЖКХ array[string] (обязательное) 1000 AppealNumbers Номера обращений array[string] (обязательное) 1000 AnswerGuids Идентификаторы ответов array[string] (обязательное) 1000 ПоследовательностьStartDate Дата создания обращения - начало диапазона string (опциональное) 1 EndDate Дата создания обращения - конец диапазона string (опциональное) 1 AppealTheme Тема обращения (НСИ 220) NsiRef (опциональное) 1 FiasHouseGuids Глобальные уникальные идентификаторы домов по ФИАС array[string] (опциональное) ∞ StatusOfAppeal Статус обращения StatusOfAppeal (опциональное) 1 КонецПоследовательностьStartCreateDate Дата создания ответа на обращения - начало диапазона string (опциональное) 1 EndCreateDate Дата создания ответа на обращения - конец диапазона string (опциональное) 1 StartPostDate Дата отправки ответа на обращения - начало диапазона string (опциональное) 1 EndPostDate Дата отправки ответа на обращения - конец диапазона string (опциональное) 1 КонецКонецОтветПараметр Описание Тип AppealGuid Идентификатор обращения в системе ГИС ЖКХ string ParentAppealGuid Идентификатор родительского обращения string ApplicantInfo Заявитель обращения ApplicantInfoDto AppealNumber Номер обращения string AppealCreateDate Дата создания обращения string AnotherTopic Другая тема обращения string AppealTopic Тема обращения (НСИ 220) NsiRef FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string OKTMO ОКТМО string AppealText Текст обращения (10 000 символов) string Attachment Прикрепленные файлы array[AttachmentTypeDto] AnswererGuid Идентификатор исполнителя по обращению string AppealHistory История изменений по обращению array[AppealHistoryDto] AppealStatus Статус обращения Send -Отправлено /Получено Executed - Исполнено Withdrawn - Отозвано string Redirected Перенаправлено в другую организацию boolean RedirectedIsNotHCS Перенаправлено в организацию, не зарегистрированную в ГИС ЖКХ boolean RolledOver Продлен срок рассмотрения boolean AnswerIsNotRequired Ответ на обращение не требуется boolean -
POST: /api/appeals/createAnswerAsync вернуться к оглавлениюСоздать ответ на обращение либо создать действие с обращением (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений AnswerAction Действия с ответами на обращения array[AppealAnswerActionDto] (опциональное) 1000 Заполните одно из полейКонецЗаполните одно из полейКонецAppealAction Действия с обращениями array[AppealActionDto] (опциональное) 1000 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Общесистемные справочники НСИ
-
POST: /api/nsiCommon/getAsync вернуться к оглавлениюПолучить список общесистемных справочников (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Group Группа справочника: NSI - (по умолчанию) общесистемный NSIRAO - ОЖФ string (опциональное) 1 MessageGuid Уникальный идентификатор сообщения string (опциональное) 1 ОтветПараметр Описание Тип NsiItemRegistryNumber Реестровый номер справочника. string Created Дата и время формирования данных справочника. string NsiElements Элемент справочника верхнего уровня. array[NsiElementTypeDto] -
POST: /api/nsiCommon/getByRegisterNumberAsync вернуться к оглавлениюПолучить данные общесистемного справочника (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Group Группа справочника: NSI - (по умолчанию) общесистемный NSIRAO - ОЖФ string (опциональное) 1 RegistryNumber Реестровый номер справочника. string (обязательное) 1 MessageGuid Уникальный идентификатор сообщения string (опциональное) 1 IsFromCache Получить данные из БД boolean (опциональное) 1 ОтветПараметр Описание Тип NsiItemRegistryNumber Реестровый номер справочника. string Created Дата и время формирования данных справочника. string NsiElements Элемент справочника верхнего уровня. array[NsiElementTypeDto] -
POST: /api/nsiCommon/getByRegisterNumberWithPageAsync вернуться к оглавлениюПолучить данные общесистемного справочника (постранично) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Page Номер страницы. Для постраничных справочников! (1-ая страница по умолчанию) integer (опциональное) 1 Group Группа справочника: NSI - (по умолчанию) общесистемный NSIRAO - ОЖФ string (опциональное) 1 RegistryNumber Реестровый номер справочника. string (обязательное) 1 MessageGuid Уникальный идентификатор сообщения string (опциональное) 1 IsFromCache Получить данные из БД boolean (опциональное) 1 ОтветПараметр Описание Тип TotalItemsCount Количество элементов на странице integer TotalPages Всего страниц integer CurrentPage Номер текущей страницы object NsiItemRegistryNumber Реестровый номер справочника. string Created Дата и время формирования данных справочника. string NsiElements Элемент справочника верхнего уровня. array[NsiElementTypeDto]
-
-
Организации из ЕГРЮЛ
-
POST: /api/organizations/getAsync вернуться к оглавлениюПолучить список поставщиков информации (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений IsFromCache Получение организации из кеша boolean (опциональное) 1 MessageGuid string (опциональное) 1 Заполните одно из полейOgrnIp ОГРНИП string (обязательное) 1 OrgEntityGuid Идентификатор сущности организации в ГИС ЖКХ string (обязательное) 1 OrgVersionGuid Идентификатор версии записи в реестре организаций string (обязательное) 1 ПоследовательностьOgrn ОГРН организации string (обязательное) 1 Kpp КПП string (опциональное) 1 КонецКонецОтветПараметр Описание Тип OrgGuid Идентификатор организации string OrgEntityGuid Идентификатор сущности организации в ГИС ЖКХ string Kpp КПП организации string OrganizationRoles Роли организации array[string] FullName string ShortName string OGRN string INN string OrgType string OrgVersionGuid Идентификатор версии записи в реестре организаций string -
POST: /api/organizations/delegated/getAsync вернуться к оглавлениюПолучить список информации о делегировании прав (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений MessageGuid Уникальный идентификатор запроса string (опциональное) 1 OrgGuid Идентификатор организации в ГИС string (обязательное) 1 Заполните одно из полейAccessRequestGuids ИД заявки array[string] (обязательное) 1000 ПоследовательностьPage Страница выборки. Возвращается по 1000 элементов. integer (опциональное) 1 AccessRequestStatus Статус заявки: Created – Создана Accepted – Принята Declined - Отклонена Revoked - Отозвана Annuled - Аннулирована Closed - Закрыта Preset– Предзаполнена Waiting_approval - На утверждении string (опциональное) 1 КонецКонецОтветПараметр Описание Тип ParentOrgRootEntityGuid Информация о головной организации (для обособленных подразделений) string OrgPPAGuid Идентификатор зарегистрированной организации string RegOrgRootEntityGuid Организация в реестре организаций string AccessRequest Заявка на доступ array[AccessRequestDto]
-
-
Платежные документы
-
POST: /api/payment/getAsync вернуться к оглавлениюПолучить платёжные документы (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейPaymentDocumentId Идентификатор платежного документа array[string] (обязательное) 1000 ПоследовательностьMonth Месяц integer (обязательное) 1 Year Год integer (обязательное) 1 Заполните одно из полейUnifiedAccountNumber Единый лицевой счет array[string] (обязательное) 1000 ServiceId Идентификатор жилищно-коммунальной услуги array[string] (обязательное) 1000 AccountGuid Идентификатор ЛС array[string] (обязательное) 1000 ПоследовательностьFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 Заполните одно из полейAccountNumber Номер лицевого счета/Иной идентификатор плательщика array[string] (обязательное) 1000 PaymentDocumentNumber Номер платежного документа, по которому внесена плата, присвоенный такому документу исполнителем в целях осуществления расчетов по внесению платы array[string] (обязательное) 1000 КонецКонецКонецКонецКонецОтветПараметр Описание Тип Month Месяц integer Year Год integer PaymentDocumentId Идентификатор платежного документа string ProviderInformationOrgGuid Сведения об исполнителе услуг платежного документа. Обязателен, если тип ЛС "ЛС РЦ" (isRCAccount), запрещен для заполнения для остальных типов лицевых счетов. string PaymentInformation Сведения о платежных реквизитах получателя array[PaymentInformationTypeExportDto] PaymentDocumentForm Приказ Минстроя №924/пр - состав данных платежного документа соответствует примерной форме платежного документа, утвержденной приказом Минстроя РФ от 29.12.2014 N 924/пр; Приказ Минстроя №43/пр - состав данных платежного документа соответствует примерной форме платежного документа, утвержденной приказом Минстроя РФ от 26.01.2018 N 43/пр string AccountGuid Идентификатор лицевого счета string PaymentDocumentNumber Номер платежного документа, по которому внесена плата, присвоенный такому документу исполнителем в целях осуществления расчетов по внесению платы string IsWithdraw Отозванный (признак заполняется при экспорте, при импорте необязателен) boolean IsExpose Выставлен на оплату (признак заполняется при экспорте, при импорте необязателен) boolean DebtPreviousPeriods Задолженность за предыдущие периоды, руб. Ссылка на пост. 924 – Приложение 2, п. 10. number AdvanceBllingPeriod Аванс на начало расчетного периода, руб. Ссылка на пост. 924 – Приложение 2, п. 10. number TotalPiecemealPaymentSum Сумма к оплате с учетом рассрочки платежа и процентов за рассрочку, руб. Ссылка на пост. 924 – Приложение 2, п. 46. number PaymentsTaken Учтены платежи, поступившие до указанного числа расчетного периода включительно Ссылка на пост. 924 – Приложение 2, п. 10. integer ChargeInfo Начисление по услуге array[ChargeInfoDto] ПоследовательностьКонецCapitalRepairCharge Начисление за капитальный ремонт array[CapitalRepairChargeDto] Insurance Страхование array[InsuranceDto] PenaltiesAndCourtCosts Неустойки и судебные расходы array[PenaltiesAndCourtCost] CapitalRepairDept Задолженность за капитальный ремонт array[DebtTypeDto] ChargeDebt Задолженность по услугам array[ServiceDebtTypeDto] Заполните одно из полейКонецAddressInfo Адресные сведения AddressInfoDto PaidCash Оплачено денежных средств, руб number DateOfLastReceivedPayment Дата последней поступившей оплаты string TotalPayableOverallByChargeInfo ИТОГО К ОПЛАТЕ, руб. (по всем услугам) Ссылка на приложение к приказу Минстроя РФ от 26.01.2018 N 43/пр - Раздел 3 примерной формы ПД number AdditionalInformation Дополнительная информация string SubsidiesCompensationSocialSupport Субсидии, компенсации и иные меры соц. поддержки граждан, руб. number -
POST: /api/payment/insuranceProduct/getAsync вернуться к оглавлениюПолучить страховые продукты (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип InsuranceOrg Корневой идентификатор страховой компании из реестра организаций string Description Условия страхования AttachmentTypeDto InsuranceProductGuid Уникальный идентификатор страхового продукта. Заполняется только при изменении или удалении страхового продукта. string CloseDate Дата удаления string TransportGuid Транспортный идентификатор string -
POST: /api/payment/notifications/getAsync вернуться к оглавлениюПолучить перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ExportNotificationsOfOrderExecutionGuid Для постраничного метода (ссылка на следующую 1000 оплат) string (опциональное) 1 PageSize Размер страницы. Устанавливает максимальное количество элементов, возвращаемых в результате экспорта(по умолчанию - 1000). integer (опциональное) Не указано OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейNotifications По реквизитам извещений RequisitesNotificationsDto (обязательное) ∞ SupplierIDs По реквизитам начислений RequisitesSupplierIDsDto (обязательное) ∞ Заполните одно из полейПоследовательностьЗаполните одно из полейКонецКонецКонецКонецОтветПараметр Описание Тип NotificationOfOrderExecutionWithStatus Результат метода экспорта оплат с результатами квитирования array[NotificationDto] Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейПоследовательностьКонецКонецЗаполните одно из полейЗаполните одно из полейКонецКонецПоследовательностьКонец -
POST: /api/payment/notifications/getAsyncPaginal вернуться к оглавлениюПолучить перечень документов «Извещение о принятии к исполнению распоряжения» (постранично) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Notifications По реквизитам извещений RequisitesNotificationsDto (опциональное) Не указано SupplierIDs По реквизитам начислений RequisitesSupplierIDsDto (опциональное) Не указано Заполните одно из полейПоследовательностьЗаполните одно из полейКонецКонецКонецExportNotificationsOfOrderExecutionGuid Для постраничного метода (ссылка на следующую 1000 оплат) string (опциональное) Не указано PageSize Размер страницы. Устанавливает максимальное количество элементов, возвращаемых в результате экспорта(по умолчанию - 1000). integer (опциональное) Не указано OrgGuid Идентификатор зарегистрированной организации string (опциональное) Не указано MessageGuid Уникальный идентификатор запроса string (опциональное) Не указано ОтветПараметр Описание Тип Notifications Оплаты с результатами квитирования array[NotificationResultDto] Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейПоследовательностьКонецКонецЗаполните одно из полейЗаполните одно из полейКонецКонецПоследовательностьКонецExportNotificationsOfOrderExecutionGuid Идентификатор следующей страницы для постраничного экспорта string -
POST: /api/payment/settlements/getAsync вернуться к оглавлениюПолучить информацию о состоянии расчетов с РСО/ИКУ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейContractRootGuid Идентификатор договора ресурсоснабжения в ГИС ЖКХ string (обязательное) ∞ SettlementGuid Идентификатор информации о состоянии расчетов string (обязательное) ∞ ПоследовательностьContractNumber Номер договора ресурсоснабжения string (опциональное) 1 OtherContractPartyGuid Другая сторона договора (РСО указывает вторую сторону договора, исполнитель коммунальных услуг - первую сторону) (OrgRootEntityGuid) string (опциональное) 1 PeriodFrom Период c string (опциональное) 1 PeriodTo Период по string (опциональное) 1 КонецКонецОтветПараметр Описание Тип SettlementGuid Идентификатор информации о состоянии расчетов string Contract Информация о договоре ресурсоснабжения SettlementContractDto ReportingPeriod Отчетный период array[ReportingPeriodDto] ReasonOfAnnulment Причина аннулирования string -
POST: /api/payment/settlements/iku/createAsync вернуться к оглавлениюСоздать информацию о состоянии расчетов с ИКУ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений IKUSettlements Информация о состояниях расчетов с РСО array[CreateIKUSettlementDto] (обязательное) ∞ OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/settlements/rso/createAsync вернуться к оглавлениюСоздать информацию о состоянии расчетов с РСО (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений RSOSettlements Информация о состояниях расчетов с ИКУ array[CreateRSOSettlementDto] (обязательное) ∞ OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/notifications/create вернуться к оглавлениюСоздать перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейNotificationOfOrderExecutionType Извещения о принятии к исполнению распоряжений array[NotificationOfOrderExecutionDto] (обязательное) 500 Заполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейПоследовательностьКонецКонецЗаполните одно из полейЗаполните одно из полейКонецКонецПоследовательностьКонецNotificationOfOrderExecution139Type Извещения о принятии к исполнению распоряжений (указание реквизитов платежа по п.139 приказа №589/944 от 28.12.2015) array[NotificationOfOrderExecution139Dto] (обязательное) 500 КонецОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/createAsync вернуться к оглавлениюСоздать платёжные документы (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Month Месяц integer (обязательное) 1 Year Год integer (обязательное) 1 PaymentDocument Размещаемый платежный документ CreatePaymentDocumentDto (опциональное) Не указано Заполните одно из полейКонецЗаполните одно из полейПоследовательностьПоследовательностьКонецКонецПоследовательностьЗаполните одно из полейКонецКонецКонецPaymentDocuments Размещаемые платежные документы(сделано для обратной совместимости впоследствии убрать один PaymentDocument) array[CreatePaymentDocumentDto] (обязательное) 500 Заполните одно из полейКонецЗаполните одно из полейПоследовательностьПоследовательностьКонецКонецПоследовательностьЗаполните одно из полейКонецКонецКонецPaymentInformation Сведения о платежных реквизитах получателя - бизнес-ключ поиска размещенных платежных реквизитов в ГИС ЖКХ array[PaymentInformationDto] (обязательное) ∞ ConfirmAmountsCorrect True = Передаваемые данные платежных документов, следует считать верными, даже если они отличаются от автоматически рассчитанных Системой значений. boolean (опциональное) 1 ProviderInformationOrgGuid Сведения об исполнителе услуг платежного документа. Обязателен, если тип ЛС "ЛС РЦ" (isRCAccount), запрещен для заполнения для остальных типов лицевых счетов. string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/insuranceProduct/createOrUpdateAsync вернуться к оглавлениюCоздать или изменить страховые продукты (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений InsuranceProducts Страховые продукты array[InsuranceProductDto] (обязательное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/acknowledgment/createAsync вернуться к оглавлениюСоздать запрос на квитирование (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений AcknowledgmentInfo array[AcknowledgmentInfoDto] (обязательное) 500 Заполните одно из полейЗаполните одно из полейКонецКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/supplierNotifications/create вернуться к оглавлениюВнести оплаты (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Notifications Извещение о принятии к исполнению распоряжения, размещаемое исполнителем array[SupplierNotificationDto] (обязательное) 250 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/withdrawAsync вернуться к оглавлениюОтозвать платёжные документы (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений PaymentIds ПД на отзыв array[PaymentId] (обязательное) 1000 PaymentDocumentsId Устаревшее поле. Пользоваться полем PaymentIds array[string] (опциональное) Не указано Reason Поле необходимо для ведения статистики. В ГИС не передаётся string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/insuranceProduct/deleteAsync вернуться к оглавлениюУдалить страховые продукты (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений InsuranceProducts Страховые продукты array[InsuranceProductDto] (обязательное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/acknowledgment/cancelAsync вернуться к оглавлениюОтменить квитирование (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений AckCancellation array[AckCancellationDto] (обязательное) 500 Заполните одно из полейПоследовательностьЗаполните одно из полейКонецКонецКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/payment/notifications/cancelAsync вернуться к оглавлениюОтменить оплаты (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Notifications Оплаты на отмену array[NotificationToCancelDto] (обязательное) 500 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Приборы учета
-
POST: /api/metering/getAsync вернуться к оглавлениюПолучить перечень приборов учёта (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор текущей организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 IsFromCache Брать ПУ из кеши boolean (опциональное) 1 Заполните одно из полейMeteringDeviceRootGuid Идентификатор ПУ в ГИС ЖКХ string (обязательное) 1 MeteringDeviceVersionGuid Идентификатор версии ПУ string (обязательное) 1 ПоследовательностьFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 ArchiveDateFrom Дата архивации «С» string (опциональное) 1 ArchiveDateTo Дата архивации «По» string (опциональное) 1 CommissioningDateFrom Дата ввода в эксплуатацию «С» string (опциональное) 1 CommissioningDateTo Дата ввода в эксплуатацию «По» string (опциональное) 1 SearchArchived Выгружать архивированные boolean (опциональное) 1 IsCurrentOrganization Выгружать ПУ, находящиеся в собственности или на ином законном основании только текущей организации (критерий применяется только для ОДПУ) (если признак не установлен, то будут выгружены все ОДПУ, доступные текущей организации для просмотра) boolean (опциональное) 1 UpdateDateTime Дата модификации string (опциональное) 1 Заполните одно из полейMunicipalResource Коммунальный ресурс (НСИ 2) NsiRef (опциональное) 1 MeteringDeviceType Вид прибора учета (НСИ 27) NsiRef (опциональное) 1 КонецКонецКонецОтветПараметр Описание Тип MeteringDeviceRootGuid Идентификатор ПУ в ГИС ЖКХ string StatusRootDoc Статус сущности string MeteringDeviceVersionGuid Идентификатор версии ПУ в ГИС ЖКХ string VersionNumber Номер версии в ГИС ЖКХ string StatusVersion Статус версии в ГИС ЖКХ string MeteringDeviceGISGKHNumber Номер прибора учета в ГИС ЖКХ string MeteringBasicCharacteristics Основные характеристики ПУ MeteringBasicCharacteristicsDto LinkedWithMetering Объем ресурса(ов) определяется с помощью нескольких приборов учета оставить null если связей с другими ПУ нет LinkedWithMeteringDto MunicipalResourceTypes Ресурсы ПУ. Если это электричество, то передавать 1 ресурс. Если это не электричество, то передавать от 1 до 3 ресурсов. array[MunicipalResourceTypeDto] ПоследовательностьКонецTransportGuid Транспортный идентификатор string -
POST: /api/metering/values/getAsync вернуться к оглавлениюПолучить историю показаний приборов учёта (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FiasHouseGuid Идентификатор дома в ГИС ЖКХ string (обязательное) 1 OrgGuid Идентификатор организации в ГИС ЖКх string (обязательное) 1 CommissioningDateFrom Дата ввода в эксплуатацию «С» string (опциональное) 1 CommissioningDateTo Дата ввода в эксплуатацию «По» string (опциональное) 1 SerchArchived Выгружать архивированные boolean (опциональное) 1 ArchiveDateFrom Дата архивации «С» string (опциональное) 1 ArchiveDateTo Дата архивации «По» string (опциональное) 1 InputDateFrom Дата ввода показаний "С" string (опциональное) 1 InputDateTo Дата ввода показаний "По" string (опциональное) 1 ExcludeIsValues Выгрузить показания, поставщик которых не текущая ИС. (Часть показаний может быть внесена не только через ГУИ, а с помощью другой ИС) Если флаг = "истина", то выгружаются показания, созданные через ГУИ и с помощью других ИС, в остальных случаях выгружаются все показания boolean (опциональное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 IsFromCache Взять показания из кэша boolean (опциональное) 1 Заполните одно из полейMeteringDeviceRootGuids Идентификатор сущности ПУ в ГИС ЖКХ array[string] (обязательное) 100 MunicipalResources Коммунальный ресурс (тепловая энергия, газ, горячая вода, холодная вода, сточные бытовые воды) (НСИ 2) array[NsiRef] (обязательное) 100 MeteringDeviceTypes Тип прибора учета - 0 - Характеристики ИПУ жилого дома (значение справочника "Вид прибора учета" = индивидуальный, тип дома = жилой дом) 1 - Характеристики общеквартирного ПУ (для квартир коммунального заселения) (значение справочника "Вид прибора учета" = Общий (квартирный)) 2 - Характеристики общедомового ПУ (значение справочника "Тип прибора учета" = коллективный (общедомомвой)) 3 - Характеристики комнатного ИПУ (значение справочника "Вид прибора учета" = Комнатный 4 - Характеристики ИПУ нежилого помещения (значение справочника "Вид прибора учета" = индивидуальный) 5 - Характеристики ИПУ жилого помещения (значение справочника "Вид прибора учета" = индивидуальный) array[NsiRef] (обязательное) 100 КонецОтветПараметр Описание Тип MeteringDeviceRootGuid Идентификатор ПУ в ГИС ЖКХ string Values MeteringDeviceHistoryValuesDto -
POST: /api/metering/createAsync вернуться к оглавлениюСоздать приборы учета (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений MeteringDevices Список приборов учета array[MeteringDeviceDto] (обязательное) 100 ПоследовательностьКонецFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип MeteringDeviceGuid Уникальный идентификатор ПУ (MeteringRootGuid) string Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/metering/values/createAsync вернуться к оглавлениюПередать показания приборов учёта (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Values Показания ПУ array[MeteringDeviceValuesDto] (обязательное) 1000 Заполните одно из полейКонецЗаполните одно из полейКонецFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/metering/updateAsync вернуться к оглавлениюОбновить информацию о приборах учёта (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений MeteringDevices Приборы учета array[UpdateMeteringDevice] (обязательное) 100 ПоследовательностьКонецFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип MeteringDeviceGuid Уникальный идентификатор ПУ (MeteringRootGuid) string Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/metering/archive вернуться к оглавлениюАрхивировать приборы учёта (в конкретном доме) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ArchiveMeteringDevices Приборы учета, которые необходимо архивировать array[ArchiveMeteringDeviceDto] (обязательное) 100 FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Реестр протоколов ОСС
-
POST: /api/votings/getAsync вернуться к оглавлениюПолучить протоколы ОСС (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейVotingProtocolGuids Идентификатор версии протокола голосования array[string] (обязательное) 100 RootProtocolGuids Идентификатор версии протокола голосования array[string] (обязательное) 100 ПоследовательностьFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 StatusVersionProtocol Статус версии протокола ОСС string (опциональное) 1 КонецКонецОтветПараметр Описание Тип StatusProtocol Статус протокола ОСС string StatusVersionProtocol Статус версии протокола ОСС string VotingProtocolGuid Идентификатор версии протокола голосования string RootProtocolGuid Корневой идентификатор протокола голосования string FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string ProtocolNum Номер протокола string ProtocolDate Дата составления протокола string AbsenteeVoting Заочное голосование(опросным путем) AbsenteeVoting SystemVoting Заочное голосование с использованием системы SystemVoting Заполните одно из полейКонецЗаполните одно из полейКонецMeeting Очное голосование Meeting MeetingAbsenteeVoting Очное-заочное голосование MeetingAbsenteeVoting AnnualVoting Ежегодное собрание boolean ExtraVoting Внеочередное собрание boolean MeetingEligibility Правомочность собрания string VoteInitiators Сведения об инициаторах собрания array[VoteInitiatorsDto] Заполните одно из полейКонецDecisionList Повестка array[DecisionList] Modification Основание изменения. Заполняется для протоколов ОСС в статусе "Размещен" string -
POST: /api/votings/getMessageAsync вернуться к оглавлениюПолучить сообщение о проведении ОСС (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений MessageGuid Уникальный идентификатор запроса string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 Заполните одно из полейFiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 VotingMessageGuids Корневой идентификатор сообщения о проведении голосования array[string] (обязательное) 100 КонецОтветПараметр Описание Тип VotingMessageGuid Идентификатор сообщения о проведении голосования string MessageStatus Статус сообщения о проведении ОСС string PublishDate Дата и время размещения версии сообщения string ModificationDate Дата и время последнего изменения версии сообщения string FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string OrganizationGuid Товарищество Собственников Жилья/ Кооператив RegOrgInfo MessageNum Номер сообщения string MessageDate Дата составления сообщения string IsAnnualVoting Ежегодное собрание boolean IsExtraVoting Внеочередное собрание boolean AbsenteeVoting Заочное голосование (опросным путем) AbsenteeVoting SystemVoting Заочное голосование с использованием системы SystemVoting Заполните одно из полейКонецЗаполните одно из полейКонецMeeting Очное голосование Meeting MeetingAbsenteeVoting Очно-заочное голоосвание MeetingAbsenteeVoting MeetingType Тип собрания 0 - Собрание собственников 1 - Собрание членов ТСЖ 2 - Собрание членов кооператива string VoteInitiators Сведения об инициаторах собрания array[VoteInitiatorsDto] Заполните одно из полейКонецDecisionList Повестка array[DecisionDto] Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецModificationReason Основание изменения. Заполняется для сообщений в статусе "Сообщение размещено" и с формой проведения отличной от "Заочное голосование с использованием системы" string -
POST: /api/votings/getOwnerDecisionsAsync вернуться к оглавлениюПолучить список решений собственников (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор сообщения string (опциональное) 1 Заполните одно из полейVotingMessageGuids Идентификаторы сообщений о проведении ОСС array[string] (обязательное) 100 RootOwnerDecisionGuids Корневые идентификаторы решения собственника по вопросам голосования array[string] (обязательное) 1000 RootProtocolGuids Корневые идентификаторы протокола голосования array[string] (обязательное) 100 VotingProtocolGuids Идентификаторы версий протокола голосования array[string] (обязательное) 100 КонецОтветПараметр Описание Тип RootOwnerDecisionGuid Корневой идентификатор решения собственника по вопросам голосования string DecisionAnnuled Решение аннулировано boolean Owner Сведения о собственнике OwnerDto Заполните одно из полейПоследовательностьКонецЗаполните одно из полейКонецКонецPropertyDetails Сведения о собственности для экспорта array[ExportPropertyDetailsDto] Representative Сведения о представителе RepresentativeDto ПоследовательностьКонецЗаполните одно из полейКонецQuestionOnDecision Вопрос повестки QuestionOnDecisionDto Attachments Электронный образ решения собственника array[AttachmentTypeDto] -
POST: /api/votings/createAsync вернуться к оглавлениюСоздать протокол ОСС (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 TransportGuid Транспортный идентификатор string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейProtocol Протокол ОСС NewVotingProtocol (обязательное) 1 Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецКонецЗаполните одно из полейКонецDelete Удалить протокол ОСС boolean (обязательное) 1 Placing Разместить протокол ОСС boolean (обязательное) 1 Revert Отменить последние изменения boolean (обязательное) 1 КонецОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/votings/createMessageAsync вернуться к оглавлениюСоздать сообщение о проведении ОСС (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений VotingMessage Разместить или изменить сообщение о проведении ОСС VotingMessage (обязательное) 1 Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецКонецTransportGuid Транспортный идентификатор string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/votings/createOwnerDecisionsAsync вернуться к оглавлениюДобавить решения собственников (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OwnerDecisions Решения собственников по вопросам голосования array[ImportOwnerDecisionDto] (обязательное) 10000 Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейПоследовательностьКонецЗаполните одно из полейКонецКонецПоследовательностьКонецЗаполните одно из полейКонецКонецOrgGuid Идентификатор зарегистрированной организации string (опциональное) Не указано MessageGuid Уникальный идентификатор запроса string (опциональное) Не указано ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Сведения об объеме и качестве коммунальных услуг и коммунальных ресурсов
-
POST: /api/volumeQuality/saveAsync вернуться к оглавлениюДобавить/изменить период регистрации (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ContractType Тип договора-основания string (обязательное) 1 ContractRootGuid Идентификатор договора-основания string (обязательное) 1 RegistrationPeriod Период регистрации (учитывается только месяц и год) string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 TransportGuid Транспортный идентификатор string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейQualityResources Показатели качестве КР. Заполняется если в основании указан договор ресурсоснабжения или договор ТКО array[QualityResourceDto] (обязательное) 1000 Заполните одно из полейЗаполните одно из полейПоследовательностьЗаполните одно из полейПоследовательностьКонецКонецКонецКонецЗаполните одно из полейПоследовательностьЗаполните одно из полейПоследовательностьКонецКонецКонецКонецКонецQualityServices Показатели качества КУ. Заполняется если в основании указан договор ресурсоснабжения или договор управления (устав) array[QualityServiceDto] (обязательное) 1000 Заполните одно из полейЗаполните одно из полейПоследовательностьЗаполните одно из полейКонецКонецКонецЗаполните одно из полейПоследовательностьЗаполните одно из полейКонецЗаполните одно из полейКонецКонецКонецЗаполните одно из полейЗаполните одно из полейКонецКонецЗаполните одно из полейПоследовательностьЗаполните одно из полейКонецКонецКонецЗаполните одно из полейПоследовательностьЗаполните одно из полейПоследовательностьКонецКонецКонецКонецКонецVolumeResources Объем КР. Заполняется только если в основании информации об объеме и качестве КУ указан договор ресурсоснабжения или договор управления (устав) array[VolumeResourceDto] (обязательное) 1000 Заполните одно из полейКонецЗаполните одно из полейКонецКонецОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/volumeQuality/placingRegistrationPeriodAsync вернуться к оглавлениюРазместить период регистрации (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ContractType Тип договора-основания string (опциональное) Не указано ContractRootGuid Идентификатор договора-основания string (опциональное) Не указано RegistrationPeriod Период регистрации (учитывается только месяц и год) string (опциональное) Не указано OrgGuid Идентификатор зарегистрированной организации string (опциональное) Не указано TransportGuid Транспортный идентификатор string (опциональное) Не указано MessageGuid Уникальный идентификатор запроса string (опциональное) Не указано ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Сервис обмена сведениями о работах и услугах
-
POST: /api/service/HMServicesTarifs/getAsync вернуться к оглавлениюПолучить тарифы ЖКУ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ServiceType Вид жилищно-коммунальной услуги (M) unicipal - Коммунальные услуги (O)verhaul - Капитальный ремонт (S)ocial hiring - Социальный наем (R)epair and maintenance - Содержание и ремонт жилого помещения (C)ommunal resourses - коммунальные ресурсы string (обязательное) 1 IsPublished Экспортируются только опубликованные документы boolean (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейMunicipalities Муниципальные образования array[OKTMORefTypeDto] (опциональное) ∞ Region Субъект РФ array[RegionTypeDto] (обязательное) 1 КонецПоследовательностьEffectivePeriodFrom Дата начала действия тарифа string (опциональное) 1 EffectivePeriodTo Дата окончания действия тарифа string (опциональное) 1 КонецОтветПараметр Описание Тип Name Наименование документа string DocNumber Номер документа string ApproveDate Дата принятия документа органом власти string Attachment Вложение AttachmentTypeDto EffectivePeriodFrom Дата начала действия тарифа string EffectivePeriodTo Дата окончания действия тарифа string CancelServicesTarifDocGuid Отменяет прежний документ (ссылка на документ) string IsPublished Документ всегда приходит в статусе "Опубликован" и публикуется на Портале. Экспортируются только опубликованные документы. boolean Region Субъект РФ RegionTypeDto PrimaryMunicipalResource Вид ЖКУ = "Коммунальные услуги" Доступно организациям с полномочием: - Орган государственной власти субъекта РФ в сфере ЖКХ - Орган местного самоуправления в сфере ЖКХ - Управляющая организация array[PrimaryMunicipalResource] IsOverhaul Вид ЖКУ = "Капитальный ремонт" Доступно организациям с полномочиями: - Орган государственной власти субъекта РФ в сфере ЖКХ array[boolean] MunicipalResource Вид ЖКУ = "Коммунальные ресурсы" Доступно организациям с полномочием: - Орган исполнительной власти субъекта РФ в области регулирования тарифов - Федеральная антимонопольная служба(Федеральная служба по тарифам) - Ресурсоснабжающая организация array[MunicipalResource] OKTMOs Муниципальные образования array[OKTMORefTypeDto] ServiceType Вид жилищно-коммунальной услуги (S)ocial hiring - Социальный наем (R)epair and maintenance - Содержание и ремонт жилого помещения array[string] ServicesTarifDocGuid Идентификатор документа тарифа в ГИС ЖКХ string CreationDate Дата создания документа в ГИС ЖКХ string -
POST: /api/service/workingList/getAsync вернуться к оглавлениюПолучить список работ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений WorkListStatus Статус string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 100 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейWorkListGUID Идентификатор перечня array[string] (обязательное) 100 ПоследовательностьFIASHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 MonthYearFrom Период "с" string (обязательное) 1 MonthYearTo Период "по" string (обязательное) 1 КонецКонецОтветПараметр Описание Тип ModificationDate Дата модификации объекта string WorkListStatus Статус string WorkListItems array[WorkingItem] WorkListGuid Идентификатор перечня string FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string MonthYearFrom Период "с" string MonthYearTo Период "по" string ContractGuid Идентификатор договора управления ГИС ЖКХ string -
POST: /api/service/workingPlan/getAsync вернуться к оглавлениюПолучить план работ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Works Перечень работ array[Work] (обязательное) 100 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string WorkReportingPeriod Период отчётности о выполненных работах array[WorkReportingPeriod] WorkListGuid Идентификатор перечня работ/услуг string Year Год integer -
POST: /api/service/completedWorks/getAsync вернуться к оглавлениюПолучить сведения о выполненных работах и услугах (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ReportingPeriodGuid Ссылка на период отчётности о выполненных работах array[string] (обязательное) 100 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Act array[Act] ReportingPeriodGuid Ссылка на период отчётности о выполненных работах/услугах string PlannedWork Выполненная плановая работа/услуга array[PlannedWork] Заполните одно из полейКонецUnplannedWork Выполненная внеплановая работа/услуга array[UnplannedWork] Заполните одно из полейКонецЗаполните одно из полейКонец -
POST: /api/service/qualityAssessment/getAsync вернуться к оглавлениюПолучить информацию об оценке качества работ и услуг (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений ReportingPeriodGuid Ссылка на период отчетности в выполненных работах array[string] (обязательное) 100 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Works Работы, включенные в оценку качества array[ExportQualityAssessmentWork] ReportingPeriodGuid Идентификатор периода отчётности о выполненных работах string -
POST: /api/service/workingList/createOrUpdateAsync вернуться к оглавлениюСоздать/измененить основные сведения по перечню работ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений WorkingListItems Работа/услуга перечня array[CreateWorkListItemDto] (обязательное) ∞ Заполните одно из полейПоследовательностьКонецКонецMessageGuid Уникальный идентификатор запроса string (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 WorkListGuid Идентификатор перечня string (опциональное) 1 FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 MonthYearFrom Период "с" string (обязательное) 1 MonthYearTo Период "по" string (обязательное) 1 ContractGuid Идентификатор договора управления ГИС ЖКХ string (обязательное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/service/workingPlan/createAsync вернуться к оглавлениюСоздать актуальные планы по перечню работ/услуг (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений WorkingPlan План по перечню работ/услуг array[CreateWorkingPlan] (обязательное) 100 Заполните одно из полейКонецOrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/service/completedWorks/createAsync вернуться к оглавлениюСоздать сведения о выполненных работах и услугах (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ReportingPeriodGuid Ссылка на период отчётности о выполненных работах/услугах string (обязательное) 1 PlannedWork Выполненная плановая работа/услуга array[PlannedWork] (опциональное) ∞ Заполните одно из полейКонецUnplannedWork Выполненная внеплановая работа/услуга array[UnplannedWork] (опциональное) ∞ Заполните одно из полейКонецЗаполните одно из полейКонецОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/service/qualityAssessment/createAsync вернуться к оглавлениюСоздать информацию об оценке качества работ и услуг (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений QualityAssessments Оценка качества array[QualityAssessmentDto] (обязательное) 100 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/service/workingList/annulAsync вернуться к оглавлениюАннулировать основные сведения по перечню работ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений WorkListGuid Идентификатор перечня string (обязательное) 1 ReasonOfAnnulment Причина аннулирования string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/service/workingList/cancelAsync вернуться к оглавлениюОтменить основные сведения по перечню работ (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений WorkListGuid Идентификатор перечня string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Справочники НСИ поставщика информации
-
POST: /api/nsi/getAsync вернуться к оглавлениюПолучить данные справочников поставщика информации (1, 51, 59, 219) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений RegistryNumber Реестровый номер справочника 1, 51, 59, 219, 302 integer (обязательное) 1 IsFromCache Вернуть результат из кэша (не запрашивая из ГИС) boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип NsiItemRegistryNumber Реестровый номер справочника. string Created Дата и время формирования данных справочника. string NsiElements Элемент справочника верхнего уровня. array[NsiElementTypeDto] -
POST: /api/nsi/getWithPageAsync вернуться к оглавлениюПолучить данные справочников поставщика информации (постранично) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений RegistryNumber Реестровый номер справочника 1, 51, 59, 219, 302 string (обязательное) 1 Page Страница integer (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип TotalItemsCount Количество элементов на странице integer TotalPages Всего страниц integer CurrentPage Номер текущей страницы object NsiItemRegistryNumber Реестровый номер справочника. string Created Дата и время формирования данных справочника. string NsiElements Элемент справочника верхнего уровня. array[NsiElementTypeDto] -
POST: /api/nsi/additionalServices/updateAsync вернуться к оглавлениюИзменить элементы справочника 1 «Дополнительные услуги» (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений CreateAdditionalServices Создание элементов справочника array[AdditionalServiceDto] (опциональное) 1000 Заполните одно из полейКонецRecoverAdditionalServices Восстановление элементов справочника array[BaseServiceCatalogDto] (опциональное) 1000 DeleteAdditionalServices Удаление элементов справочника array[BaseServiceCatalogDto] (опциональное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/municipalResources/updateAsync вернуться к оглавлениюИзменить элементы справочника 51 «Коммунальные услуги» (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений CreateMunicipalServices Добавление элементов в справочник array[MainMunicipalServiceDto] (опциональное) 1000 RecoverMunicipalServices Восстановление элементов справочника array[RecoverMainMunicipalServiceDto] (опциональное) 1000 DeleteMainMunicipalServices Удаление элементов в справочнике array[DeleteMainMunicipalServiceDto] (опциональное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/generalNeedsMunicipalResources/createAsync вернуться к оглавлениюСоздание главного коммунального ресурса (ветки) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений CreateGeneralNeedsMunicipalResources Создание главного коммунального ресурса (ветки) array[GeneralNeedsMunicipalResourceImportCreateDto] (опциональное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/generalNeedsMunicipalResources/updateAsync вернуться к оглавлениюИзменение главного коммунального ресурса (ветки). (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений UpdateGeneralNeedsMunicipalResources Создание главного коммунального ресурса (ветки) array[GeneralNeedsMunicipalResourceImportUpdateDto] (опциональное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/generalNeedsMunicipalResources/deleteAsync вернуться к оглавлениюУдаление главного коммунального ресурса справочника 337 "Коммунальные ресурсы, потребляемые при использовании и содержании общего имущества в многоквартирном доме" (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений DeleteGeneralNeedsMunicipalResources Удаление главного коммунального ресурса (ветки) array[GeneralNeedsMunicipalResourceDeleteDto] (опциональное) 1000 ParentCode Код родительской записи верхнего уровня string (обязательное) 1 TransportGuid Транспортный идентификатор string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/generalNeedsMunicipalResources/recoverAsync вернуться к оглавлениюВостановление главного коммунального ресурса справочника 337 "Коммунальные ресурсы, потребляемые при использовании и содержании общего имущества в многоквартирном доме" (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений RecoverGeneralNeedsMunicipalResources Востановление главного коммунального ресурса (ветки) array[GeneralNeedsMunicipalResourceRecoverDto] (опциональное) 1000 ParentCode Код родительской записи верхнего уровня string (обязательное) 1 TransportGuid Транспортный идентификатор string (обязательное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string -
POST: /api/nsi/organizationWorks/updateAsync вернуться к оглавлениюИзменить элементы справочника «Работ и услуг» (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений CreateWorks Создание работ/услуг array[OrganizationWorkTypeDto] (опциональное) 1000 Заполните одно из полейКонецRecoverOrganizationTypes Восстановление работ/услуг array[BaseServiceCatalogDto] (опциональное) 1000 DeleteOrganizationWorks Удаление работ/услуг array[BaseServiceCatalogDto] (опциональное) 1000 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип Guid Уникальный идентификатор string UniqueNumber Уникальный номер string Message Дополнительная информация string UpdateDate Дата модификации string TransportGuid Транспортный идентификатор string
-
-
Файлы
-
POST: /api/files/download вернуться к оглавлениюСкачать файл из подсистемы ГИС ЖКХ (синхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FileGuid Идентификатор файла в ГИС(обычно AttachmentGuid) string (обязательное) 1 Storage Подсистема, где хранится файл: 0 - Управление домами, Лицевые счета(homemanagement), 1 - Реестр коммунальной инфраструктуры(rki), 2 - Голосования(voting), 3 - Инспектирование жилищного фонда(inspection), 4 - Оповещения (informing), 5 - Электронные счета (bills), 6 - Лицензии (licenses), 7 - Договора(ДУ, уставы, ДПОИ) (agreements), 8 - Нормативно-справочная информации (nsi), 9 - Раскрытие деятельности УО (disclosure), 10 - Запросы о наличии задолженности по оплате ЖКУ (debtreq) string (обязательное) 1 OrgGuid Идентификатор организации string (обязательное) 1 ОтветПараметр Описание Тип OriginalFileName Название оригинального файла string FileId Гуид присвоенный Api файлу string SdnUrl Ссылка на файл для скачивания string -
POST: /api/files/upload вернуться к оглавлениюЗагрузить файлы в подсистему ГИС ЖКХ (синхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений Storage (Передается в Header) Подсистема, где хранится файл: 0 - Управление домами, Лицевые счета(homemanagement), 1 - Реестр коммунальной инфраструктуры(rki), 2 - Голосования(voting), 3 - Инспектирование жилищного фонда(inspection), 4 - Оповещения(informing), 5 - Электронные счета(bills), 6 - Лицензии(licenses), 7 - Договора(ДУ, уставы, ДПОИ)(agreements), 8 - Нормативно - справочная информации(nsi), 9 - Раскрытие деятельности УО(disclosure), 10 - Запросы о наличии задолженности по оплате ЖКУ(debtreq) GisFileStorages (обязательное) 1 OrgGuid (Передается в Header) Идентификатор организации в ГИС String (обязательное) 1 File Передается посредством multipart/form-data Object (обязательное) 1 ОтветПараметр Описание Тип AttachmentGuid Идентификатор файла string AttachmentHash Хэш-тег вложения по алгоритму ГОСТ в binhex string -
POST: /api/files/reload вернуться к оглавлениюПерезагрузить файл в подсистеме ГИС ЖКХ (синхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FileGuid Идентификатор файла в ГИС(обычно AttachmentGuid) string (обязательное) 1 Storage Подсистема, где хранится файл: 0 - Управление домами, Лицевые счета(homemanagement), 1 - Реестр коммунальной инфраструктуры(rki), 2 - Голосования(voting), 3 - Инспектирование жилищного фонда(inspection), 4 - Оповещения (informing), 5 - Электронные счета (bills), 6 - Лицензии (licenses), 7 - Договора(ДУ, уставы, ДПОИ) (agreements), 8 - Нормативно-справочная информации (nsi), 9 - Раскрытие деятельности УО (disclosure), 10 - Запросы о наличии задолженности по оплате ЖКУ (debtreq) string (обязательное) 1 OrgGuid Идентификатор организации string (обязательное) 1 ОтветПараметр Описание Тип AttachmentGuid Идентификатор файла string AttachmentHash Хэш-тег вложения по алгоритму ГОСТ в binhex string
-
Наверх