diff --git a/docs/api/main.md b/docs/api/main.md index ae4fd28..4706b6e 100644 --- a/docs/api/main.md +++ b/docs/api/main.md @@ -30,7 +30,7 @@ limit
+ Для получения списка отчетов необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/reports +
+ ++ Возможные параметры: +
++ Параметры + | ++ Значение + | +
---|---|
+ fromDate* + | ++ Дата (yyyy-mm-dd) начала поиска отчетов. + | +
+ toDate + | ++ Дата (yyyy-mm-dd) окончания поиска отчетов. + | +
+ limit + | ++ Количество отчетов, которое вернет сервер при запросе (по умолчанию 10). + | +
+ offset + | ++ Количество записей на которое нужно отступить в списке отчетов. + | +
+ user_id + | ++ Идентификатор карточки пользователя отчета. + | +
+ Пример запроса: +
+ +`https://guild.craft-group.xyz/api/reports/index?fromDate=2021-08-01&toDate=2021-08-31&user_id=2limit=3&offset=2` + +### Создать отчет +`https://guild.craft-group.xyz/api/reports/create` + ++ Для того, отправить приглашение профилю на собеседование, необходимо сделать + POST запрос на URL https://guild.craft-group.xyz/api/reports/create +
++ Возможные параметры: +
++ Параметры + | ++ Значение + | +
---|---|
+ created_at* + | ++ Дата (yyyy-mm-dd) создания. + | +
+ user_card_id* + | ++ Идентификатор карточки пользователя. + | +
+ today + | ++ Сделанное сегодня. + | +
+ difficulties + | ++ Сложности. + | +
+ tomorrow + | ++ Планы на завтра. + | +
+ status + | ++ Номер статуса. + | +
+ Для удаления отчета необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/reports/delete +
+ ++ Возможные параметры: +
++ Параметры + | ++ Значение + | +
---|---|
+ id* + | ++ Идентификатор отчета. + | +
+ Пример запроса: +
+ +`https://guild.craft-group.xyz/api/reports/delete?id=17` +### Обновить отчет + +`https://guild.craft-group.xyz/api/reports/update` + ++ Для удаления отчета необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/reports/update +
+ ++ Возможные параметры: +
++ Параметры + | ++ Значение + | +
---|---|
+ id* + | ++ Идентификатор отчета. + | +
+ created_at* + | ++ Дата (yyyy-mm-dd) создания. + | +
+ today + | ++ Сделанное сегодня. + | +
+ difficulties + | ++ Сложности. + | +
+ tomorrow + | ++ Планы на завтра. + | +
+ status + | ++ Номер статуса. + | +
+ Пример запроса: +
+ +`https://guild.craft-group.xyz/api/reports/update?id=18&created_at=2021-09-17&today=0&difficulties=diff&tomorrow=new task&status=1` +