guild/docs/api/template.md
2022-01-16 23:54:13 +03:00

4.3 KiB
Raw Blame History

Шаблоны

Методы

Метод Описание
get-template-list Возвращает список шаблонов
get-template-fields Возвращает поля шаблона
get-template Возвращает шаблон

Список шаблонов

https://guild.craft-group.xyz/api/template/get-template-list?document_type=1

Параметры:

Параметры Значение
document_type Тип документа. Возможные значения: 1 - Акт; 2 - Договор

Без передачи параметра возвращает массив объектов Шаблон . С параметром document_type, метод возвращает объекты Шаблон определённого типа(1 - Акт; 2 - Договор).

Возвращает массив объектов Шаблон.
Каждый объект Шаблон имеет такой вид:

[
  {
    "id": "94",
    "title": "Акт",
    "created_at": "2022-01-11 11:47:11",
    "updated_at": null,
    "template_file_name": null,
    "document_type": "2"
  },
 '...'
]

Получить шаблон

https://guild.craft-group.xyz/api/template/get-template?template_id=94

Параметры:

Параметры Значение
template_id Id шаблона

Возвращает объект Шаблон.
Каждый объект Шаблон имеет такой вид:

{
  "id": "94",
  "title": "Акт",
  "created_at": "2022-01-11 11:47:11",
  "updated_at": null,
  "template_file_name": null,
  "document_type": "2"
}

Получить поля шаблона

https://guild.craft-group.xyz/api/template/get-template-fields?template_id=94

Параметры:

Параметры Значение
template_id Id шаблона

Возвращает объект Шаблон.
Каждый объект Шаблон имеет такой вид:

{
  "id": "94",
  "title": "Акт",
  "created_at": "2022-01-11 11:47:11",
  "updated_at": null,
  "template_file_name": null,
  "document_type": "2",
  "templateDocumentFields": [
    {
      "id": "159",
      "template_id": "94",
      "field_id": "43",
      "field": {
        "id": "43",
        "title": "№ документа",
        "field_template": "№ dokumenta"
      }
    },
    {
      "id": "160",
      "template_id": "94",
      "field_id": "44",
      "field": {
        "id": "44",
        "title": "от",
        "field_template": "ot"
      }
    },
    {
      "id": "161",
      "template_id": "94",
      "field_id": "45",
      "field": {
        "id": "45",
        "title": "Сумма с НДС",
        "field_template": "Summa s NDS"
      }
    },
    {
      "id": "162",
      "template_id": "94",
      "field_id": "46",
      "field": {
        "id": "46",
        "title": "НДС",
        "field_template": "NDS"
      }
    },
    {
      "id": "163",
      "template_id": "94",
      "field_id": "47",
      "field": {
        "id": "47",
        "title": "Основание",
        "field_template": "Osnovaniye"
      }
    }
  ]
}