2022-03-21 16:11:56 +03:00
## Отчеты
## Методы
< table >
< tr >
< th >
Метод
< / th >
< th >
Описание
< / th >
< / tr >
< tr >
< td >
api/reports
< / td >
< td >
Список отчётов
< / td >
< / tr >
< tr >
< td >
api/reports/{id}
< / td >
< td >
Один отчёт
< / td >
< / tr >
< tr >
< td >
find-by-date
< / td >
< td >
Отчёт по дате
< / td >
< / tr >
< tr >
< td >
create
< / td >
< td >
Создать отчёт
< / td >
< / tr >
< tr >
< td >
delete
< / td >
< td >
Удалить отчёт
< / td >
< / tr >
< tr >
< td >
update
< / td >
< td >
Изменить отчёт
< / td >
< / tr >
2022-12-20 19:24:38 +03:00
< tr >
< td >
reports-by-date
< / td >
< td >
Отчёты по датам
< / td >
< / tr >
2022-03-21 16:11:56 +03:00
< / table >
### Список
`https://guild.craft-group.xyz/api/reports`
< p >
Для получения списка отчетов необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports
< / p >
< p >
Возможные параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
fromDate*
< / td >
< td >
Дата (yyyy-mm-dd) начала поиска отчетов.
< / td >
< / tr >
< tr >
< td >
toDate
< / td >
< td >
Дата (yyyy-mm-dd) окончания поиска отчетов.
< / td >
< / tr >
< tr >
< td >
limit
< / td >
< td >
Количество отчетов, которое вернет сервер при запросе (по умолчанию 10).
< / td >
< / tr >
< tr >
< td >
offset
< / td >
< td >
Количество записей на которое нужно отступить в списке отчетов.
< / td >
< / tr >
< tr >
< td >
2023-01-19 14:30:49 +03:00
user_card_id
2022-03-21 16:11:56 +03:00
< / td >
< td >
Идентификатор карточки пользователя отчета.
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
2023-01-19 14:30:49 +03:00
`https://guild.craft-group.xyz/api/reports/index?fromDate=2021-08-01&toDate=2021-08-31&user_card_id=2&limit=3&offset=2`
2022-03-21 16:11:56 +03:00
### Один отчет
`https://guild.craft-group.xyz/api/reports/{id}`
< p >
Для получения отчета необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/{id}
< / p >
< p >
Параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id*
< / td >
< td >
ID отчета.
< / td >
< / tr >
< / table >
< p >
Пример запроса на просмотр отчета с
< / p >
`https://guild.craft-group.xyz/api/reports/13`
### Отчёт по дате
`https://guild.craft-group.xyz/api/reports/find-by-date`
< p >
Для получения отчета необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/find-by-date
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_card_id*
< / td >
< td >
ID профиля пользователя
< / td >
< / tr >
< tr >
< td >
date*
< / td >
< td >
Дата в формате: Y-m-d
< / td >
< / tr >
< / table >
< p >
Пример запроса :
< / p >
`https://guild.craft-group.xyz/api/reports/find-by-date?user_card_id=17&date=2022-02-14`
< p >
Пример ответа:
< / p >
```json5
[
{
"id": "1",
"created_at": "2022-02-14",
"today": null,
"difficulties": "",
"tomorrow": "",
"status": null,
"user_card_id": "17",
"task": [
{
"id": "1",
"report_id": "1",
"task": "dfghjkl",
"hours_spent": "2",
"created_at": "1644842433",
"status": "1",
"minutes_spent": "4"
}
]
},
{
"id": "2",
"created_at": "2022-02-14",
"today": "dxvxv",
"difficulties": "сложности возникли",
"tomorrow": "завтра",
"status": null,
"user_card_id": "17",
"task": [
{
"id": "2",
"report_id": "2",
"task": "54651513",
"hours_spent": "4",
"created_at": "1644842630",
"status": "1",
"minutes_spent": "2"
}
]
}
]
```
### Создать отчет
`https://guild.craft-group.xyz/api/reports/create`
< p >
2022-12-16 20:18:25 +03:00
Для создания отчёта, необходимо сделать
2022-03-21 16:11:56 +03:00
< b > POST< / b > запрос на URL https://guild.craft-group.xyz/api/reports/create
< / p >
< p >
Возможные параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
created_at*
< / td >
< td >
Дата (yyyy-mm-dd) создания.
< / td >
< / tr >
< tr >
< td >
user_card_id*
< / td >
< td >
Идентификатор карточки пользователя.
< / td >
< / tr >
< tr >
< td >
tasks*
< / td >
< td >
JSON массив содержащий объекты задач
< pre >
[{
"task" : "Рефакторинг",
"created_at": 1638260728,
"status": 1,
"minutes_spent": 26,
"hours_spent" : 3
}]
< / pre >
< / td >
< / tr >
< tr >
< td >
difficulties
< / td >
< td >
Сложности.
< / td >
< / tr >
< tr >
< td >
tomorrow
< / td >
< td >
Планы на завтра.
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Номер статуса.
< / td >
< / tr >
< / table >
### Удалить отчет
`https://guild.craft-group.xyz/api/reports/delete`
< p >
Для удаления отчета необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/delete
< / p >
< p >
Возможные параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id*
< / td >
< td >
Идентификатор отчета.
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/reports/delete?id=17`
### Обновить отчет
`https://guild.craft-group.xyz/api/reports/update`
< p >
Для удаления отчета необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/update
< / p >
< p >
Возможные параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id*
< / td >
< td >
Идентификатор отчета.
< / td >
< / tr >
< tr >
< td >
created_at
< / td >
< td >
Дата (yyyy-mm-dd) создания.
< / td >
< / tr >
< tr >
< td >
today
< / td >
< td >
Сделанное сегодня.
< / td >
< / tr >
< tr >
< td >
difficulties
< / td >
< td >
Сложности.
< / td >
< / tr >
< tr >
< td >
tomorrow
< / td >
< td >
Планы на завтра.
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Номер статуса.
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/reports/update?id=18&created_at=2021-09-17&today=0&difficulties=diff&tomorrow=new task&status=1`
2022-12-20 19:24:38 +03:00
### Отчёты по датам
`https://guild.craft-group.xyz/api/reports/reports-by-date`
< p >
Для получения списка дат за которые есть отчёты необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/reports-by-date
< / p >
< p >
Параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< th >
Обязательный
< / th >
< / tr >
< tr >
< td >
fromDate
< / td >
< td >
Дата начала периода
< / td >
< th >
Да
< / th >
< / tr >
< tr >
< td >
toDate
< / td >
< td >
Дата конца периода
< / td >
< th >
Да
< / th >
< / tr >
< tr >
< td >
2023-01-19 14:30:49 +03:00
user_card_id
2022-12-20 19:24:38 +03:00
< / td >
< td >
Id пользователя. По умолчанию будет выведен список для текущего пользователя,
при передаче параметра будет выведен список для заданного пользователя
< / td >
< th >
Нет
< / th >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
2023-01-19 14:30:49 +03:00
`http://guild.loc/api/reports/reports-by-date?fromDate=2022-12-1&toDate=2022-12-31&user_card_id=1 task&status=1`
2022-12-20 19:24:38 +03:00
< p >
Возвращаемые параметры: id - идентификатор отчёта, date - дата отчёта,
spendTime - время затраченое на все задачи в отчёте
< / p >
```json5
[
{
"date": "2022-12-16",
"id": 50,
"spendTime": 8
},
{
"date": "2022-12-16",
"id": 51,
"spendTime": 8
},
{
"date": "2022-12-16",
"id": 52,
"spendTime": 8
},
{
"date": "2022-12-01",
"id": 53,
"spendTime": null
},
{
"date": "2022-12-10",
"id": 54,
"spendTime": null
},
{
"date": "2022-12-16",
"id": 55,
"spendTime": null
},
{
"date": "2022-12-31",
"id": 56,
"spendTime": null
},
{
"date": "2022-12-31",
"id": 57,
"spendTime": null
},
{
"date": "2022-12-31",
"id": 58,
"spendTime": null
}
]
```
