# Уведомления
# Получение списка уведомлений  <span id="receiving-notification-list" />

## Параметры <span id="receiving-notification-list-parameters" />

| HTTP метод | Права доступа                                                                                                           | URL                                                           | Параметры                                                                            | Примечание                                |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------- |
| GET        | [web\_notificator](/article/ru/308#web-notificator) | https://api.admitad.com/web\_notificator/v1/web\_notificator/ | [Список параметров для запроса](#receiving-notification-list-parameter-request-list) | Возвращает список доступных уведомлений\* |

\* Возвращает результат в формате JSON.

## Список параметров для запроса <span id="receiving-notification-list-parameter-request-list" />

| Название    | Тип     | Допустимые значения                                                                                            | Примечание                                                              |
| ----------- | ------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| category    | char    | *finance* — Финансы                                                                                            | Возвращает уведомления с указанной категорией                           |
|             |         | *system* — Система                                                                                             |                                                                         |
|             |         | *promotions* — Промоакции                                                                                      |                                                                         |
|             |         | other — Другое                                                                                                 |                                                                         |
|             |         | Пример: ?category\=finance                                                                                     |                                                                         |
| status      | char    | *not\_read* — Не прочитано                                                                                     | Возвращает уведомления с указанным статусом                             |
|             |         | *read* — Прочитано                                                                                             |                                                                         |
|             |         | Пример: ?status\=read                                                                                          |                                                                         |
| start\_date | string  | Пример: ?start\_date\=%d.%m.%Y %H:%M:%S                                                                        | Возвращает уведомления, которые были получены, начиная с указанной даты |
| end\_date   | string  | Пример: ?end\_date\=%d.%m.%Y %H:%M:%S                                                                          | Возвращает уведомления, которые были получены до указанной даты         |
| search      | string  | Пример: ?search\=test\_subject                                                                                 | Поиск по заголовку уведомления                                          |
| limit       | integer | [Параметры limit, offset](/article/ru/310) |                                                                         |
| offset      | integer | [Параметры limit, offset](/article/ru/310) |                                                                         |

## Пример использования <span id="receiving-notification-list-example-of-use" />

Пример запроса с использованием утилиты curl:

```
curl -L -H 'Authorization: Bearer access_token -X GET https://api.admitad.com/web_notificator/v1/web_notificator/
```

Пример ответа API-сервера в формате JSON:

```
{  
    "id": 6,  
    "status": "finance",  
    "category": "read",  
    "when_read": null,  
    "date_created": '15.02.2021 16:08:40',  
    "translate": {  
        "id": 5,  
        "subject": "dsf",  
        "text": "sdfsd"  
    }  
}
```

## Описание полей ответа API-сервера <span id="receiving-notification-list-description-of-api-server-response-fields" />

| Название      | Тип      | Описание                             |
| ------------- | -------- | ------------------------------------ |
| id            | int      | Идентификатор уведомления            |
| status        | char     | Статус уведомления.                  |
|               |          | not\_read — Не прочитано             |
|               |          | read — Прочитано                     |
| category      | char     | Категория уведомления                |
| when\_read    | datetime | Дата прочтения уведомления           |
|               |          | Формат: %Y-%m-%dT%H:%M:%S            |
|               |          | Пример: 2020-12-02T17:15:28          |
| date\_created | datetime | Дата получения уведомления           |
|               |          | Формат: %Y-%m-%dT%H:%M:%S            |
|               |          | Пример: 2020-12-02T17:15:28          |
| translate     | object   | Объект с информацией об уведомлении. |

Параметры объекта translate

| Название | Тип  | Описание               |
| -------- | ---- | ---------------------- |
| id       | int  | Идентификатор объекта. |
| subject  | char | Заголовок уведомления. |
| text     | char | Текст уведомления.     |

## Описание полей ответа API-сервера <span id="doc-id-2" />

| Название      | Тип      | Описание                                                                            |
| ------------- | -------- | ----------------------------------------------------------------------------------- |
| id            | int      | Идентификатор уведомления                                                           |
| status        | char     | Статус уведомления. Пример:                                                         |
|               |          | not\_read — Не прочитано                                                            |
|               |          | read — Прочитано                                                                    |
| category      | char     | Категория уведомления                                                               |
| when\_read    | datetime | Дата прочтения уведомления.  Формат: %Y-%m-%dT%H:%M:%S  Пример: 2020-12-02T17:15:28 |
| date\_created | datetime | Дата получения уведомления.                                                         |
|               |          | Формат: %Y-%m-%dT%H:%M:%S                                                           |
|               |          | Пример: 2020-12-02T17:15:28                                                         |
| translate     | object   | Объект с информацией об уведомлении.                                                |

# Изменение уведомления <span id="changing-notification" />

## Параметры <span id="changing-notification-parameters" />

| HTTP метод | Права доступа                                                                                                           | URL                                                                               | Параметры | Примечание                                                                   |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------- |
| POST       | [web\_notificator](/article/ru/308#web-notificator) | https://api.admitad.com/web\_notificator/v1/web\_notificator/{id}/mark\_as\_read/ |           | Возвращает обновленное уведомление, где id — это идентификатор уведомления\* |

\* Возвращает результат в формате JSON.

## Пример использования <span id="changing-notification-example-of-use" />

Пример запроса с использованием утилиты curl:

```
curl -L -H 'Authorization: Bearer access_token' -H "Content-Type: application/json" -X POST https://api.admitad.com/web_notificator/v1/web_notificator/63/mark_as_read/'
```

Пример ответа API-сервера в формате JSON:

```
{  
    "id": 6,  
    "status": "read",  
    "category": "finance",  
    "when_read": "2020-12-02T17:15:28",  
    "date_created": '15.02.2021 16:08:40',  
    "translate": {  
        "id": 5,  
        "subject": "dsf",  
        "text": "sdfsd"  
    }  
}
```

## Описание полей ответа API-сервера <span id="changing-notification-description-of-api-server-response-fields" />

| Название      | Тип      | Описание                             |
| ------------- | -------- | ------------------------------------ |
| id            | int      | Идентификатор уведомления            |
| status        | char     | Статус уведомления. Пример:          |
|               |          | not\_read — Не прочитано             |
|               |          | read — Прочитано                     |
| category      | char     | Категория уведомления                |
| when\_read    | datetime | Дата прочтения уведомления.          |
|               |          | Формат: %Y-%m-%dT%H:%M:%S            |
|               |          | Пример: 2020-12-02T17:15:28          |
| date\_created | datetime | Дата получения уведомления.          |
|               |          | Формат: %Y-%m-%dT%H:%M:%S            |
|               |          | Пример: 2020-12-02T17:15:28          |
| translate     | object   | Объект с информацией об уведомлении. |

# Отметить все уведомления как прочитанные <span id="mark-all-notifications-as-read" />

## Параметры <span id="mark-all-notifications-as-read-parameters" />

| HTTP метод | Права доступа                                                                                                           | URL                                                                               | Параметры | Примечание                                |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------- | ----------------------------------------- |
| POST       | [web\_notificator](/article/ru/308#web-notificator) | https://api.admitad.com/web\_notificator/v1/web\_notificator/mark\_all\_as\_read/ |           | Отмечает все уведомления как прочитанные. |

\* Возвращает статус-код 200 с пустым телом ответа.

## Пример использования <span id="mark-all-notifications-as-read-example-of-use" />

Пример запроса с использованием утилиты curl:

```
curl -L -H 'Authorization: Bearer access_token -X POST https://api.admitad.com/web_notificator/v1/web_notificator/mark_all_as_read/
```