Departments API

Группа методов для работы с подразделениями.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

[GET]/api/v1/abonents/{abonentId}/departments

Получить список подразделений

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Идентификатор абонента
departmentId	Нет	Query	string(uuid)	Идентификатор подразделения относительно, которого нужно вернуть список дочерних подразделений. Если не указан, то возвращаем относительно головного подразделения.
search	Нет	Query	string	Строка поиска
offset	Нет	Query	integer(int32)	Начальное смещение
limit	Нет	Query	integer(int32)	Количество возвращаемых подразделений

Возможные ответы метода

Код	Тип	Описание
200	DepartmentShortDto[array]	Список подразделений.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/abonents/{abonentId}/departments

Создать новое подразделение

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Идентификатор абонента

Тело запроса

Тип запроса: application/json

Тело запроса

Название	Обязат.	Тип	Описание
name	Да	string	Наименование подразделения
code	Нет	string	Краткое обозначение (код) подразделения
kpp	Нет	string	КПП подразделения
parentDepartmentId	Да	string(uuid)	Идентификатор головного подразделения
address	Нет	Одна из: AddressDto	Адрес подразделения

Пример модели

{
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "7124eac4-dfa4-4370-99a3-2b005017a138",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор созданного подразделения.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}

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

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Идентификатор абонента
departmentId	Да	Path	string(uuid)	Идентификатор подразделения

Возможные ответы метода

Код	Тип	Описание
200	DepartmentDto	Детальная информация по подразделению.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

[PUT]/api/v1/abonents/{abonentId}/departments/{departmentId}

Обновить существующее подразделение

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Идентификатор абонента
departmentId	Да	Path	string(uuid)	Идентификатор подразделения

Тело запроса

Тип запроса: application/json

Тело запроса

Название	Обязат.	Тип	Описание
name	Да	string	Наименование подразделения
code	Нет	string	Краткое обозначение (код) подразделения
kpp	Нет	string	КПП подразделения
parentDepartmentId	Да	string(uuid)	Идентификатор головного подразделения
address	Нет	Одна из: AddressDto	Адрес подразделения

Пример модели

{
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "7124eac4-dfa4-4370-99a3-2b005017a138",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

Возможные ответы метода

Код	Тип	Описание
200	DepartmentDto	Обновленная информация по подразделению.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}/short

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

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Path	string(uuid)	Идентификатор абонента
departmentId	Да	Path	string(uuid)	Идентификатор подразделения

Возможные ответы метода

Код	Тип	Описание
200	DepartmentShortDto	Краткая информация по подразделению.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "parentDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "hasChildrenDepartments": true,
  "code": "Строка",
  "kpp": "Строка"
}

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

AddressDto

Модель адреса

Название	Обязат.	Тип	Описание
postalIndex	Нет	string	Почтовый индекс
regionCode	Да	string	Код региона
regionName	Нет	string	Название региона
area	Нет	string	Район
city	Нет	string	Город
settlement	Нет	string	Населенный пункт
street	Нет	string	Улица
house	Нет	string	Дом
housing	Нет	string	Корпус
apartment	Нет	string	Квартира

Пример модели

{
  "postalIndex": "Строка",
  "regionCode": "Строка",
  "regionName": "Строка",
  "area": "Строка",
  "city": "Строка",
  "settlement": "Строка",
  "street": "Строка",
  "house": "Строка",
  "housing": "Строка",
  "apartment": "Строка"
}

CreateDepartmentRequest

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

Название	Обязат.	Тип	Описание
name	Да	string	Наименование подразделения
code	Нет	string	Краткое обозначение (код) подразделения
kpp	Нет	string	КПП подразделения
parentDepartmentId	Да	string(uuid)	Идентификатор головного подразделения
address	Нет	Одна из: AddressDto	Адрес подразделения

Пример модели

{
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "7124eac4-dfa4-4370-99a3-2b005017a138",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

DepartmentDto

Модель подразделения

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор подразделения
name	Да	string	Наименование подразделения
code	Нет	string	Краткое обозначение (код) подразделения
kpp	Нет	string	КПП подразделения
parentDepartmentId	Нет	string(uuid)	Идентификатор родительского подразделения
address	Нет	Одна из: AddressDto	Адрес подразделения

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

DepartmentShortDto

Упрощенная модель подразделения

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор подразделения
name	Да	string	Наименование подразделения
parentDepartmentId	Нет	string(uuid)	Идентификатор родительского подразделения
hasChildrenDepartments	Да	boolean	Признак наличия дочерних подразделений
code	Нет	string	Код подразделения
kpp	Нет	string	КПП подразделения

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Строка",
  "parentDepartmentId": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "hasChildrenDepartments": true,
  "code": "Строка",
  "kpp": "Строка"
}

UpdateDepartmentRequest

Запрос на обновление сведений по подразделению

Название	Обязат.	Тип	Описание
name	Да	string	Наименование подразделения
code	Нет	string	Краткое обозначение (код) подразделения
kpp	Нет	string	КПП подразделения
parentDepartmentId	Да	string(uuid)	Идентификатор головного подразделения
address	Нет	Одна из: AddressDto	Адрес подразделения

Пример модели

{
  "name": "Строка",
  "code": "Строка",
  "kpp": "Строка",
  "parentDepartmentId": "7124eac4-dfa4-4370-99a3-2b005017a138",
  "address": {
    "postalIndex": "Строка",
    "regionCode": "Строка",
    "regionName": "Строка",
    "area": "Строка",
    "city": "Строка",
    "settlement": "Строка",
    "street": "Строка",
    "house": "Строка",
    "housing": "Строка",
    "apartment": "Строка"
  }
}

Departments API

Описание методов​

[GET]/api/v1/abonents/{abonentId}/departments​

Параметры в строке запроса​

Возможные ответы метода​

[POST]/api/v1/abonents/{abonentId}/departments​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/abonents/{abonentId}/departments/{departmentId}​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}/short​

Параметры в строке запроса​

Возможные ответы метода​

Описание дополнительных моделей​

AddressDto​

CreateDepartmentRequest​

DepartmentDto​

DepartmentShortDto​

UpdateDepartmentRequest​

Описание методов

[GET]/api/v1/abonents/{abonentId}/departments

Параметры в строке запроса

Возможные ответы метода

[POST]/api/v1/abonents/{abonentId}/departments

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/abonents/{abonentId}/departments/{departmentId}

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/abonents/{abonentId}/departments/{departmentId}/short

Параметры в строке запроса

Возможные ответы метода

Описание дополнительных моделей

AddressDto

CreateDepartmentRequest

DepartmentDto

DepartmentShortDto

UpdateDepartmentRequest