GetPrintFormsList (Integration) — различия между версиями

Материал из razgovorov.ru
Перейти к: навигация, поиск
м (Власов Илья переименовал страницу GetPrintingTemplates (Integration) в GetPrintFormsList (Integration))
 
(не показано 7 промежуточных версий этого же участника)
Строка 1: Строка 1:
Полное имя метода: Integration.GetPrintingTemplates
+
Полное имя метода: Integration.GetPrintFormsList
  
 
==Описание==
 
==Описание==
Получение списка печатных форм для указанного типа документа. Если указан идентификатор документа получаем доступные для него печатные формы.
+
Получение списка печатных форм по переданным параметрам.
  
  
Строка 15: Строка 15:
 
* Params - параметры получения списка печатных форм. (JSON)
 
* Params - параметры получения списка печатных форм. (JSON)
  
Все параметры являются необязательными. Структура параметров:
+
 
{
+
Структура параметра Params:
    'Id': '',      - Целочисленный идентификатор документа (Строка)
+
* Id - Целочисленный идентификатор документа (Строка)
    'UUID': '',    - Идентификатор документа (Строка)
+
* UUID - Идентификатор документа (Строка)
    'Type': '',    - Тип документа (Строка)
+
* Type - Тип документа (Строка)
    'Regulation': { - Параметры регламента документа (JSON)
+
* RegulationName - Имя регламента (Строка)
        'Name': '', - Имя регламента (Строка)
+
* RegulationUUID - Идентификатор регламента (Строка)
        'UUID': ''  - Идентификатор регламента (Строка)
+
Все элементы являются необязательными.
    }
+
 
}
+
 
 +
 
 
Если передан тип документа и/или идентификатор регламента будет получен список форм для указанного типа и/или регламента.
 
Если передан тип документа и/или идентификатор регламента будет получен список форм для указанного типа и/или регламента.
  
Строка 31: Строка 32:
 
Если передан один из идентификаторов документа будет получен список всех доступных для документа форм.
 
Если передан один из идентификаторов документа будет получен список всех доступных для документа форм.
  
Если передано название регламента по немы будет выполнен поиск советующего идентификатора и отбор списка печатных форм по нему.
+
Если передано название регламента и тип документа по ним будет получен идентификатор регламента с последующим отборои списка печатных форм.
  
  
Строка 43: Строка 44:
 
         'Template': '01651616-11fd-5112-8151-06180121231a',
 
         'Template': '01651616-11fd-5112-8151-06180121231a',
 
         'Title': '1-Т',
 
         'Title': '1-Т',
         'Format': 'pdf'
+
         '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'
    }
]