API - документация для разработчиков
Для упрощения процедуры размещения информации на портале ГИС ЖКХ мы предоставляем доступ ко всем функциям API ГИС ЖКХ через RESTful API (обмен данными в JSON-формате или XML-формате через защищённый протокол HTTPS).
Текущая версия API ГИС ЖКХ: 13.3.0.0
Текущая версия API ГИС ЖКХ: 13.3.0.0
Оглавление
- 1. Авторизация
- 2. Формат передачи данных
- 3. Возможные ответы от сервера
-
4. Список методов
-
Договоры управления, уставы и договоры ресурсоснабжения
- Получить договора управления (асинхронно)
- Получить статусы договоров управления (асинхронно)
- Получить договора ресурсоснабжения (асинхронно)
- Получить договора ресурсоснабжения (постранично) (асинхронно)
- Получить объекты договоров ресурсоснабжения (асинхронно)
- Получить объекты договоров ресурсоснабжения (постранично) (асинхронно)
- Получить краткую информацию о договорах ресурсоснабжения (асинхронно)
- Получить список договоров общего имущества (асинхронно)
- Создать сведения о размерах плат за услуги/работы по договору управления (асинхронно)
- Обновить договора управления дома (асинхронно)
-
Запросы о наличии задолженности за ЖКУ
- Получить запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)
- Получить подзапросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)
- Создать запросы о наличии задолженности за ЖКУ (организациями, направляющими запросы) (асинхронно)
- Создать ответы на запросы о наличии задолженности за ЖКУ (организациями, предоставляющими ЖКУ) (асинхронно)
-
Капитальный Ремонт
- Получить счета регионального оператора и специальные счета (асинхронно)
- Получить договора на выполнение работ (оказание услуг) по капитальному ремонту (асинхронно)
- Получить информацию о размере фонда (асинхронно)
- Создать/внести изменения в информацию о размере фондов (асинхронно)
- Создать информацию о совершенных операциях и остатках по счетам (асинхронно)
-
Платежные документы
- Получить платёжные документы (асинхронно)
- Получить страховые продукты (асинхронно)
- Получить перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)
- Получить перечень документов «Извещение о принятии к исполнению распоряжения» (постранично) (асинхронно)
- Получить информацию о состоянии расчетов с РСО/ИКУ (асинхронно)
- Создать информацию о состоянии расчетов с ИКУ (асинхронно)
- Создать информацию о состоянии расчетов с РСО (асинхронно)
- Создать перечень документов «Извещение о принятии к исполнению распоряжения» (асинхронно)
- Создать платёжные документы (асинхронно)
- Cоздать или изменить страховые продукты (асинхронно)
- Создать запрос на квитирование (асинхронно)
- Внести оплаты (асинхронно)
- Отозвать платёжные документы (асинхронно)
- Удалить страховые продукты (асинхронно)
- Отменить квитирование (асинхронно)
- Отменить оплаты (асинхронно)
-
Сервис обмена сведениями о работах и услугах
- Получить тарифы ЖКУ (асинхронно)
- Получить список работ (асинхронно)
- Получить план работ (асинхронно)
- Получить сведения о выполненных работах и услугах (асинхронно)
- Получить информацию об оценке качества работ и услуг (асинхронно)
- Создать/измененить основные сведения по перечню работ (асинхронно)
- Создать актуальные планы по перечню работ/услуг (асинхронно)
- Создать сведения о выполненных работах и услугах (асинхронно)
- Создать информацию об оценке качества работ и услуг (асинхронно)
- Аннулировать основные сведения по перечню работ (асинхронно)
- Отменить основные сведения по перечню работ (асинхронно)
-
Справочники НСИ поставщика информации
- Получить данные справочников поставщика информации (1, 51, 59, 219) (асинхронно)
- Получить данные справочников поставщика информации (постранично) (асинхронно)
- Изменить элементы справочника 1 «Дополнительные услуги» (асинхронно)
- Изменить элементы справочника 51 «Коммунальные услуги» (асинхронно)
- Изменить элементы справочника «Работ и услуг» (асинхронно)
-
Договоры управления, уставы и договоры ресурсоснабжения
Авторизация
Для того, чтобы вызвать любую функцию 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/houses/getAsync вернуться к оглавлениюПолучить дом (для УО/РСО) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений FiasHouseGuid Глобальный уникальный идентификатор дома по ФИАС string (обязательное) 1 IsFromCache Вернуть результат из кэша (не запрашивая из ГИС) boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 ОтветПараметр Описание Тип HouseUniqueNumber Уникальный номер дома на ГИС string ModificationDate Дата изменения string ApartmentHouse Многоквартирный дом ApartmentHouseDto Заполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецLivingHouse Жилой дом LivingHouseDto Заполните одно из полейКонецЗаполните одно из полейЗаполните одно из полейКонецЗаполните одно из полейКонецЗаполните одно из полейКонецКонец -
POST: /api/houses/updateAsync вернуться к оглавлениюОбновить дом (для УО) (асинхронно)Параметры запроса
Параметр Описание Тип Макс. кол-во вхождений InheritMissingValues Поле для запроса с обновлением данных, то отсутствующие в дельте значения будут подгружены из предыдущей версии сущности. В противном случае отсутствующие значения будут сброшены в NULL. boolean (опциональное) 1 OrgGuid Идентификатор зарегистрированной организации string (обязательное) 1 MessageGuid Уникальный идентификатор запроса string (опциональное) 1 Заполните одно из полейApartmentHouse Многоквартирный дом ApartmentHouseDto (обязательное) 1 Заполните одно из полейКонец
-