Лицензии
Атрибут | Значение |
---|---|
Название | info-radar-licenses |
Тип | Адаптер для получения информации по лицензиям |
Наименование | Лицензии |
Версия | Реализовано 21.07.2025 |
Сервис для получения информации по лицензиям.
Общая информация
Цель документации — обеспечить полное понимание и возможность эффективного использования сервиса как для конечных пользователей, так и для разработчиков.
Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
service | Имя сервиса (всегда info-radar-licenses ) |
string | + | info-radar-licenses |
type | Тип запроса | string (enum) | + | documents |
data | Данные запроса | object | + | см. ниже |
Типы запросов type
type | Значение |
---|---|
licenses | Получение информации о лицензиях |
Структура data
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
EntityId | Идентификатор лица | string(uuid) | + | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
EntityType | Тип лица | string | + | "Company" |
Source | Источник данных лицензии | string | - | "Fns" |
Status | Статус лицензии | boolean | - | true |
Categories | Категории видов деятельности | array[string] | - | ["Строительство", "Проектирование"] |
OrderBy | Сортировка | string | - | "DateDescending" |
Page | Номер страницы | integer | - | 1 |
Описаниe: Идентификатор лица.
Тип данных: string (uuid)
Обязательное: +
Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Описаниe: Тип лица (например, компания, физическое лицо и т.п.).
Тип данных: string
Обязательное: +
Пример: Company
Возможные значения: Company, Person, ForeignCompany, Entrepreneur, MunicipalSubject
Описание: Статус лицензии (действующая/недействующая).
Тип данных: boolean
Обязательное: -
Пример: true
Описание: Источник данных лицензии.
Тип данных: string
Обязательное: -
Пример: Fns
Возможные значения: Fns, Roskomnadzor, Rospotrebnadzor, Roszdravnadzor, Rosalkogolregulirovanie, Rosobrnadzor, Rosvodresurs
Описание: Категории видов деятельности по лицензии.
Тип данных: array[string]
Обязательное: -
Пример: ["Строительство", "Проектирование"]
Описаниe: Параметр сортировки результатов (например, по дате от меньшего к большему или наоборот).
Тип данных: string
Обязательное: -
Пример: DateDescending
Возможные значения: DateAscending, DateDescending
Описаниe: Номер страницы для постраничного получения данных.
Тип данных: integer
Обязательное: -
Пример: 1
Параметры ответа
Параметр | Название | Обязательное | Тип | Пример |
---|---|---|---|---|
success | Статус запроса | + | string | true |
result | Хеш с результатом | - | object | См. ниже |
exception | Ошибка | - | string | Что-то пошло не так |
Параметры result
Поле | Назначение | Тип | Обязательное | Пример |
---|---|---|---|---|
Aggregations | Агрегационные данные | object | - | Составной элемент Aggregations |
TotalItems | Общее число элементов | integer | - | 0 |
Items | Массив дел | array[object] | - | Items |
Структура элемента Aggregations
Поле | Назначение | Тип | Пример |
---|---|---|---|
Имя агрегационной группы | array[object] | элемент Aggregations |
Элемент массива
Поле | Назначение | Тип | Пример |
---|---|---|---|
Id | Уникальный идентификатор лицензии | string (uuid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
Number | Номер лицензии | string | "string" |
Status | Статус лицензии (активна/неактивна) | boolean | true |
LicensingOrganName | Наименование выдавшего органа | string | "string" |
AssignDate | Дата присвоения лицензии | string (date-time) | "2025-08-14T11:37:06.836Z" |
StartDate | Дата начала действия лицензии | string (date-time) | "2025-08-14T11:37:06.836Z" |
EndDate | Дата окончания действия лицензии | string (date-time) | "2025-08-14T11:37:06.836Z" |
Source | Источник данных | string | "Fns" |
ActivityTypes | Массив видов деятельности | array[object] | [см. ActivityTypes] |
Addresses | Массив адресов | array[object] | [см. Addresses] |
Поле | Назначение | Тип | Пример |
---|---|---|---|
Value | Значение по ключу агрегации | string | "Пользование недрами" |
Name | Название категории или признака | string | "Пользование недрами" |
Count | Количество элементов | integer | 2 |
Поле | Назначение | Тип | Пример |
---|---|---|---|
Name | Наименование вида | string | "string" |
Category | Категория вида деятельности | string | "string" |
Поле | Назначение | Тип | Пример |
---|---|---|---|
Address | Текстный адрес | string | "string" |
Пример json запроса
{
"service": "info-radar-licenses",
"type": "licenses",
"data": {
"EntityId": "34f0e4b2-1553-4880-bbe2-853f65ed65f3",
"EntityType": "Company",
"OrderBy": "DateAscending",
"Page": 1
}
}
Примеры json ответов
{
"success": true,
"result": {
"Aggregations": {
"Category": [
{
"Value": "Другое",
"Name": "Другое",
"Count": 1
},
{
"Value": "Пользование недрами",
"Name": "Пользование недрами",
"Count": 1
}
],
"Source": [
{
"Value": "Rosalkogolregulirovanie",
"Name": "Росалкогольрегулирование",
"Count": 1
},
{
"Value": "Rosvodresurs",
"Name": "Росводресурс",
"Count": 1
}
],
"Status": [
{
"Value": false,
"Name": "Недействительные",
"Count": 2
}
]
},
"TotalItems": 2,
"Items": [
{
"Id": "ee31f376-80b-b5e6-0776bd936e89",
"Number": "50ААО0ФФ3764",
"Status": false,
"LicensingOrganName": "Министерство потребительского рынка и услуг Московской области",
"AssignDate": null,
"StartDate": "2016-10-07T00:00:00",
"EndDate": "2019-10-06T00:00:00",
"Source": "Rosalkogolregulirovanie",
"ActivityTypes": [
{
"Name": "Розничная продажа, общепит",
"Category": "Другое"
}
],
"Addresses": [
{
"Address": "Россия,,50,,,,,,,,г.о. Солнечногорск, д. Льялово, территория, стр. 3, 1 этаж, помещ. № 9, 2 этаж, помещ. № 2, ресторан"
}
]
},
{
"Id": "077f3e72-e93e-63d-32af4a015618",
"Number": "49283",
"Status": false,
"LicensingOrganName": "Кубанское БВУ",
"AssignDate": null,
"StartDate": "2006-12-08T00:00:00",
"EndDate": "2012-01-01T00:00:00",
"Source": "Rosvodresurs",
"ActivityTypes": [
{
"Name": "Сброс воды",
"Category": "Пользование недрами"
}
],
"Addresses": [
{
"Address": "МЗЫМТА/50/1"
}
]
}
]
}
}
Пример ошибки:
{
"success": false,
"exception": "Что-то пошло не так"
}