Ссылка для быстрого доступа к этой статье
Получение ссылки для загрузки PDF...
Ошибка при запросе PDF!
Перезагрузите страницу и попробуйте ещё раз
Работа с шаблонами полномочий
Получить список стандартных шаблонов полномочий
GET/corporate-api/v1/empowerment-templates/basic
Метод позволяет получить список стандартных шаблонов полномочий.
Наименование параметра | Тип параметра | Значение | Дополнительно |
---|---|---|---|
RelationshipType | string | Формат доверенности. Принимает значения:
| Стандартные шаблоны есть только для формата:
|
Search | string | Поиск по любому значению | |
Offset | integer($int32) | Отступ | |
Count | integer($int32) | Количество шаблонов | |
SortField | string | Сортировка по любому выходному параметру | Если поле пустое, то вернется массив с сортировкой по параметру: Name |
SortOrder | string | Принимает значения: |
Код | Значение | Дополнительно |
---|---|---|
200 | Success
| Возвращается массив шаблонов data, содержащий следующие значения: id - идентификатор шаблона name - наименование шаблона organizationId - id организации // для стандартного шаблона всегда нули relationshipType - формат доверенности:
updateDate - дата обновления шаблона templateType - тип шаблона:
meta - служебная информация totalCount - общее число найденных шаблонов |
400 | BadRequest { | Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
/corporate-api/v1/empowerment-templates/basic?Count=2
Ответ:
{
"data": [
{
"id": "049d49a8-b9eb-46ba-9303-19bc31efe937",
"name": "Полномочия для ЕГАИС",
"organizationId": "00000000-0000-0000-0000-000000000000",
"relationshipType": "Unified",
"updateDate": "2024-03-18T11:56:47.353787+00:00",
"templateType": "Codes"
},
{
"id": "0918046c-ebb4-42f4-aa1c-2912b23d1cf4",
"name": "Полномочия для ЛесЕГАИС",
"organizationId": "00000000-0000-0000-0000-000000000000",
"relationshipType": "Unified",
"updateDate": "2024-03-18T11:56:47.353788+00:00",
"templateType": "Text"
}
],
"meta": {
"totalCount": 6
}
}
Получить список шаблонов полномочий организации
GET/corporate-api/v1/empowerment-templates
Метод позволяет получить список шаблонов полномочий организации.
Наименование параметра | Тип параметра | Значение | Дополнительно |
---|---|---|---|
AddBasicTemplates | boolean | Включить стандартные полномочия в выборку. Принимает значения:
| |
RelationshipType | string | Формат доверенности. Принимает значения
| Стандартные шаблоны есть только для формата:
|
Search | string | Поиск по любому значению | |
Offset | integer($int32) | Отступ | |
Count | integer($int32) | Количество шаблонов | |
SortField | string | Сортировка по любому выходному параметру | Если поле пустое, то вернется массив с сортировкой по параметру: Name |
SortOrder | string | Принимает значения: |
Код | Значение | Дополнительно |
---|---|---|
200 |
| Возвращается массив шаблонов data, содержащий следующие значения: id - идентификатор шаблона name - наименование шаблона organizationId - id организации relationshipType - формат доверенности
updateDate - дата обновления шаблона templateType - тип шаблона:
meta - служебная информация totalCount - общее число найденных шаблонов |
400 |
| Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
/corporate-api/v1/empowerment-templates
Ответ:
{
"data": [
{
"id": "712f74de-a64e-4511-ace4-514bc415d5e4",
"name": "Для бухгалтера",
"organizationId": "eb65a53a-cf2a-4fbb-a4dd-dc4fc14603e2",
"relationshipType": "Unified",
"updateDate": "2024-03-31T17:04:49.971983+00:00",
"templateType": "Codes"
},
{
"id": "777e672e-4bc8-4db5-9f3c-2f27fb09ed7c",
"name": "Тестовый шаблон",
"organizationId": "eb65a53a-cf2a-4fbb-a4dd-dc4fc14603e2",
"relationshipType": "Unified",
"updateDate": "2024-03-31T16:55:11.715054+00:00",
"templateType": "Text"
},
{
"id": "5c977354-81a1-4672-b118-c9ffd17a7fa2",
"name": "Тестовый шаблон_1",
"organizationId": "eb65a53a-cf2a-4fbb-a4dd-dc4fc14603e2",
"relationshipType": "Unified",
"updateDate": "2024-03-31T16:56:29.943982+00:00",
"templateType": "Text"
}
],
"meta": {
"totalCount": 3
}
}
Создать шаблон полномочий
POST/corporate-api/v1/empowerment-templates
Метод позволяет создать шаблон полномочий организации.
| Значения: name - наименование шаблона полномочий, текст до 255 символов
description - текстовое значение при templateType =Text, до 10 000 символов
isThrowErrorByName - возвращать ошибку, если параметр name не уникален, принимает значения:
Если параметр name не уникален среди шаблонов организации, и при этом при создании шаблона параметр isThrowErrorByName=false, то name будет преобразован в вид: name_<количество совпадений по name> |
Код | Значение | Дополнительно |
---|---|---|
200 | Success | |
400 | BadRequest { | Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
{
"name": "Тестовый шаблон",
"templateType": "Text",
"description": "Тестовые полномочия",
"organizationId": "eb65a53a-cf2a-4fbb-a4dd-dc4fc14603e2",
"relationshipType": "Unified",
"isThrowErrorByName": true
}
Ответ:
–
Получить шаблон полномочий с деталями по идентификатору
GET/corporate-api/v1/empowerment-templates/{id}
Метод позволяет получить определенный шаблон полномочий организации.
Наименование параметра | Тип параметра | Значение |
---|---|---|
id | string | Обязательный параметр id шаблона полномочий |
Код | Значение | Дополнительно |
---|---|---|
200 |
| Возвращается массив шаблонов data, содержащий следующие значения: id - идентификатор шаблона name - наименование шаблона organizationId - id организации relationshipType - формат доверенности
updateDate - дата обновления шаблона templateType - тип шаблона:
description - текстовые полномочия при templateType=Text codes - коды полномочий при templateType=Codes id - идентификатор полномочия code - код полномочия content - содержание полномочия disabled - является ли полномочие неактивным в справочнике полномочий
meta - служебная информация totalCount - общее число найденных шаблонов |
400 |
| Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
/corporate-api/v1/empowerment-templates/712f74de-a64e-4511-ace4-514bc415d5e4
Ответ:
{
"codes": [
{
"id": "028d8e3c-4819-4c13-8118-8eae47c63be2",
"code": "BRACTIV_BRACTIVATION",
"content": "Активировать личный кабинет участника информационного обмена с Банком России",
"disabled": false
},
{
"id": "1cea809e-2d06-4cf1-b4c5-1746b9365af9",
"code": "BTBO_00000002",
"content": "Заключать любые сделки с цифровыми финансовыми активами, иными цифровыми правами и цифровой валютой, распоряжаться и осуществлять иные действия с цифровыми финансовыми активами, иными цифровыми правами и цифровой валютой",
"disabled": false
},
{
"id": "dba20c5a-4eaf-4ba5-8d67-2a0339a7c88f",
"code": "FK9800_GISEС_EС0001",
"content": "Утверждение Перечня ТРУ федеральными органами исполнительной власти, органами исполнительной власти субъекта Российской Федерации, уполномоченными высшим исполнительным органом государственной власти субъекта Российской Федерации",
"disabled": false
}
],
"id": "712f74de-a64e-4511-ace4-514bc415d5e4",
"name": "Для бухгалтера",
"organizationId": "eb65a53a-cf2a-4fbb-a4dd-dc4fc14603e2",
"relationshipType": "Unified",
"updateDate": "2024-03-31T17:04:49.971983+00:00",
"templateType": "Codes"
}
Обновить шаблон полномочий
PUT/corporate-api/v1/empowerment-templates/{id}
Метод позволяет отредактировать определенный шаблон полномочий организации.
Наименование параметра | Тип параметра | Значение |
---|---|---|
id | string | Обязательный параметр id шаблона полномочий |
| Значения параметров name - наименование шаблона templateType - тип шаблона:
description - текстовые полномочия при templateType=Text codes - коды полномочий при templateType=Codes |
Код | Значение | Дополнительно |
---|---|---|
200 | Success | |
400 | BadRequest
| Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
{
"name": "Для старшего бухгалтера",
"templateType": "Codes",
"codes": [
"FTS_10002",
"FKZ_00000001"
]
}
Ответ:
–
Удалить шаблон полномочий
DELETE/corporate-api/v1/empowerment-templates/{id}
Метод позволяет удалить определенный шаблон полномочий организации.
Наименование параметра | Тип параметра | Значение |
---|---|---|
id | string | Обязательный параметр id шаблона полномочий |
Код | Значение | Дополнительно |
---|---|---|
200 | Success | |
400 | BadRequest { | Ошибка в запросе |
401 | Unauthorized | ApiKey отсутствует |
403 | Forbidden | Доступ запрещен |
404 | NotFound | Данные не найдены |
500 | InternalServerError | An error has occured |
Запрос:
/corporate-api/v1/empowerment-templates/5c977354-81a1-4672-b118-c9ffd17a7fa2
Ответ:
–
Обновлено: 27.04.2024 12:00+0000