Посмотреть информацию о подразделении

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

Возвращает информацию об одном подразделении.

Ограничение. Требуется разрешение на чтение данных о подразделениях.

HTTP-запрос

GET https://api360.yandex.net/directory/v1/org/{orgId}/departments/{departmentId}

Path-параметры

orgId *

integer

Идентификатор организации.

departmentId *

integer

Идентификатор подразделения.

orgId *

integer

Идентификатор организации.

departmentId *

integer

Идентификатор подразделения.

Ответы

Код 200

Запрос успешно выполнен.

{
  "aliases": [
    string
  ],
  "createdAt": string,
  "description": string,
  "email": string,
  "externalId": string,
  "headId": string,
  "id": integer,
  "label": string,
  "membersCount": integer,
  "name": string,
  "parentId": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

aliases[]

array

Алиасы почтовых рассылок.

createdAt

string

Дата и время создания подразделения.

description

string

Описание подразделения.

email

string

Адрес почтовой рассылки подразделения.

externalId

string

Произвольный внешний идентификатор подразделения.

headId

string

Руководитель подразделения.

id

integer

Идентификатор подразделения.

label

string

Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

membersCount

integer

Количество сотрудников подразделения с учетом вложенных подразделений.

name

string

Название подразделения.

parentId

integer

Идентификатор родительского подразделения.

aliases[]

array

Алиасы почтовых рассылок.

createdAt

string

Дата и время создания подразделения.

description

string

Описание подразделения.

email

string

Адрес почтовой рассылки подразделения.

externalId

string

Произвольный внешний идентификатор подразделения.

headId

string

Руководитель подразделения.

id

integer

Идентификатор подразделения.

label

string

Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

membersCount

integer

Количество сотрудников подразделения с учетом вложенных подразделений.

name

string

Название подразделения.

parentId

integer

Идентификатор родительского подразделения.

Код 401

Пользователь не авторизован.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 403

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 404

Запрашиваемый ресурс не найден.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string

Код 500

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

integer

details[]

array

details[].@type

string

message

string

code

integer

details[]

array

details[].@type

string

message

string