Загальна інформація про списки моніторингу клієнта

Повертає перелік всіх списків моніторингу. Якщо вказано search_text - фільтрує перелік - повертає тільки списки назва, назва/код отримувача або коментар яких включають текст <search_text>.
search_mode

0: всі переліки, які має право переглядати оператор;
1: тільки переліки клієнта оператора, які має право переглядати оператор
2: тільки переліки клієнта оператора, які має право редагувати оператор

Id що повертає функція в масиві items можна використовувати в інших функціях для керування списками моніторингу (зазвичай в ціх ф-ціях параметр зветься mt_id).
kinds - перелік видів джерел моніторингу по якому відслідковується список. Масив об’єктів з членами:

id : ідентифікатор виду джерела моніторингу (/monitoring/kinds/get)
schedule_id : ідентифікатор розкладу надсилання моніторингу (/monitoring/schedules/get)
in_separate_letter : признак, якщо встановлено - вказує що результати по цьому виду моніторингу завжди необхідно надсилати в листах (повідомленнях) відокремлених від листів (повідомлень) з іншими видами джерел (застаріло - використовувати message_format).
message_format
- "MailBodyCmn" - висилаються в листі, можливо буде об'єднано з повідомленнями інших джерел
- "MailBodySep" - висилаються в листі, не об'єднується з повідомленнями інших джерел,
- "XlsxAttached" - висилається в таблиці xlsx. завжди окремо для кожного джерела
Init_back_day_limit - кількість днів (число) або одна з фіксованих констант. Опис дивись в ./monitoring/listinfo/set

Request

Authorization

Add parameter in query

key

Example:

key: ********************

Query Params

search_text

string

required

відбирати за текстом

search_mode

string

optional

режим відбору списків

language

string

optional

3 літ. ISO 639-1

key

string

optional

ключ доступу

Responses

🟢200Success

application/json

Body

answer

object

required

items

array [object {13}]

required

count

integer

required

кількість знайдених списків

status

enum<string>

required

Allowed values:

SuccessWarningError

statusCode

integer

required

message

string

optional

Example

{
    "status": "Success",
    "statusCode": 301,
    "message": "",
    "answer": {
        "items": [
            {
                "id": "1",
                "receiver_name": "***БАНК",
                "receiver_code": "",
                "receiver_emails": [
                    "___n@???bank.com.ua",
                ],
                "list_name": "Перелік 2",
                "list_comment": "",
                "items_count": 160800,
                "available_pending_on_date": null,
                "pending_items_count": null,
                "kinds": [
                    {
                        "id": "MEDRCH",
                        "schedule_id": "1",
                        "filter_id": "20",
                        "in_separate_letter": true,
                        "message_format": "MailBodySep",
                        "init_back_day_limit": "none"
                    },
                    {
                        "id": "MSFGO",
                        "schedule_id": "1",
                        "filter_id": "17",
                        "in_separate_letter": true,
                        "message_format": "MailBodySep",
                        "init_back_day_limit": "365"
                    },
                    {
                        "id": "MWNTD1",
                        "schedule_id": "1",
                        "filter_id": null,
                        "in_separate_letter": false,
                        "message_format": "MailBodyCmn",
                        "init_back_day_limit": "any_time"
                    }
               ],
                "editable": false,
                "deactivated_by": "system",
                "deactivated_time": "2024-05-01 00:45:11.853"
            }
       ],
        "count": 1
    }
}