Водные объекты
Атрибут | Значение |
---|---|
Название | info-radar-water-resource |
Тип | Адаптер для получения информации о правах на водные объекты |
Наименование | Водные объекты |
Версия | Реализовано 21.07.2025 |
Сервис для получения информации о правах на водные объекты.
Общая информация
Цель документации — обеспечить полное понимание и возможность эффективного использования сервиса как для конечных пользователей, так и для разработчиков.
Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
service | Имя сервиса (всегда info-radar-water-resource ) |
string | + | info-radar-water-resource |
type | Тип запроса | string (enum) | + | water_rights |
data | Данные запроса | object | + | см. ниже |
Типы запросов type
type | Значение |
---|---|
water_rights | Получение информации по правам на водные ресурсов |
Структура data
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
EntityId | Идентификатор объекта | string(uuid) | + | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
EntityType | Тип объекта | string | - | "Company" |
OrderBy | Сортировка | string | - | "DateAscending" |
Page | Номер страницы | integer | - | 1 |
Описаниe: Идентификатор лица.
Тип данных: string (uuid)
Обязательное: +
Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Описаниe: Тип лица (например, компания, физическое лицо и т.п.).
Тип данных: string
Обязательное: +
Пример: Company
Возможные значения: Company, Person, ForeignCompany, Entrepreneur, MunicipalSubject
Описаниe: Параметр сортировки (например, по названию в алфавитном порядке).
Тип данных: string
Обязательное: -
Пример: NameAscending
Возможные значения: NameAscending, NameDescending, DateCreatedAscending, DateCreatedDescending
Описаниe: Номер страницы для пагинации результатов.
Тип данных: integer
Обязательное: -
Пример: 1
Параметры ответа
Параметр | Название | Обязательное | Тип | Пример |
---|---|---|---|---|
success | Статус запроса | + | string | true |
result | Хеш с результатом | - | object | См. ниже |
exception | Ошибка | - | string | Что-то пошло не так |
Параметры result
Поле | Назначение | Тип | Обязательное | Пример |
---|---|---|---|---|
TotalItems | Общее число элементов | integer | - | 0 |
Items | Массив дел | array[object] | - | Items |
Структура элемента Aggregations
Поле | Назначение | Тип | Пример |
---|---|---|---|
Имя агрегационной группы | array[object] | элемент Aggregations |
Элемент массива
Поле | Назначение | Тип | Пример |
---|---|---|---|
Id | Уникальный идентификатор записи | string (uuid) | "0e1a8b-476c-00cc-cbc-ab2e6ea3e9f7" |
RegistrationNumber | Регистрационный номер документа | string | "11-08.11.01.022-Р-АСФХ-С-2019-01311/00" |
DocumentSigningDate | Дата подписания документа | string (date-time) | "2019-04-12T00:00:00" |
RegistrationDate | Дата регистрации документа | string (date-time) | "2019-04-22T00:00:00" |
AuthorizedOrgan | Уполномоченный орган, выдающий документ | string | "Департамент области по природным ресурсам и экологии" |
WaterObjectName | Наименование водного объекта | string | "Река Жать, КАС/ВОЛГА/3242/45 (231312412312313121323)" |
WaterUsePlace | Место использования водного объекта | string | "Усилительный Пункт д Гагаринский (Смоленская обл.), 52°19'20"СШ 35°0'27"ВД " |
WaterUsePurpose | Цель использования водного объекта | string | "Сброс сточных, в том числе, дренажных вод" |
WaterUseType | Тип использования (например, совместное) | string | "совместное" |
WaterUseCapacityParameters | Параметры мощности использования (срок и объем) | string | "2019-2022: 9.488, в т.ч. для собств. нужд 9.488" |
WaterUseEnergyParameters | Параметры энергопотребления | string / nullable | null |
WaterUseAreaParameters | Параметры площади использования | string / nullable | null |
SpecialMarks | Особые отметки | string / nullable | null |
WaterUseBeginDate | Дата начала использования водного объекта | string (date-time) | "2019-04-22T00:00:00" |
WaterUseEndDate | Дата окончания использования водного объекта | string (date-time) | "2022-04-22T00:00:00" |
DocumentTerminationDate | Дата прекращения действия документа | string (date-time) | "2022-04-22T00:00:00" |
Пример json запроса
{
"service": "info-radar-water-resource",
"type": "water_rights",
"data": {
"EntityId": "34f0e4b2-1553-4880-bbe2-853f65ed65f3",
"EntityType": "Company",
"OrderBy": "DateAscending",
"Page": 1
}
}
Примеры json ответов
{
"success": true,
"result": {
"TotalItems": 2,
"Items": [
{
"Id": "0eb16a8b-476c-00cc-c2bc-ab2e6ea3e9f7",
"RegistrationNumber": "67-08.01.01.231321-Р-РСБХ-С-2019-01311/00",
"DocumentSigningDate": "2019-04-12T00:00:00",
"RegistrationDate": "2019-04-22T00:00:00",
"AuthorizedOrgan": "Департамент Смоленской области по природным ресурсам и экологии",
"WaterObjectName": "Река Гжать, КАС/ВОЛГА/3242/45 (231321412213123123)",
"WaterUsePlace": "Усилительный Пункт д Гагаринский район (Смоленская обл.), 12°29'50\"СШ 35°0'27\"ВД ",
"WaterUsePurpose": "Сброс сточных, в том числе, дренажных вод",
"WaterUseType": "совместное",
"WaterUseCapacityParameters": "2019-2022: 9.488, в т.ч. для собств. нужд 9.488",
"WaterUseEnergyParameters": null,
"WaterUseAreaParameters": null,
"SpecialMarks": null,
"WaterUseBeginDate": "2019-04-22T00:00:00",
"WaterUseEndDate": "2022-04-22T00:00:00",
"DocumentTerminationDate": "2022-04-22T00:00:00"
},
{
"Id": "7aeefc2d-fe94-dfe6-543e-dwadawdawd",
"RegistrationNumber": "47-01.04.03.3123-О-РСБХ-С-2019-05031/00",
"DocumentSigningDate": "2019-04-04T00:00:00",
"RegistrationDate": "2019-04-12T00:00:00",
"AuthorizedOrgan": "Комитет по природным ресурсам Ленинградской области",
"WaterObjectName": "Озеро Отрадное (Пюхя-ярви) (dawd23123123123123123)",
"WaterUsePlace": "Приозерский район, 100 км от устья, т.1: 31°48'7.02\"СШ 30°20'40.18\"ВД ",
"WaterUsePurpose": "Сброс сточных, в том числе, дренажных вод",
"WaterUseType": "совместное",
"WaterUseCapacityParameters": " (1-4 кв.): 4.66",
"WaterUseEnergyParameters": null,
"WaterUseAreaParameters": null,
"SpecialMarks": null,
"WaterUseBeginDate": "2019-04-12T00:00:00",
"WaterUseEndDate": "2024-04-30T00:00:00",
"DocumentTerminationDate": "2024-04-30T00:00:00"
}
]
}
}
Пример ошибки:
{
"success": false,
"exception": "Что-то пошло не так"
}