Подробности описания основных объектов системы в JSON-ответах

В JSON-ответах на запросы к системе встречается типовая структура данных, описывающая объект системы. Далее приведен разбор важной информации в этих описаниях.

Объект «Пользователь» (USER)

• "user_id": "" - уникальный идентификатор пользователя в системе;
• "user_type": "" - роль пользователя в системе;
• "first_name": "" - ФИО пользователя;
• "last_name": "" - ФИО пользователя;
• "middle_name": "" - ФИО пользователя;
• "email": "" - адрес электронной почты пользователя;
• "can_start_analyse_****": true\false - права пользователя на использование модулей системы (запуск различных типов анализов);
• "company_id": "" - уникальный идентификатор Компании пользователя в системе;
• "is_admin": true\false - параметр, определяющий административный доступ внутри одной компании (роль CLIENT ADMIN);
• "is_service": true\false - параметр, определяющий сервисные учетные записи.

Объект «Компания» (COMPANY)

• "company_id": "" - уникальный идентификатор компании в системе;
• "name": "" - наименование компании в системе.

Объект «Папка» (FOLDER)

• "time_created"\"time_updated" – время создания\изменения папки;
• "meta_data" – метаданные папки;
• "folder_id" – уникальный идентификатор папки в системе;
• "resolution_status" – статус папки.

Объект «Медиа» (MEDIA)

• "time_created"\"time_updated" – время создания\изменения файла;
• блок "tags" – тэги файла;
• "original_name" – оригинальное имя файла (на файловой системе клиента);
• "image_id" – уникальный идентификатор файла в системе;
• "original_url" - HTTP-ссылка на файл на сервере API.

Объект «Анализ» (ANALYSE)

• "time_created"\"time_updated" – время создания\изменения анализа;
• "analyse_id" - уникальный идентификатор анализа в системе;
• "folder_id" - уникальный идентификатор папки, содержащей анализ, в системе;
• "type" - тип анализа (BIOMETRY\QUALITY\DOCUMENTS);
• блок "results_data" - подробности результата анализа, значения зависят от типа анализа:
  • BIOMETRY - минимальный и максимальный процент совпадения лиц на фото в папке, значение от 0 до 1. При наличии в папке трех и более различных изображений минимальный и максимальный процент совпадения будет отличаться;
  • QUALITY - вероятность того, что лицо на видео «живое» (не переснято с экрана или бумажного носителя), значение от 0 до 1;
  • DOCUMENTS - результаты распознавания документов.
• "error_message" – сообщение об ошибке;
• "error_code" – код ошибки;
• блок "source_media" – блок содержит данные по оригинальным изображениям, поступившим на анализ;
• блок "results_media" – блок содержит данные по обработанным в процессе анализа изображениям. В случае биометрического анализа изображения обработаны детектором лиц;
• "resolution" – решение по анализу. Доступные варианты:
  • SUCCESS - решение по анализу положительное;
  • DECLINED - решение по анализу отрицательное;
  • OPERATOR_REQUIRED - требуется решение оператора;
  • PROCESSING - анализ находится в процессе обработки;
  • FAILED - в процессе анализа возникли технические ошибки.