---Получение списка участников площадки [1.0]

Описание

Если не указывать offset и limit - вернёт всех участников

Структура URL

HTTP метод GET. Ресурс <base_url>/v1.0/boards/external/participants/board/<id>/<offset>/<limit>

Список параметров

Название

Описание

Обязательный

Источник

id

ID площадки

Да

Из URL

offset

Отступ (для постраничного вывода)

Да

Из URL

limit

Ограничение количества (для постраничного вывода)

Да

Из URL

Результат

Структура типа Participant

Детали участия пользователя на площадке

Название

Описание

Тип

Обязательный

BoardID

ID площадки

строка

да

AtiID

код в АТИ участника

строка

да

SenderAtiID

код в АТИ пригласившего (владельца площадки)

строка

да

CreatedOn

Дата вступления (приглашения) на площадку

дата, время

да

Type

Тип участия

ParticipationType

да

ViewParticipants

Может ли видеть других участников площадки

boolean

нет

ViewContent

Может ли видеть грузы/машины площадки

boolean

нет

TypeChanged

Время последней смены типа участия

дата, время

да

SmsAllowed

Разрешено получение бесплатных (за счёт владельца) смс

boolean

нет

CanAdd

Может ли добавлять грузы/машины на площадку

boolean

нет

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

{
  "Result": [
    {
      "BoardID": "sample string 1",
      "AtiID": "sample string 2",
      "SenderAtiID": "sample string 3",
      "CreatedOn": 1503504427117,
      "Type": "user",
      "ViewParticipants": true,
      "ViewContent": true,
      "TypeChanged": 1503504427117,
      "SmsAllowed": true,
      "CanAdd": true
    },
    {
      "BoardID": "sample string 1",
      "AtiID": "sample string 2",
      "SenderAtiID": "sample string 3",
      "CreatedOn": 1503504427117,
      "Type": "user",
      "ViewParticipants": true,
      "ViewContent": true,
      "TypeChanged": 1503504427117,
      "SmsAllowed": true,
      "CanAdd": true
    }
  ],
  "TotalCount": 1,
  "UserCount": 1
}

Список ответов сервера

HTTP код ответа

Код ошибки

Сообщение

200


Операция завершена успешно

401


Требуется авторизация