From d3af5aaaf4c0ee1cfdab7f37b5d9732d4dc23d2f Mon Sep 17 00:00:00 2001 From: q6q9 Date: Tue, 14 Sep 2021 15:21:55 +0300 Subject: [PATCH 1/2] =?UTF-8?q?=D0=94=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20API=20Reports?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/main.md | 245 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 241 insertions(+), 4 deletions(-) diff --git a/docs/api/main.md b/docs/api/main.md index ae4fd28..e55ffdd 100644 --- a/docs/api/main.md +++ b/docs/api/main.md @@ -30,7 +30,7 @@ limit - Количество профилей, которое вернет сервер при запроск. + Количество профилей, которое вернет сервер при запросе. @@ -38,7 +38,7 @@ offset - Количество записей на которое нужно отчтупить в списке профилей. + Количество записей на которое нужно отступить в списке профилей. @@ -110,7 +110,7 @@ phone - Телефон + Телефон. @@ -121,4 +121,241 @@ Дополнительные пожелания по собеседованию. - \ No newline at end of file + + +## Отчет +### Список +`https://guild.craft-group.xyz/api/reports` +

+ Для получения списка отчетов необходимо отправить 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 + + Номер статуса. +
+ +### Удалить отчет +`https://guild.craft-group.xyz/api/reports/delete` + +

+ Для удаления отчета необходимо отправить 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` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Параметры + + Значение +
+ 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` + From 9d0be92ec771bb3fa04ec9f0d1d59eaf68f7854d Mon Sep 17 00:00:00 2001 From: q6q9 Date: Tue, 14 Sep 2021 15:25:18 +0300 Subject: [PATCH 2/2] =?UTF-8?q?=D0=94=D0=BE=D1=80=D0=B0=D0=B1=D0=BE=D1=82?= =?UTF-8?q?=D0=BA=D0=B0=20=D0=BE=D1=88=D0=B8=D0=B1=D0=BE=D0=BA?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/main.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/main.md b/docs/api/main.md index e55ffdd..4706b6e 100644 --- a/docs/api/main.md +++ b/docs/api/main.md @@ -295,6 +295,13 @@ `https://guild.craft-group.xyz/api/reports/update` +

+ Для удаления отчета необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/reports/update +

+ +

+ Возможные параметры: +