---Получение списка приглашений на площадки [1.0]

Описание

Структура URL

HTTP метод GET. Ресурс <base_url>/v1.0/boards/external/invite/my

Результат

Возвращает массив приглашений (ExternalInvite[])

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

Информация о приглашении на площадку

Название

Описание

Тип

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

SenderFirmTotalScore

Баллы отправителя

FirmTopRating

да

SenderFirmStatus

Статус отправителя

FirmStars

да

BoardInfo

Информация о площадке, на которую создано приглашение

ExternalBoardInfo

да

Participant

Параметры участия на площадке

Participant

да

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

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

Название

Описание

Тип

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

BoardID

ID площадки

строка

да

AtiID

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

строка

да

SenderAtiID

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

строка

да

CreatedOn

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

дата, время

да

Type

Тип участия

ParticipationType

да

ViewParticipants

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

boolean

нет

ViewContent

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

boolean

нет

TypeChanged

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

дата, время

да

SmsAllowed

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

boolean

нет

CanAdd

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

boolean

нет

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

[
  {
    "SenderFirmTotalScore": {
      "firm_type_id": 1,
      "position_in_city": 1,
      "position_in_country": 1,
      "city_name": "sample string 1",
      "country_name": "sample string 2"
    },
    "SenderFirmStatus": {
      "total_score": 1.0,
      "status": 1
    },
    "BoardInfo": {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Color": "sample string 3",
      "CreatedOn": 1503504426848,
      "ViewOnlyOwn": true,
      "UpdatedOn": 1503504426848,
      "LogoUrl": "sample string 7",
      "BoardType": "loads",
      "BoardExchangeDirection": "input",
      "OwnerFirm": 8
    },
    "Participant": {
      "BoardID": "sample string 1",
      "AtiID": "sample string 2",
      "SenderAtiID": "sample string 3",
      "CreatedOn": 1503504426848,
      "Type": "user",
      "ViewParticipants": true,
      "ViewContent": true,
      "TypeChanged": 1503504426848,
      "SmsAllowed": true,
      "CanAdd": true
    }
  },
  {
    "SenderFirmTotalScore": {
      "firm_type_id": 1,
      "position_in_city": 1,
      "position_in_country": 1,
      "city_name": "sample string 1",
      "country_name": "sample string 2"
    },
    "SenderFirmStatus": {
      "total_score": 1.0,
      "status": 1
    },
    "BoardInfo": {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Color": "sample string 3",
      "CreatedOn": 1503504426848,
      "ViewOnlyOwn": true,
      "UpdatedOn": 1503504426848,
      "LogoUrl": "sample string 7",
      "BoardType": "loads",
      "BoardExchangeDirection": "input",
      "OwnerFirm": 8
    },
    "Participant": {
      "BoardID": "sample string 1",
      "AtiID": "sample string 2",
      "SenderAtiID": "sample string 3",
      "CreatedOn": 1503504426848,
      "Type": "user",
      "ViewParticipants": true,
      "ViewContent": true,
      "TypeChanged": 1503504426848,
      "SmsAllowed": true,
      "CanAdd": true
    }
  }
]

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

HTTP код ответа

Код ошибки

Сообщение

200


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

401


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