guild/docs/api/main.md

Документация API

Навыки

Популярные навыки

https://guild.craft-group.xyz/api/skills/skills-on-main-page

Чтобы получить популярные навыки нужно сделать GET запрос на URL https://guild.craft-group.xyz/api/skills/skills-on-main-page

Профиль

Список

https://guild.craft-group.xyz/api/profile

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

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

Параметры	Значение
limit	Количество профилей, которое вернет сервер при запросе.
offset	Количество записей на которое нужно отступить в списке профилей.
skills	Идентификаторы навыков по которым нужно отфильтровать профили.

Пример запроса:

https://guild.craft-group.xyz/api/profile?limit=5&offset=5&skills=1

Одна запись

https://guild.craft-group.xyz/api/profile/{id}

Для того, чтобы получить данные одной записи необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/profile/{id} , где id это идинтификатор профиля.

Пример запроса:

https://guild.craft-group.xyz/api/profile/6

Пригласить на собеседование

https://guild.craft-group.xyz/api/profile/add-to-interview

Для того, отправить приглашение профилю на собеседование, необходимо сделать POST запрос на URL https://guild.craft-group.xyz/api/profile/add-to-interview

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

Параметры	Значение
email*	Почта пользователя, который хочет пригласить на собеседование.
profile_id*	Идентификатор профиля.
phone	Телефон.
comment	Дополнительные пожелания по собеседованию.

Отчет

Список

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

Для удаления отчета необходимо отправить 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