SAURES API | object-notice

Уведомления

GET запрос

URL https://api.saures.ru/1.0/object/notice

Параметры запроса

sid uuid4	идентификатор сессии
id int	id объекта

Параметры ответа

[...]
list

текущий список уведомлений

Генератор HTTPie запроса (документация)

$ http GET https://api.saures.ru/1.0/object/notice -v

Пример

$ http GET https://api.saures.ru/1.0/object/notice sid=="92104027-908a-43dd-b18b-b06b918f696d" id=="10747" -v

GET /1.0/object/notice?sid=92104027-908a-43dd-b18b-b06b918f696d&id=10747

HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: api.saures.ru
User-Agent: HTTPie/0.9.8



HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 321
Content-Type: application/json; charset=utf-8
Strict-Transport-Security: max-age=31536000

{
    "data": [
        {
            "dispatch": "email",
            "id": 13880,
            "receiver": "newuser@saures.ru",
            "type": "notice+error"
        },
        {
            "dispatch": "push",
            "id": 13881,
            "receiver": "newuser@saures.ru",
            "type": "notice+error"
        },
        {
            "dispatch": "telegram",
            "id": 13882,
            "receiver": "newuser@saures.ru",
            "type": "notice+error"
        }
    ],
    "errors": [],
    "status": "ok"
}

POST запрос

URL https://api.saures.ru/1.0/object/notice

Параметры запроса

sid uuid4	идентификатор сессии
id int	id уведомления(Используется только при редактировании)
object_id int	id объекта, в котором необходимо создать уведомление(Используется только при создании)
delete int	id уведомления, которое необходимо удалить
type notification\|error\|notice+error
dispatch email\|push\|sms\|telegram
receiver email\|login\|phone	получатель уведомления: - телефон в формате +7XXXXXXXXXX для sms - логин пользователя для push и telegram - адрес эл.почты для email

Генератор HTTPie запроса (документация)

$ http --form POST https://api.saures.ru/1.0/object/notice -v

Пример

$ http --form POST https://api.saures.ru/1.0/object/notice sid="92104027-908a-43dd-b18b-b06b918f696d" object_id="10747" type="notice+error" dispatch="email" receiver="newuser@saures.ru" -v

POST /1.0/object/notice HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 120
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.saures.ru
User-Agent: HTTPie/0.9.8


  sid=92104027-908a-43dd-b18b-b06b918f696d&object_id=10747&type=notice%2Berror&dispatch=email&receiver=newuser%40saures.ru

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 42
Content-Type: application/json; charset=utf-8
Strict-Transport-Security: max-age=31536000

{
    "data": {},
    "errors": [],
    "status": "ok"
}