added services, added documentation
This commit is contained in:
iIronside
329
docs/api/document.md
Normal file
329
docs/api/document.md
Normal file
@ -0,0 +1,329 @@
|
||||
# Документы
|
||||
|
||||
## Методы
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Метод
|
||||
</th>
|
||||
<th>
|
||||
Описание
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-document-list
|
||||
</td>
|
||||
<td>
|
||||
Возвращает список документов
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-document
|
||||
</td>
|
||||
<td>
|
||||
Возвращает документ
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
create-document
|
||||
</td>
|
||||
<td>
|
||||
Создание документа
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Список документов
|
||||
|
||||
`https://guild.craft-group.xyz/api/document/get-document-list?document_type=1`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
document_type
|
||||
</td>
|
||||
<td>
|
||||
Тип документа. Возможные значения: 1 - Акт; 2 - Договор
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>
|
||||
Без передачи параметра возвращает массив объектов <b>Документ</b> . С параметром <b>document_type</b>,
|
||||
метод возвращает объекты <b>Документ</b> определённого типа(<b>1 - Акт; 2 - Договор</b>).
|
||||
При отсутствии документов возвращает ошибку: "Not Found".
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Возвращает <b>массив</b> объектов <b>Документ</b>. <br>
|
||||
Каждый объект <b>Документ</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"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"
|
||||
}
|
||||
},
|
||||
'...'
|
||||
]
|
||||
```
|
||||
<p>
|
||||
Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"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`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
document_id
|
||||
</td>
|
||||
<td>
|
||||
Id документа
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает объект <b>Документ</b>. <br>
|
||||
Каждый объект <b>Документ</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
<p>
|
||||
Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"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`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
title
|
||||
</td>
|
||||
<td>
|
||||
Название документа
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
template_id
|
||||
</td>
|
||||
<td>
|
||||
Id шаблона
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
manager_id
|
||||
</td>
|
||||
<td>
|
||||
Id менеджера
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
field_id
|
||||
</td>
|
||||
<td>
|
||||
Id поля
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
value
|
||||
</td>
|
||||
<td>
|
||||
Значение поля
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Создаёт <b>Документ</b>. Требует передачи <b>POST</b> запроса с соответствующими
|
||||
параметрами документа и полей документа
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Пример передаваемого объекта:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
<p>
|
||||
В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"name": "Bad Request",
|
||||
"message": "{\"template_id\":[\"\Ш\а\б\л\о\н cannot be blank.\"]}",
|
||||
"code": 0,
|
||||
"status": 400,
|
||||
"type": "yii\\web\\BadRequestHttpException"
|
||||
}
|
||||
```
|
||||
@ -27,7 +27,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
limit
|
||||
get-document-list
|
||||
</td>
|
||||
<td>
|
||||
Количество профилей, которое вернет сервер при запросе.
|
||||
|
||||
141
docs/api/manager.md
Normal file
141
docs/api/manager.md
Normal file
@ -0,0 +1,141 @@
|
||||
# Менеджеры
|
||||
|
||||
## Методы
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Метод
|
||||
</th>
|
||||
<th>
|
||||
Описание
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-manager-list
|
||||
</td>
|
||||
<td>
|
||||
Возвращает список менеджеров
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-manager-employees-list
|
||||
</td>
|
||||
<td>
|
||||
Возвращает список сотрудников менеджера
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-manager
|
||||
</td>
|
||||
<td>
|
||||
Возвращает менеджера
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Список менеджеров
|
||||
|
||||
`https://guild.craft-group.xyz/api/manager/get-manager-list`
|
||||
|
||||
<p>
|
||||
Возвращает <b>массив</b> объектов <b>Менеджер</b>. <br>
|
||||
Каждый объект <b>Менеджер</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"fio": "Иванов Иван Иванович",
|
||||
"id": 5,
|
||||
"email": "testmail@mail.com"
|
||||
},
|
||||
'...'
|
||||
]
|
||||
```
|
||||
|
||||
## Получить менеджера
|
||||
|
||||
`https://guild.craft-group.xyz/api/manager/get-manager?manager_id=5`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
manager_id
|
||||
</td>
|
||||
<td>
|
||||
Id менеджера
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает объект <b>Менеджер</b>. <br>
|
||||
Каждый объект <b>Менеджер</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"id": "5",
|
||||
"fio": "Иванов Иван Иванович",
|
||||
"email": "testmail@mail.com",
|
||||
"photo": "",
|
||||
"gender": "0",
|
||||
"manager": {
|
||||
"id": "3"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Получить сотрудников менеджера
|
||||
|
||||
`https://guild.craft-group.xyz/api/manager/get-manager-employees-list?manager_id=5`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
manager_id
|
||||
</td>
|
||||
<td>
|
||||
Id менеджера
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает массив объектов <b>Профиль</b> сотрудников, что закреплены за менеджером. <br>
|
||||
Каждый объект <b>Профиль</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"id": 2,
|
||||
"fio": "тусыавт2",
|
||||
"email": "jnjhbdhvf@mail.com"
|
||||
},
|
||||
'...'
|
||||
]
|
||||
```
|
||||
321
docs/api/task.md
Normal file
321
docs/api/task.md
Normal file
@ -0,0 +1,321 @@
|
||||
# Задачи
|
||||
|
||||
## Методы
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Метод
|
||||
</th>
|
||||
<th>
|
||||
Описание
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-task-list
|
||||
</td>
|
||||
<td>
|
||||
Возвращает список задач
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-task
|
||||
</td>
|
||||
<td>
|
||||
Возвращает задачу
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
create-task
|
||||
</td>
|
||||
<td>
|
||||
Создаёт задачу
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
update
|
||||
</td>
|
||||
<td>
|
||||
Обновить задачу
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Список задач
|
||||
|
||||
`https://guild.craft-group.xyz/api/task/get-task-list?project_id=1`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
project_id
|
||||
</td>
|
||||
<td>
|
||||
Id проекта
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>
|
||||
Без передачи параметра возвращает массив объектов <b>Задача</b> . С параметром <b>project_id</b>,
|
||||
метод возвращает объекты <b>Задача</b> определённого проекта.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Возвращает <b>массив</b> объектов <b>Задача</b>. <br>
|
||||
Каждый объект <b>Задача</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"id": "6",
|
||||
"project_id": "74",
|
||||
"title": "Название задачи",
|
||||
"status": "1",
|
||||
"created_at": "2021-12-20 16:29:39",
|
||||
"updated_at": "2021-12-20 17:35:04",
|
||||
"description": "Описание задачи",
|
||||
"card_id_creator": "1",
|
||||
"card_id": "3"
|
||||
},
|
||||
'...'
|
||||
]
|
||||
```
|
||||
|
||||
## Получить документ
|
||||
|
||||
`https://guild.craft-group.xyz/api/task/get-task?task_id=15`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
task_id
|
||||
</td>
|
||||
<td>
|
||||
Id задачи
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает объект <b>Задача</b>. <br>
|
||||
Каждый объект <b>Задача</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"id": 15,
|
||||
"project_id": 74,
|
||||
"title": "4324238888",
|
||||
"status": 1,
|
||||
"created_at": "2022-01-05 17:37:37",
|
||||
"updated_at": "2022-01-05 17:46:10",
|
||||
"description": "888",
|
||||
"card_id_creator": 1,
|
||||
"card_id": null
|
||||
}
|
||||
```
|
||||
<p>
|
||||
Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"name": "Not Found",
|
||||
"message": "The task does not exist",
|
||||
"code": 0,
|
||||
"status": 404,
|
||||
"type": "yii\\web\\NotFoundHttpException"
|
||||
}
|
||||
```
|
||||
|
||||
## Создать документ
|
||||
|
||||
`https://guild.craft-group.xyz/api/document/create-document`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
title
|
||||
</td>
|
||||
<td>
|
||||
Название задачи
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
project_id
|
||||
</td>
|
||||
<td>
|
||||
Id проекта
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
status
|
||||
</td>
|
||||
<td>
|
||||
статус задачи
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
card_id_creator
|
||||
</td>
|
||||
<td>
|
||||
Id профиля создателя
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
card_id
|
||||
</td>
|
||||
<td>
|
||||
Id профиля наблюдателя(не обязательный параметр)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
description
|
||||
</td>
|
||||
<td>
|
||||
Описание
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Создаёт <b>Задача</b>. Требует передачи <b>POST</b> запроса с соответствующими
|
||||
параметрами
|
||||
</p>
|
||||
|
||||
<p>
|
||||
В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"name": "Internal Server Error",
|
||||
"message": "{\"project_id\":[\"\П\р\о\е\к\т is invalid.\"]}",
|
||||
"code": 0,
|
||||
"status": 500,
|
||||
"type": "yii\\web\\ServerErrorHttpException"
|
||||
}
|
||||
```
|
||||
|
||||
## Обновить документ
|
||||
|
||||
`https://guild.craft-group.xyz/api/task/update`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
title
|
||||
</td>
|
||||
<td>
|
||||
Название задачи
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
project_id
|
||||
</td>
|
||||
<td>
|
||||
Id проекта
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
status
|
||||
</td>
|
||||
<td>
|
||||
статус задачи
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
card_id_creator
|
||||
</td>
|
||||
<td>
|
||||
Id профиля создателя
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
card_id
|
||||
</td>
|
||||
<td>
|
||||
Id профиля наблюдателя(не обязательный параметр)
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
description
|
||||
</td>
|
||||
<td>
|
||||
Описание
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Обновляет объект <b>Задача</b>. Требует передачи <b>POST</b> запроса с соответствующими
|
||||
параметрами
|
||||
</p>
|
||||
|
||||
<p>
|
||||
В случае указания не верных параметров буде возвращена соответствующая ошибка. Пример ошибки:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"name": "Not Found",
|
||||
"message": "The task does not exist",
|
||||
"code": 0,
|
||||
"status": 404,
|
||||
"type": "yii\\web\\NotFoundHttpException"
|
||||
}
|
||||
```
|
||||
219
docs/api/template.md
Normal file
219
docs/api/template.md
Normal file
@ -0,0 +1,219 @@
|
||||
# Шаблоны
|
||||
|
||||
## Методы
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Метод
|
||||
</th>
|
||||
<th>
|
||||
Описание
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-template-list
|
||||
</td>
|
||||
<td>
|
||||
Возвращает список шаблонов
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-template-fields
|
||||
</td>
|
||||
<td>
|
||||
Возвращает поля шаблона
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
get-template
|
||||
</td>
|
||||
<td>
|
||||
Возвращает шаблон
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Список шаблонов
|
||||
|
||||
`https://guild.craft-group.xyz/api/template/get-template-list?document_type=1`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
document_type
|
||||
</td>
|
||||
<td>
|
||||
Тип документа. Возможные значения: 1 - Акт; 2 - Договор
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p>
|
||||
Без передачи параметра возвращает массив объектов <b>Шаблон</b> . С параметром <b>document_type</b>,
|
||||
метод возвращает объекты <b>Шаблон</b> определённого типа(<b>1 - Акт; 2 - Договор</b>).
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Возвращает <b>массив</b> объектов <b>Шаблон</b>. <br>
|
||||
Каждый объект <b>Шаблон</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
[
|
||||
{
|
||||
"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`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
template_id
|
||||
</td>
|
||||
<td>
|
||||
Id шаблона
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает объект <b>Шаблон</b>. <br>
|
||||
Каждый объект <b>Шаблон</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"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`
|
||||
<p>
|
||||
Параметры:
|
||||
</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>
|
||||
Параметры
|
||||
</th>
|
||||
<th>
|
||||
Значение
|
||||
</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
template_id
|
||||
</td>
|
||||
<td>
|
||||
Id шаблона
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>
|
||||
Возвращает объект <b>Шаблон</b>. <br>
|
||||
Каждый объект <b>Шаблон</b> имеет такой вид:
|
||||
</p>
|
||||
|
||||
```json5
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user