4.2.4.4. Получение списка линий, подключенных пользователям

Краткие сведения


Типы запросов
GET 
ОписаниеПолучение списка линий, подключенных пользователям
Название

GetSubscriptions

URL/v1/line/subscriptions/

Описание

Метод возвращает информацию о получаемым линиям пользователями, с возможностью отфильтровать по пользователю, линии или клиенту.

Запрос к серверу

Параметры URL

ПолеТипОписание
user_idUUID?ID пользователя
client_idUUID?ID клинта
counterpart_owner_idUUID?ID контрагента, владелец пользователя (создавший клиента)
line_idUUID?ID линии поддержки

Пример

Информация по всем линиям и пользователям

GET /v1/line/subscriptions/ HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscriptions/" \
-H "accept: application/json" \
-u test:test

Информация по конкретной линии

GET /v1/line/subscriptions/?line_id=9d283236-262e-11ea-80fc-0025904f970f HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscriptions/?line_id=9d283236-262e-11ea-80fc-0025904f970f" \
-H "accept: application/json" \
-u test:test

Какие пользователи конкретного клиента подключены к конкретной линии

GET /v1/line/subscriptions/?client_id=be301b86-52da-45c5-9d8b-b805953e955b&line_id=9d283236-262e-11ea-80fc-0025904f970f HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscriptions/?client_id=be301b86-52da-45c5-9d8b-b805953e955b&line_id=9d283236-262e-11ea-80fc-0025904f970f" \
-H "accept: application/json" \
-u test:test

Ответ сервера

Название объекта

Subscriptions

Описание объекта

Линии, подключенные пользователям

Список объектов запрашивается методом: /v1/line/subscriptions/

Данные

Поле

Тип

Описание

line_id

UUID

ID линии поддержки

user_id

UUID

ID пользователя

subscription_set

DateTime

Дата начала подписки

subscription_expire_at

DateTime?

Дата окончания подписки

  • null когда бессрочная подписка

Пример

[
    {
        "user_id": "6d4a17a7-e03a-11e0-90fa-000c2926d843",
        "line_id": "9d283236-262e-11ea-80fc-0025904f970f",
        "subscription_set": "2019-12-24T00:00:00Z",
        "subscription_expire_at": null
    },
    {
        "user_id": "f70b30ec-5c95-4175-8729-df4f709bad10",
        "line_id": "9d283236-262e-11ea-80fc-0025904f970f",
        "subscription_set": "2022-11-28T00:00:00Z",
        "subscription_expire_at": null
    }
]

Ошибки

КодОписание
400Запрос содержит ошибку
401Пользователь не авторизован
403Недостаточно прав

Related pages