`POST /checks/analytics`

Метод позволяет получить выводы на основании проверок

Заголовки

Название	Описание
Content-Type	Тип контента: `application/json`
Authorization	Заголовок авторизации

Тело запроса

Название	Тип	Формат	Обязательность	Описание
checks	array	`GUID`	`false`	Список проверок, которые необходимо проанализировать
groups	array	`GUID`	`false`	Список групп, которые необходимо проанализировать
result	object	`AnalyticResult`	`false`	Данные, которые хотим получить в результате анализа

В запросе должен содержаться один из объектов checks или groups

AnalyticResult

Название	Тип	Формат	Обязательность	Описание
options	object	`AnalyticResultOptions`	`true`	Параметры результата

AnalyticResultOptions

Название	Тип	Формат	Обязательность	Описание
reportIcon	object	`ContentInfo`	`false`	Иконка для брендирования отчета. Если не передано значение, то будет использоваться логотип Реестро
reportColour (временно не используется)	string		`true`	Цвет для брендирования ответа в формате HEX. Если не передано значение, то будет использоваться цвет #902987

Максимальный размер файла с иконкой 75кб, допустимые форматы .png, .jpg

Пример

POST /realty/assessment/v1/checks/analytics
Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
Content-Type: application/json

{
    "checks": [
        "904498e2-3ad4-44ec-9bfa-a8b8fea89d2b"
    ]
}

Ответы

201

Тело ответа

Анализ успешно завершен. В теле ответа содержится описание результата анализа AssessmentReport

Заголовки ответа

Название	Описание
Content-Type	Тип контента: `application/json`

Пример ответа

  HTTP 201
  Content-Type: Application/json

{
    "risks": [
        {
            "name": "Риск мошенничества",
            "reason": [
                {
                    "checkId": "904498e2-3ad4-44ec-9bfa-a8b8fea89d2b",
                    "result": "за короткий период времени объект часто менял собственников",
                    "recommendations": "попросить клиента принести вам справку о действительности документа",
                    "effects": "сделки с объектом могут признать недействительными"
                }
            ]
        }
    ],
    "report": {
        "data": {
            "contentId": "c6780dbc-126b-44f6-9f7b-7422609d8ebb",
            "contentType": "sig",
            "md5": "F7415E33F972C03ABD4F3FED36748F7A"
        }
    }
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки	Описание
WrongFieldValue	Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
AbsenceOfRequiredField	Отсутствует одно из обязательных полей
UnexistentSubject	Указанный идентификатор субъекта не существует
UnexistentCheck	Указанный идентификатор проверки, которая не существует
UnexistentGroup	Указанный идентификатор группы, которая не существует
WrongCheck	Проверка не принадлежит указанному субъекту/объекту
MismatchCheck	Указано несколько проверок одного типа для одного субъекта/объекта

Пример ответа

  HTTP 400
  Content-Type Application/json

 {
    "code": "validation",
    "message": "Failed to validate request",
    "target": "api",
    "errors": [
        {
            "code": "AbsenceOfRequiredField",
            "message": "SubjectId is required",
            "target": "AssessmentApi"
        }
    ]
}

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода

429

Слишком много параллельных запросов (больше 10 запросов в секунду)