Merge branch 'master' of https://github.com/apuc/guild into achievement-in-api
This commit is contained in:
commit
ad947826a0
252
docs/api/main.md
252
docs/api/main.md
@ -30,7 +30,7 @@
|
|||||||
limit
|
limit
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Количество профилей, которое вернет сервер при запроск.
|
Количество профилей, которое вернет сервер при запросе.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -38,7 +38,7 @@
|
|||||||
offset
|
offset
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Количество записей на которое нужно отчтупить в списке профилей.
|
Количество записей на которое нужно отступить в списке профилей.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -110,7 +110,7 @@
|
|||||||
phone
|
phone
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
Телефон
|
Телефон.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@ -121,4 +121,248 @@
|
|||||||
Дополнительные пожелания по собеседованию.
|
Дополнительные пожелания по собеседованию.
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</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>
|
||||||
|
user_id
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
Идентификатор карточки пользователя отчета.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<p>
|
||||||
|
Пример запроса:
|
||||||
|
</p>
|
||||||
|
|
||||||
|
`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`
|
||||||
|
|
||||||
|
<p>
|
||||||
|
Для того, отправить приглашение профилю на собеседование, необходимо сделать
|
||||||
|
<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>
|
||||||
|
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>
|
||||||
|
|
||||||
|
### Удалить отчет
|
||||||
|
`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`
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user