Подраздел: Метод «Folder [LIST]» (GET)

Метод «Folder [LIST]» применяется для просмотра всех папок, доступных пользователю в системе, с возможностью фильтрации по выводимым результатам.

Дополнительные параметры запроса.

Все параметры данного метода по необходимости добавляются в заголовок запроса. Все параметры не обязательные.

Визуальные параметры:

  • offset=;
    Числовой параметр смещение для пагинации данных относительно начала списка, по умолчанию 0;
  • limit=;
    Числовой параметр, ограничивающий число выводимых папок, по умолчанию 100;
  • sorting=;
    Сортировка выводимого результата по времени создания\обновления, доступные варианты:
    • time_created{asc} - по времени создания, от старых к новым;
    • time_created{desc} - по времени создания, от новых к старым;
    • time_updated{asc} - по времени обновления, от старых к новым;
    • time_updated{desc} - по времени обновления, от новых к старым.

Фильтрация вывода:

  • time_created.max=;
    Максимальное время создания папки в формате UNIX TIMESTAMP, следует использовать в паре с параметром time_created.min;
  • time_created.min=;
    Минимальное время создания папки в формате UNIX TIMESTAMP, следует использовать в паре с параметром time_created.max;
  • time_updated.max=;
    Максимальное время изменения папки в формате UNIX TIMESTAMP, следует использовать в паре с параметром time_ updated.min;
  • time_updated.min=;
    Минимальное время изменения папки в формате UNIX TIMESTAMP, следует использовать в паре с параметром time_ updated.max;
  • meta_data=;
    Текстовый поиск по метаданным папок, доступны операторы:
    • «==» - равно;
    • «!=» - не равно.
  • resolution_status=;
    Фильтрация по статусу папки, доступные варианты статусов:
    • INITIAL – начальный статус;
    • PROCESSING – анализаторы находятся в процессе работы;
    • FAILED – при работе анализаторов произошел технический или логический сбой;
    • FINISHED – данные обработаны;
    • DECLINED – по папке принято отрицательное решение (изображения или видео папки не удовлетворяют критериям качества);
    • SUCCESS – по папке принято положительное решение.
  • resolution_status.exclude=;
    Фильтрация по статусу папки, исключающий параметр. Указанные в данном параметре статусы не попадут в выборку;
  • folder_id=;
    Фильтрация по уникальному идентификатору папки;
  • folder_id.exclude=;
    Фильтрация по уникальному идентификатору папки, исключающий параметр. Указанные в данном параметре ID не попадут в выборку.

Вывод дополнительной информации в ответе:

  • with_analyses=true;
    Включение параметра отображает в JSON-ответе метода результаты анализов в папке аналогично методу «Folder Analyses [LIST]»;
  • with_user=true;
    Включение параметра отображает в JSON-ответе информацию по создавшему папку пользователю;
  • with_company=true;
    Включение параметра отображает в JSON-ответе информацию по компании создавшей папку пользователя.

Примеры запросов.

Пример выполнения метода «Folder [LIST]» в ПО «Postman»:

Примеры синтаксиса GET-запроса методом «Folder [LIST]» со следующими параметрами:

  • Нисходящая сортировка по времени создания папки;
  • Ограничение отображения по количеству в 3 результата;
  • Отображение пользователя-создателя папок;
  • Исключение из отображения папки с идентификатором «906f6898-048e-4192-8c09-a1853b6f59b9»;
  • Метаданные содержат запись «iin» со значением «test11234567».

HTTP

Bash

Python

php

Java


GET /api/folders/?limit=3& sorting=time_created{desc}& meta_data=iin==test11234567& folder_id.exclude=906f6898-048e-4192-8c09-a1853b6f59b9& with_user=true HTTP/1.1
Host: youradress.ru
X-Forensic-Access-Token: 0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1
User-Agent: PostmanRuntime/7.15.2
Accept: */*
Cache-Control: no-cache
Postman-Token: 8248323a-3e32-41cd-98cb-215fe70bb57f,cd290740-68a1-4a07-81ed-da35819a8602
Host: youradress.ru
Accept-Encoding: gzip, deflate
Connection: keep-alive
cache-control: no-cache


curl -X GET \
  'https://youradress.ru/api/folders/?limit=3&sorting=time_created{desc}&meta_data=iin==test11234567&folder_id.exclude=906f6898-048e-4192-8c09-a1853b6f59b9&with_user=true' \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Host: youradress.ru' \
  -H 'Postman-Token: 8248323a-3e32-41cd-98cb-215fe70bb57f,48cf855e-cf80-4bda-abe4-a43a307d596f' \
  -H 'User-Agent: PostmanRuntime/7.15.2' \
  -H 'X-Forensic-Access-Token: 0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1' \
  -H 'cache-control: no-cache'


import requests

url = "https://youradress.ru/api/folders/"

querystring = {"limit":"3","sorting":"time_created{desc}","meta_data":"iin==test11234567","folder_id.exclude":"906f6898-048e-4192-8c09-a1853b6f59b9","with_user":"true"}

headers = {
    'X-Forensic-Access-Token': "0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1",
    'User-Agent': "PostmanRuntime/7.15.2",
    'Accept': "*/*",
    'Cache-Control': "no-cache",
    'Postman-Token': "8248323a-3e32-41cd-98cb-215fe70bb57f,d9e635d6-42ea-4948-9337-49e1920e2224",
    'Host': "youradress.ru",
    'Accept-Encoding': "gzip, deflate",
    'Connection': "keep-alive",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)


setUrl('https://youradress.ru/api/folders/');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'limit' => '3',
  'sorting' => 'time_created{desc}',
  'meta_data' => 'iin==test11234567',
  'folder_id.exclude' => '906f6898-048e-4192-8c09-a1853b6f59b9',
  'with_user' => 'true'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Connection' => 'keep-alive',
  'Accept-Encoding' => 'gzip, deflate',
  'Host' => 'youradress.ru',
  'Postman-Token' => '8248323a-3e32-41cd-98cb-215fe70bb57f,6d8e5f47-d580-4f05-baad-61414ff59847',
  'Cache-Control' => 'no-cache',
  'Accept' => '*/*',
  'User-Agent' => 'PostmanRuntime/7.15.2',
  'X-Forensic-Access-Token' => '0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://youradress.ru/api/folders/?limit=3&sorting=time_created{desc}&meta_data=iin==test11234567&folder_id.exclude=906f6898-048e-4192-8c09-a1853b6f59b9&with_user=true")
  .get()
  .addHeader("X-Forensic-Access-Token", "0ccbdb4627c9d07c6c5b8f6e6cca44b5f8cb0c54ad7659098fa336240d494b0f9035e14bc42fc461224a9719f105e41026fed0f6f14188d9107b8c3d697a0cb1")
  .addHeader("User-Agent", "PostmanRuntime/7.15.2")
  .addHeader("Accept", "*/*")
  .addHeader("Cache-Control", "no-cache")
  .addHeader("Postman-Token", "8248323a-3e32-41cd-98cb-215fe70bb57f,69c8f046-2903-45b6-bd44-b57cd658bfe6")
  .addHeader("Host", "youradress.ru")
  .addHeader("Accept-Encoding", "gzip, deflate")
  .addHeader("Connection", "keep-alive")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

Пример JSON-ответа.

Пример JSON-ответа системы на вызов метода «Folder [LIST]» с аналогичными параметрами:

JSON


{
    "offset": 0,
    "limit": 3,
    "total_count": 4,
    "items": [
        {
            "time_created": 1579681651,
            "time_updated": 1579681651,
            "meta_data": {
                "iin": "test11234567"
            },
            "folder_id": "7074a87e-3c65-423f-99a9-d21324e75395",
            "resolution_time": null,
            "resolution_status": "INITIAL",
            "resolution_endpoint": null,
            "resolution_state_hash": "453e0aa12c7bbd05",
            "resolution_comment": null,
            "resolution_suggest": null,
            "resolution_author_id": null,
            "is_archive": false,
            "media": [
                {
                    "time_created": 1579681651,
                    "time_updated": 1579681651,
                    "meta_data": {},
                    "media_id": "052c8748-b4ef-4f0f-8ea5-17297552a92d",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "933fa1f5dd44d2c43f75e8044d4fa7a1",
                            "size": 17070,
                            "width": 300,
                            "height": 280,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "54b5d75d01488817bf041a5273de4585",
                            "size": 50971,
                            "width": 445,
                            "height": 416,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_selfie"
                    ],
                    "original_name": "2.jpg",
                    "image_id": "052c8748-b4ef-4f0f-8ea5-17297552a92d",
                    "original_url": "http://youradress.ru/static/7074a87e-3c65-423f-99a9-d21324e75395/052c8748-b4ef-4f0f-8ea5-17297552a92d.jpeg",
                    "thumb_url": "http://youradress.ru/static/7074a87e-3c65-423f-99a9-d21324e75395/052c8748-b4ef-4f0f-8ea5-17297552a92d_thumb.jpeg"
                },
                {
                    "time_created": 1579681651,
                    "time_updated": 1579681651,
                    "meta_data": {},
                    "media_id": "af4da4fe-61b1-49ea-bea1-3d5bde57a205",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "1827f89da365f01a24deb0329d231f80",
                            "size": 18261,
                            "width": 300,
                            "height": 300,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "9b1393886e54d93e1303ff284ae4dedf",
                            "size": 147204,
                            "width": 492,
                            "height": 492,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_id"
                    ],
                    "original_name": "1.jpg",
                    "image_id": "af4da4fe-61b1-49ea-bea1-3d5bde57a205",
                    "original_url": "http://youradress.ru/static/7074a87e-3c65-423f-99a9-d21324e75395/af4da4fe-61b1-49ea-bea1-3d5bde57a205.jpeg",
                    "thumb_url": "http://youradress.ru/static/7074a87e-3c65-423f-99a9-d21324e75395/af4da4fe-61b1-49ea-bea1-3d5bde57a205_thumb.jpeg"
                }
            ],
            "user": {
                "user_id": "7b10dac0-e6ac-4138-a1af-c6cb2addcce1",
                "user_type": "CLIENT",
                "first_name": "FAQTest",
                "last_name": "FAQTest",
                "middle_name": "",
                "email": "manualtest@oz-services.ru",
                "can_start_analyse_biometry": true,
                "can_start_analyse_collection": true,
                "can_start_analyse_documents": true,
                "can_start_analyse_forensic": true,
                "can_start_analyse_kyc": true,
                "can_start_analyse_quality": true,
                "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
                "is_admin": false,
                "is_service": true
            }
        },
        {
            "time_created": 1579681651,
            "time_updated": 1579681651,
            "meta_data": {
                "iin": "test11234567"
            },
            "folder_id": "2dce78c6-833b-4016-b8ad-d44dc03bcb9c",
            "resolution_time": null,
            "resolution_status": "INITIAL",
            "resolution_endpoint": null,
            "resolution_state_hash": "e0b8a094c4c87428",
            "resolution_comment": null,
            "resolution_suggest": null,
            "resolution_author_id": null,
            "is_archive": false,
            "media": [
                {
                    "time_created": 1579681651,
                    "time_updated": 1579681651,
                    "meta_data": {},
                    "media_id": "35854e01-75e4-44a0-a20d-e75ecc4ae4cd",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "933fa1f5dd44d2c43f75e8044d4fa7a1",
                            "size": 17070,
                            "width": 300,
                            "height": 280,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "54b5d75d01488817bf041a5273de4585",
                            "size": 50971,
                            "width": 445,
                            "height": 416,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_selfie"
                    ],
                    "original_name": "2.jpg",
                    "image_id": "35854e01-75e4-44a0-a20d-e75ecc4ae4cd",
                    "original_url": "http://youradress.ru/static/2dce78c6-833b-4016-b8ad-d44dc03bcb9c/35854e01-75e4-44a0-a20d-e75ecc4ae4cd.jpeg",
                    "thumb_url": "http://youradress.ru/static/2dce78c6-833b-4016-b8ad-d44dc03bcb9c/35854e01-75e4-44a0-a20d-e75ecc4ae4cd_thumb.jpeg"
                },
                {
                    "time_created": 1579681651,
                    "time_updated": 1579681651,
                    "meta_data": {},
                    "media_id": "679cc0c4-8701-4b09-8108-77aaf6ec70ff",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "1827f89da365f01a24deb0329d231f80",
                            "size": 18261,
                            "width": 300,
                            "height": 300,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "9b1393886e54d93e1303ff284ae4dedf",
                            "size": 147204,
                            "width": 492,
                            "height": 492,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_id"
                    ],
                    "original_name": "1.jpg",
                    "image_id": "679cc0c4-8701-4b09-8108-77aaf6ec70ff",
                    "original_url": "http://youradress.ru/static/2dce78c6-833b-4016-b8ad-d44dc03bcb9c/679cc0c4-8701-4b09-8108-77aaf6ec70ff.jpeg",
                    "thumb_url": "http://youradress.ru/static/2dce78c6-833b-4016-b8ad-d44dc03bcb9c/679cc0c4-8701-4b09-8108-77aaf6ec70ff_thumb.jpeg"
                }
            ],
            "user": {
                "user_id": "7b10dac0-e6ac-4138-a1af-c6cb2addcce1",
                "user_type": "CLIENT",
                "first_name": "FAQTest",
                "last_name": "FAQTest",
                "middle_name": "",
                "email": "manualtest@oz-services.ru",
                "can_start_analyse_biometry": true,
                "can_start_analyse_collection": true,
                "can_start_analyse_documents": true,
                "can_start_analyse_forensic": true,
                "can_start_analyse_kyc": true,
                "can_start_analyse_quality": true,
                "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
                "is_admin": false,
                "is_service": true
            }
        },
        {
            "time_created": 1579681650,
            "time_updated": 1579681650,
            "meta_data": {
                "iin": "test11234567"
            },
            "folder_id": "169de252-9da2-4b43-9f39-0fee6fbe1be1",
            "resolution_time": null,
            "resolution_status": "INITIAL",
            "resolution_endpoint": null,
            "resolution_state_hash": "6fcaad33b3fa21a7",
            "resolution_comment": null,
            "resolution_suggest": null,
            "resolution_author_id": null,
            "is_archive": false,
            "media": [
                {
                    "time_created": 1579681650,
                    "time_updated": 1579681650,
                    "meta_data": {},
                    "media_id": "77e754f1-b7f7-44c3-bd48-0bdc0ac2b3dd",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "933fa1f5dd44d2c43f75e8044d4fa7a1",
                            "size": 17070,
                            "width": 300,
                            "height": 280,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "54b5d75d01488817bf041a5273de4585",
                            "size": 50971,
                            "width": 445,
                            "height": 416,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_selfie"
                    ],
                    "original_name": "2.jpg",
                    "image_id": "77e754f1-b7f7-44c3-bd48-0bdc0ac2b3dd",
                    "original_url": "http://youradress.ru/static/169de252-9da2-4b43-9f39-0fee6fbe1be1/77e754f1-b7f7-44c3-bd48-0bdc0ac2b3dd.jpeg",
                    "thumb_url": "http://youradress.ru/static/169de252-9da2-4b43-9f39-0fee6fbe1be1/77e754f1-b7f7-44c3-bd48-0bdc0ac2b3dd_thumb.jpeg"
                },
                {
                    "time_created": 1579681650,
                    "time_updated": 1579681650,
                    "meta_data": {},
                    "media_id": "4bb5a786-b495-4af5-bf33-fd94e32281d1",
                    "media_type": "IMAGE_FOLDER",
                    "info": {
                        "thumb": {
                            "md5": "1827f89da365f01a24deb0329d231f80",
                            "size": 18261,
                            "width": 300,
                            "height": 300,
                            "mime-type": "image/jpeg"
                        },
                        "original": {
                            "md5": "9b1393886e54d93e1303ff284ae4dedf",
                            "size": 147204,
                            "width": 492,
                            "height": 492,
                            "mime-type": "image/jpeg"
                        }
                    },
                    "tags": [
                        "photo_id"
                    ],
                    "original_name": "1.jpg",
                    "image_id": "4bb5a786-b495-4af5-bf33-fd94e32281d1",
                    "original_url": "http://youradress.ru/static/169de252-9da2-4b43-9f39-0fee6fbe1be1/4bb5a786-b495-4af5-bf33-fd94e32281d1.jpeg",
                    "thumb_url": "http://youradress.ru/static/169de252-9da2-4b43-9f39-0fee6fbe1be1/4bb5a786-b495-4af5-bf33-fd94e32281d1_thumb.jpeg"
                }
            ],
            "user": {
                "user_id": "7b10dac0-e6ac-4138-a1af-c6cb2addcce1",
                "user_type": "CLIENT",
                "first_name": "FAQTest",
                "last_name": "FAQTest",
                "middle_name": "",
                "email": "manualtest@oz-services.ru",
                "can_start_analyse_biometry": true,
                "can_start_analyse_collection": true,
                "can_start_analyse_documents": true,
                "can_start_analyse_forensic": true,
                "can_start_analyse_kyc": true,
                "can_start_analyse_quality": true,
                "company_id": "d5b935aa-6745-47b6-a72d-20a418116a29",
                "is_admin": false,
                "is_service": true
            }
        }
    ]
}

Подробности JSON-ответа.

Первый блок ответа (стр.2-4) содержит общую информацию, в нем можно увидеть что всего по запросу было найдено 4 папки, при этом отображено только 3:

  • "limit": 3,
  • "total_count": 4.

Блок "items" (стр. 5-292) содержит основные данные по папкам.

Отображение каждой папки начинается с блока общей информации (стр. 7-20).

Блок "media" (стр.21-82) содержит информацию по файлам, размещенным в папках.

Блок "user" (стр. 83-100) содержит информацию по пользователю, создавшему папку.