addPassportOrganizationMember

Добавляет нового участника в паспортную организацию.

Лимит — 10 инвайтов в день на один PassportOrganizationLogin.

Узнайте больше

Запрос

Структура запроса в формате JSON:

{
  "method": "addPassportOrganizationMember",
  "params": {
    "PassportOrganizationLogin": (string),
    "Role": ("ADMIN"|"USER"),
	  "SendInviteTo": {
  		"Phone": (string),
	  	"Email": (string),
	  },
  }
}

Параметр

Тип

Описание

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

Структура params (для JSON) / AddPassportOrganizationMember (для SOAP)

PassportOrganizationLogin

string

Логин паспортной организации, в которую необходимо добавить нового участника.

Да

Role

RoleEnum

Роль, с которой новый участник будет добавлен в паспортную организацию. Может принимать одно из двух значений:

  • ADMIN
  • USER

Да

SendInviteTo

SendInviteTo

Настройка способа отправки приглашения в паспортную организацию.
Обязательно указывается один из параметров (Phone/Email).

Да

Структура MemberInvite

Phone

string

Номер телефона для отправки приглашения через SMS в формате «только цифры» (без разделителей, скобок и т.д.). Наример, 79991234567.

Не указывается, если указан Email.

Нет

Email

string

Email для отправки сообщения письмом.

Не указывается, если указан Phone.

Нет

Ответ

Структура ответа в формате JSON:

{
  "result": {
    "PassportOrganizationLogin": (string),
    "Warnings": [{
      "Code": (int),
      "Message": (string),
      "Details": (string)
    }, ... ],
    "Errors": [{
      "Code": (int),
      "Message": (string),
      "Details": (string)
    }, ... ]
  }
}

Параметр

Тип

Описание

Структура result (для JSON) / AddPassportOrganizationMember (для SOAP)

PassportOrganizationLogin

string

Логин паспортной организации, в которую отправлен инвайт.

Внимание

Инвайт по ссылке может принять любой пользователь, имеющий аккаунт в Яндексе.

Warnings

array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors

array of ExceptionNotification

Ошибки, возникшие при выполнении операции.

Предыдущая
Следующая