guild/docs/api/document.md

Документы

Методы

Метод	Описание
get-document-list	Возвращает список документов
get-document	Возвращает документ
create-document	Создание документа

Список документов

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

Параметры:

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

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

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

[
  {
    "id": "88",
    "title": "Act2",
    "created_at": "2022-01-12 16:39:41",
    "updated_at": "2022-01-12 16:39:41",
    "template_id": "94",
    "manager_id": "5",
    "template": {
      "id": "94",
      "title": "Акт",
      "created_at": "2022-01-11 11:47:11",
      "updated_at": null,
      "template_file_name": null,
      "document_type": "2"
    }
  },
 '...'
]

Пример ошибки:

{
  "name": "Not Found",
  "message": "Documents not found",
  "code": 0,
  "status": 404,
  "type": "yii\\web\\NotFoundHttpException"
}

Получить документ

https://guild.craft-group.xyz/api/document/get-document?document_id=88

Параметры:

Параметры	Значение
document_id	Id документа

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

[
  {
    "id": "88",
    "title": "Act2",
    "created_at": "2022-01-12 16:39:41",
    "updated_at": "2022-01-12 16:39:41",
    "template_id": "94",
    "manager_id": "5",
    "documentFieldValues": [
      {
        "id": "105",
        "field_id": "43",
        "document_id": "88",
        "value": "№ документа111",
        "field": {
          "id": "43",
          "title": "№ документа",
          "field_template": "№ dokumenta"
        }
      },
      {
        "id": "106",
        "field_id": "44",
        "document_id": "88",
        "value": "от111",
        "field": {
          "id": "44",
          "title": "от",
          "field_template": "ot"
        }
      },
      {
        "id": "107",
        "field_id": "45",
        "document_id": "88",
        "value": "Сумма с НДС111",
        "field": {
          "id": "45",
          "title": "Сумма с НДС",
          "field_template": "Summa s NDS"
        }
      },
      {
        "id": "108",
        "field_id": "46",
        "document_id": "88",
        "value": "НДС111",
        "field": {
          "id": "46",
          "title": "НДС",
          "field_template": "NDS"
        }
      },
      {
        "id": "109",
        "field_id": "47",
        "document_id": "88",
        "value": "Основание111",
        "field": {
          "id": "47",
          "title": "Основание",
          "field_template": "Osnovaniye"
        }
      }
    ]
  }
]

Пример ошибки:

{
  "name": "Not Found",
  "message": "There is no such document",
  "code": 0,
  "status": 404,
  "type": "yii\\web\\NotFoundHttpException"
}

Создать документ

https://guild.craft-group.xyz/api/document/create-document

Параметры:

Параметры	Значение
title	Название документа
template_id	Id шаблона
manager_id	Id менеджера
field_id	Id поля
value	Значение поля

Создаёт Документ. Требует передачи POST запроса с соответствующими параметрами документа и полей документа

Пример передаваемого объекта:

{
  "title": "Act64",
  "template_id": "94",
  "manager_id": "5",
  "documentFieldValues": [
    {
      "field_id": "43",
      "value": "№ документа111"
    },
    {
      "field_id": "44",
      "value": "от111"
    },
    {
      "field_id": "45",
      "value": "Сумма с НДС111"
    },
    {
      "field_id": "46",
      "value": "НДС111"
    },
    {
      "field_id": "47",
      "value": "Основание111"
    }
  ]
}

В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:

{
  "name": "Bad Request",
  "message": "{\"template_id\":[\"\Ш\а\б\л\о\н cannot be blank.\"]}",
  "code": 0,
  "status": 400,
  "type": "yii\\web\\BadRequestHttpException"
}