Sections in this category

Уведомления

  • Обновлено

Получение списка уведомлений

Параметры

HTTP метод

Права доступа

URL

Параметры

Примечание

GET web_notificator https://api.admitad.com/web_notificator/v1/web_notificator/ Список параметров для запроса

Возвращает список доступных уведомлений*.

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

 

Список параметров для запроса

Название

Тип

Допустимые значения

Примечание

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  
offset integer Параметры limit, offset  

 

Пример использования

Пример запроса с использованием утилиты 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-сервера

Название

Тип

Описание

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-сервера

Название

Тип

Описание

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

Объект с информацией об уведомлении.

 

Изменение уведомления

Параметры

HTTP метод

Права доступа

URL

Параметры

Примечание

POST web_notificator https://api.admitad.com/web_notificator/v1/web_notificator/{id}/mark_as_read/  
  • Возвращает обновленное уведомление, где id — это идентификатор уведомления*.

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

 

Пример использования

Пример запроса с использованием утилиты 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-сервера

Название

Тип

Описание

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

Объект с информацией об уведомлении.

 

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

Параметры

HTTP метод

Права доступа

URL

Параметры

Примечание

POST web_notificator https://api.admitad.com/web_notificator/v1/web_notificator/mark_all_as_read/  

Отмечает все уведомления как прочитанные.

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

 

Пример использования

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

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

Была ли эта статья полезной?

Пользователи, считающие этот материал полезным: 0 из 0