GetPrintFormsList (Integration) — различия между версиями
м (Власов Илья переименовал страницу GetPrintingTemplates (Integration) в GetPrintFormsList (Integration)) |
|||
| (не показано 9 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
| − | Полное имя метода: | + | Полное имя метода: Integration.GetPrintFormsList |
==Описание== | ==Описание== | ||
| − | Получение списка печатных форм | + | Получение списка печатных форм по переданным параметрам. |
==Алгоритм== | ==Алгоритм== | ||
| − | 1. | + | 1. Подготавливаем фильтр для получения списка печатных форм. |
| − | 2. | + | 2. Получаем список печатных форм |
3. Форматируем полученный список и возвращаем результат. | 3. Форматируем полученный список и возвращаем результат. | ||
==Параметры== | ==Параметры== | ||
| − | * Type - Тип документа | + | * Params - параметры получения списка печатных форм. (JSON) |
| − | * | + | |
| + | |||
| + | Структура параметра Params: | ||
| + | * Id - Целочисленный идентификатор документа (Строка) | ||
| + | * UUID - Идентификатор документа (Строка) | ||
| + | * Type - Тип документа (Строка) | ||
| + | * RegulationName - Имя регламента (Строка) | ||
| + | * RegulationUUID - Идентификатор регламента (Строка) | ||
| + | Все элементы являются необязательными. | ||
| + | |||
| + | |||
| + | |||
| + | Если передан тип документа и/или идентификатор регламента будет получен список форм для указанного типа и/или регламента. | ||
| + | |||
| + | Если вместе с типом или регламентом будет передан один из идентификаторов документа будет получен список доступных для указанного документа форм по типу или регламенту. | ||
| + | |||
| + | Если передан один из идентификаторов документа будет получен список всех доступных для документа форм. | ||
| + | |||
| + | Если передано название регламента и тип документа по ним будет получен идентификатор регламента с последующим отборои списка печатных форм. | ||
| + | |||
==Результат== | ==Результат== | ||
| Строка 24: | Строка 43: | ||
{ | { | ||
'Template': '01651616-11fd-5112-8151-06180121231a', | 'Template': '01651616-11fd-5112-8151-06180121231a', | ||
| − | ' | + | 'Title': '1-Т', |
| − | ' | + | 'DefaultOutputFormatExtension': 'pdf' |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
] | ] | ||
Текущая версия на 15:54, 10 августа 2021
Полное имя метода: Integration.GetPrintFormsList
Содержание
Описание
Получение списка печатных форм по переданным параметрам.
Алгоритм
1. Подготавливаем фильтр для получения списка печатных форм.
2. Получаем список печатных форм
3. Форматируем полученный список и возвращаем результат.
Параметры
- Params - параметры получения списка печатных форм. (JSON)
Структура параметра Params:
- Id - Целочисленный идентификатор документа (Строка)
- UUID - Идентификатор документа (Строка)
- Type - Тип документа (Строка)
- RegulationName - Имя регламента (Строка)
- RegulationUUID - Идентификатор регламента (Строка)
Все элементы являются необязательными.
Если передан тип документа и/или идентификатор регламента будет получен список форм для указанного типа и/или регламента.
Если вместе с типом или регламентом будет передан один из идентификаторов документа будет получен список доступных для указанного документа форм по типу или регламенту.
Если передан один из идентификаторов документа будет получен список всех доступных для документа форм.
Если передано название регламента и тип документа по ним будет получен идентификатор регламента с последующим отборои списка печатных форм.
Результат
Список печатных форм для указанного типа документа или доступных для указанного документа.
Пример возвращаемого результата:
[
{
'Template': '01651616-11fd-5112-8151-06180121231a',
'Title': '1-Т',
'DefaultOutputFormatExtension': 'pdf'
}
]
