GetDocumentVariables

Список переменных для документов

Получить список переменных, которые можно использовать в документах и рассылках.

Входные параметры
documentTypeId
Тип документа. Доступные варианты значений:
  1. Переменные для шаблона печатного документа с учеником
  2. Переменные для шаблона E-mail письма - отчёта о занятии
  3. Переменные для шаблона SMS-рассылки
Целочисленное, обязательный параметр
Результат:
В результате будет возвращён список допустимых к использованию в тексте переменных, сгруппированных по тематическим категориям (Студент, Родитель, Курс и программа и т.п.)
Пример результата (json):
[
    {
        "groupmentName": "Студент",
        "items": [
            {
                "docType": "4",
                "body": "{ФИО}",
                "name": "ФИО ученика/преподавателя",
                "description": "Иванов Иван Иванович"
            },
            {
                "docType": "4",
                "body": "{ИМЯ}",
                "name": "Имя ученика. Если невозможно выделить, будет использовано ФИО.",
                "description": "Иван"
            },
            {
                "docType": "4",
                "body": "{Пол:дорогой|дорогая}",
                "name": "Текст для использования в зависимости от пола ученика",
                "description": ""
            }
        ]
    },
    {
        "groupmentName": "Родитель (заказчик)",
        "items": [
            {
                "docType": "4",
                "body": "{ФИО родителя}",
                "name": "ФИО родителя. Если нет - будет использован ФИО ученика.",
                "description": "Андреев Евгений Петрович"
            },
            {
                "docType": "4",
                "body": "{ИО родителя}",
                "name": "Имя и отчество родителя",
                "description": "Евгений Петрович"
            }
        ]
    },
    {
        "groupmentName": "Деньги",
        "items": [
            {
                "docType": "4",
                "body": "{Баланс}",
                "name": "Баланс из истории взаиморасчётов",
                "description": "1000 р."
            }
        ]
    }
]

Результат данного запроса может быть закеширован на несколько секунд.