2021-09-15 16:14:08 +03:00
# Документация API
2021-07-03 11:32:03 +03:00
## Навыки
### Популярные навыки
`https://guild.craft-group.xyz/api/skills/skills-on-main-page`
< p >
Чтобы получить популярные навыки нужно сделать < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/skills/skills-on-main-page
< / p >
2021-09-14 15:21:55 +03:00
## Отчет
### Список
`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 >
2022-02-15 15:16:19 +03:00
`https://guild.craft-group.xyz/api/reports/index?fromDate=2021-08-01&toDate=2021-08-31&user_id=2&limit=3&offset=2`
2021-09-14 15:21:55 +03:00
2021-11-30 11:29:43 +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`
2022-02-15 15:16:19 +03:00
### Отчёт по дате
`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"
}
]
}
]
```
2021-09-14 15:21:55 +03:00
### Создать отчет
`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 >
2021-11-30 11:29:43 +03:00
tasks*
2021-09-14 15:21:55 +03:00
< / td >
< td >
2021-11-30 11:29:43 +03:00
JSON массив содержащий объекты задач
< pre >
[{
"task" : "Рефакторинг",
"created_at": 1638260728,
"status": 1,
"minutes_spent": 26,
"hours_spent" : 3
}]
< / pre >
2021-09-14 15:21:55 +03:00
< / 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`
2021-09-14 15:25:18 +03:00
< p >
Для удаления отчета необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/reports/update
< / p >
< p >
Возможные параметры:
< / p >
2021-09-14 15:21:55 +03:00
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id*
< / td >
< td >
Идентификатор отчета.
< / td >
< / tr >
< tr >
< td >
2021-09-14 16:12:22 +03:00
created_at
2021-09-14 15:21:55 +03:00
< / 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`
2021-11-12 14:30:01 +03:00
## Анкеты
###Список анкет
`https://guild.craft-group.xyz/api/user-questionnaire/questionnaires-list`
< p >
Для получения списка анкет необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/user-questionnaire/questionnaires-list
< / p >
< p >
Требуемые параметры запроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя(int)
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/user-questionnaire/questionnaires-list?user_id=1`
< p >
Возвращает < b > массив< / b > объектов записи < b > Назначенная анкета< / b > . < br >
Каждый объектимеет такой вид:
< / p >
```json5
2022-03-17 14:50:57 +03:00
{
2021-11-12 14:30:01 +03:00
"user_id": 1,
"uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5",
2022-03-17 14:50:57 +03:00
"score": 11,
"status": 2,
"percent_correct_answers": 0.25,
"testing_date": "2022-03-17 11:14:22",
"questionnaire_title": "К а
2021-11-12 14:30:01 +03:00
}
```
2022-03-17 14:50:57 +03:00
< p >
Возвращаемые параметры объекта анкета:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя(int)
< / td >
< / tr >
< tr >
< td >
uuid
< / td >
< td >
uuid анкеты пользователя
< / td >
< / tr >
< tr >
< td >
score
< / td >
< td >
Полученные балы(int)
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Статус: 0 - не активен; 1 - активен; 2 - завершён; 3 - на проверке;
< / td >
< / tr >
< tr >
< td >
percent_correct_answers
< / td >
< td >
Процент правильных ответов(float)
< / td >
< / tr >
< tr >
< td >
testing_date
< / td >
< td >
Дата тестирования
< / td >
< / tr > < tr >
< td >
questionnaire_title
< / td >
< td >
Название анкеты
< / td >
< / tr >
< / table >
2021-11-12 14:30:01 +03:00
< p >
Передаваемые параметры объекта вопроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя(int)
< / td >
< / tr >
< tr >
< td >
score
< / td >
< td >
Полученные балы(int)
< / td >
< / tr >
< tr >
< td >
percent_correct_answers
< / td >
< td >
Процент правильных ответов(float)
< / td >
< / tr >
< / table >
< p >
Если пользователь не найден или у
< / p >
```json5
{
"name": "Not Found",
"message": "Active questionnaire not found",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
2022-03-14 17:47:01 +03:00
### Проверить ответы в анкете
2022-03-15 13:00:09 +03:00
`https://guild.craft-group.xyz/api/user-questionnaire/questionnaire-completed`
2022-03-14 17:47:01 +03:00
< p >
Для выполнения проверки анкеты необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/user-questionnaire/questionnaire-completed
< / p >
< p >
Требуемые параметры запроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_questionnaire_uuid
< / td >
< td >
UUID анкеты назначеной пользователю
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/user-questionnaire/questionnaire-completed?user_questionnaire_uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Возвращает < b > массив< / b > объектов < b > Вопросов< / b > . < br >
Каждый объект < b > Вопрос< / b > имеет такой вид:
< / p >
```json5
{
"id": 1,
"questionnaire_id": 1,
"user_id": 1,
"uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5",
"created_at": "2021-10-20 13:06:12",
"updated_at": {
"expression": "NOW()",
"params": []
},
"score": 4,
"status": 1,
"percent_correct_answers": 0.5,
"testing_date": null
}
```
2022-03-17 14:50:57 +03:00
### Число балов в анкете
`https://guild.craft-group.xyz/api/user-questionnaire/get-points-number?user_questionnaire_uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Для максимального числа балов в анкеты необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/user-questionnaire/get-points-number
< / p >
< p >
Требуемые параметры запроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_questionnaire_uuid
< / td >
< td >
UUID анкеты назначеной пользователю
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/user-questionnaire/get-points-number?user_questionnaire_uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Возвращает максимально возможное число балов за анкету b>. < br >
Объект < b > Ответа< / b > имеет такой вид:
< / p >
```json5
{
"sum_point": "61"
}
```
### Число вопросов в анкете
`https://guild.craft-group.xyz/api/user-questionnaire/get-question-number?user_questionnaire_uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Для числа вопросов в анкете необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/user-questionnaire/get-question-number
< / p >
< p >
Требуемые параметры запроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_questionnaire_uuid
< / td >
< td >
UUID анкеты назначеной пользователю
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/user-questionnaire/get-question-number?user_questionnaire_uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Возвращает число вопросов в анкете b>. < br >
Объект < b > Ответа< / b > имеет такой вид:
< / p >
```json5
{
"question_number": "7"
}
```
2021-11-12 14:30:01 +03:00
### Вопросы анкеты
`https://guild.craft-group.xyz/api/question/get-questions`
< p >
Для получения вопросов анкеты необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/question/get-questions
< / p >
< p >
Требуемые параметры запроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
uuid
< / td >
< td >
UUID анкеты назначеной пользователю
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/question/get-questions?uuid=d222f858-60fd-47fb-8731-dc9d5fc384c5`
< p >
Возвращает < b > массив< / b > объектов < b > Вопросов< / b > . < br >
Каждый объект < b > Вопрос< / b > имеет такой вид:
< / p >
```json5
{
"id": "4",
"question_type_id": "2",
"question_body": "Один о е
"question_priority": null,
"next_question": null,
"time_limit": "00:22:00"
}
```
< p >
Передаваемые параметры объекта вопроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
question_type_id
< / td >
< td >
ID типа вопроса(int)
< / td >
< / tr >
< tr >
< td >
question_body
< / td >
< td >
Вопрос(string)
< / td >
< / tr >
< tr >
< td >
question_priority
< / td >
< td >
Приоритет вопроса(int)(не используется)
< / td >
< / tr >
< tr >
< td >
next_question
< / td >
< td >
Следующий вопрос(int)(не используется)
< / td >
< / tr >
< tr >
< td >
time_limit
< / td >
< td >
Ограничение времени на ответ(time)
< / td >
< / tr >
< / table >
< p >
Если вопрос не найден или не предпологает передачу ответов будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "Questions not found",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Ответы на вопрос
`https://guild.craft-group.xyz/api/answer/get-answers`
< p >
Для получения вариантов ответов на вопрос анкеты нужно сделать < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/answer/get-answers
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
question_id
< / td >
< td >
ID вопроса
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/answer/get-answers?question_id=7`
< p >
Возвращает < b > массив< / b > объектов < b > Ответов< / b > . < br >
Каждый объект < b > Ответа< / b > имеет такой вид:
< / p >
```json5
[
{
"id": "12",
"question_id": "7",
"answer_body": "Неск ва р о
},
]
```
< p >
Передаваемые параметры объекта вопроса:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
question_id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
answer_body
< / td >
< td >
Ответ(string)
< / td >
< / tr >
< / table >
< p >
Если ответы не найдены или вопрос не предпологает их наличие(открытый вопрос) будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "Answer not found or question inactive",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
2021-11-15 12:57:21 +03:00
### Один ответ пользователя
2021-11-12 14:30:01 +03:00
`https://guild.craft-group.xyz/api/user-response/set-response`
< p >
2021-11-15 12:57:21 +03:00
Для добавления ответа на вопрос от пользователя необходимо сделать < b > POST< / b > запрос на URL https://guild.craft-group.xyz/api/user-response/set-response
2021-11-12 14:30:01 +03:00
< / p >
< p >
Тело запроса содержит:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
2022-03-14 13:06:20 +03:00
< td >
user_id
< / td >
< td >
ID пользователя
< / td >
< / tr >
< tr >
2021-11-12 14:30:01 +03:00
< td >
question_id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
response_body
< / td >
< td >
Ответ пользователя(string 255)
< / td >
< / tr >
< tr >
< td >
2022-03-14 13:06:20 +03:00
user_questionnaire_uuid
2021-11-12 14:30:01 +03:00
< / td >
< td >
UUID анкеты назначенной пользователю(string 36)
< / td >
< / tr >
< / table >
< p >
2022-03-14 13:06:20 +03:00
Пример тела запроса:
2021-11-12 14:30:01 +03:00
< / p >
2022-03-14 13:06:20 +03:00
```json5
{
"user_id": "1",
"question_id": "7",
"response_body": "oooooooooooo111111111",
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5"
}
```
`https://guild.craft-group.xyz/api/user-response/set-response`
2021-11-12 14:30:01 +03:00
< p >
Возвращает объект < b > Ответа< / b > . < br >
Объект < b > Ответа< / b > имеет такой вид:
< / p >
```json5
{
2022-03-14 13:06:20 +03:00
"user_id": "1",
"question_id": "7",
"response_body": "oooooooooooo111111111",
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5",
"created_at": {
"expression": "NOW()",
"params": []
},
"updated_at": {
"expression": "NOW()",
"params": []
},
"id": 191,
"answer_flag": 0
2021-11-12 14:30:01 +03:00
}
```
2022-03-14 13:06:20 +03:00
< p >
Ответ содержит:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя
< / td >
< / tr >
< tr >
< td >
question_id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
response_body
< / td >
< td >
Ответ пользователя(string 255)
< / td >
< / tr >
< tr >
< td >
user_questionnaire_uuid
< / td >
< td >
UUID анкеты назначенной пользователю(string 36)
< / td >
< / tr >
< tr >
< td >
answer_flag
< / td >
< td >
2022-03-16 14:27:01 +03:00
Флаг ответа(1 - верно, 0 - ложно). Если отправлен ответ на открытый вопрос, флаг ответа не будет возвращаться до момента проверки в админ панели.
2022-03-14 13:06:20 +03:00
< / td >
< / tr >
< / table >
2021-11-12 14:30:01 +03:00
< p >
В
< / p >
```json5
{
"name": "Bad Request",
"message": "{\"question_id\":[\"\В о р о с
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
```
2021-11-15 12:57:21 +03:00
### Массив ответов пользователя
`https://guild.craft-group.xyz/api/user-response/set-responses`
< p >
Для добавления массива ответов на вопросы от пользователя необходимо сделать < b > POST< / b > запрос на URL https://guild.craft-group.xyz/api/user-response/set-responses
< / p >
< p >
Тело запроса содержит JSON c массивом ответов с о
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
2022-03-14 13:06:20 +03:00
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя
< / td >
2021-11-15 12:57:21 +03:00
< / tr >
< tr >
< td >
question_id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
response_body
< / td >
< td >
Ответ пользователя(string 255)
< / td >
< / tr >
< tr >
< td >
2022-03-14 13:06:20 +03:00
user_questionnaire_uuid
2021-11-15 12:57:21 +03:00
< / td >
< td >
UUID анкеты назначенной пользователю(string 36)
< / td >
< / tr >
< / table >
< p >
Пример тела запроса:
< / p >
```json5
{
"userResponses": [
{
"user_id": "1",
"question_id": "7",
"response_body": "oooooooooooo111111111",
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5"
},
{
"user_id": "1",
"question_id": "4",
"response_body": "oooooooooooo2222222",
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5"
}
]
}
```
< p >
Возвращает массив объектов < b > ОтветПользователя< / b > . < br >
Пример:
< / p >
```json5
[
{
"user_id": "1",
"question_id": "7",
"response_body": "oooooooooooo111111111",
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5",
"created_at": {
"expression": "NOW()",
"params": []
},
"updated_at": {
"expression": "NOW()",
"params": []
},
2022-03-14 13:06:20 +03:00
"id": 192,
"answer_flag": 0
2021-11-15 12:57:21 +03:00
},
{
"user_id": "1",
2022-03-14 13:06:20 +03:00
"question_id": "7",
"response_body": "oooooooooooo111111111",
2021-11-15 12:57:21 +03:00
"user_questionnaire_uuid": "d222f858-60fd-47fb-8731-dc9d5fc384c5",
"created_at": {
"expression": "NOW()",
"params": []
},
"updated_at": {
"expression": "NOW()",
"params": []
},
2022-03-14 13:06:20 +03:00
"id": 193,
"answer_flag": 0
2021-11-15 12:57:21 +03:00
}
]
```
2022-03-14 13:06:20 +03:00
< p >
Ответ содержит:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID пользователя
< / td >
< / tr >
< tr >
< td >
question_id
< / td >
< td >
ID вопроса(int)
< / td >
< / tr >
< tr >
< td >
response_body
< / td >
< td >
Ответ пользователя(string 255)
< / td >
< / tr >
< tr >
< td >
user_questionnaire_uuid
< / td >
< td >
UUID анкеты назначенной пользователю(string 36)
< / td >
< / tr >
< tr >
< td >
answer_flag
< / td >
< td >
Флаг ответа(1 - верно, 0 - ложно)
< / td >
< / tr >
< / table >
2021-11-15 12:57:21 +03:00
< p >
В
< / p >
```json5
{
"name": "Bad Request",
"message": "{\"question_id\":[\"\В о р о с
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
```
2021-11-17 12:24:02 +03:00
## Менеджер
### Список менеджеров
`https://guild.craft-group.xyz/api/manager/get-manager-list`
< p >
Для получения списка менеджеров необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/manager/get-manager-list
< / p >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/manager/get-manager?manager_id=1`
< p >
Возвращает список объектов < b > Менеджера< / b > . < br >
Пример ответа:
< / p >
```json5
[
{
2022-01-05 17:11:31 +03:00
"fio": "testUser",
2021-11-17 12:24:02 +03:00
"id": 1,
"email": "admin@admin.com"
},
{
2022-01-05 17:11:31 +03:00
"fio": "workerTest22",
2021-11-17 12:24:02 +03:00
"id": 2,
"email": "awdsdse@njbhj.com"
}
]
```
< p >
Передаваемые параметры объекта < b > Менеджер< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID менеджера(int)
< / td >
< / tr >
< tr >
< td >
2022-01-05 17:11:31 +03:00
fio
2021-11-17 12:24:02 +03:00
< / td >
< td >
2022-01-05 17:11:31 +03:00
ФИО пользователя(varchar(255))
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< tr >
< td >
email
< / td >
< td >
Почтовый адрес(string)
< / td >
< / tr >
< / table >
< p >
Если менеджеры не найдены будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "Managers are not assigned",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Список работников менеджера
`https://guild.craft-group.xyz/api/manager/get-employees-manager`
< p >
Для получения списка сотрудников менеджера необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/manager/get-employees-manager
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
manager_id
< / td >
< td >
ID менеджера
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/manager/get-employees-manager?manager_id=3`
< p >
Возвращает список объектов < b > Пользователь< / b > . < br >
Ответ имеет такой вид:
< / p >
```json5
[
{
"id": 2,
2022-01-05 17:11:31 +03:00
"fio": "workerTest",
2021-11-17 12:24:02 +03:00
"email": "testUseweewer@testUser.com",
},
{
"id": 4,
2022-01-05 17:11:31 +03:00
"fio": "worker1",
2021-11-17 12:24:02 +03:00
"email": "sdfsdvdworker2",
},
]
```
< p >
Передаваемые параметры объекта < b > Менеджер< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
2022-01-05 17:11:31 +03:00
ID пользователя(работника) у
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< tr >
< td >
2022-01-05 17:11:31 +03:00
fio
2021-11-17 12:24:02 +03:00
< / td >
< td >
2022-01-05 17:11:31 +03:00
ФИО сотрудника(varchar(255))
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< tr >
< td >
email
< / td >
< td >
Почтовый адрес(string)
< / td >
< / tr >
< / table >
< p >
Если менеджер не найден или у
< / p >
```json5
{
"name": "Not Found",
"message": "Managers are not assigned or employees are not assigned to him",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Данные менеджера
`https://guild.craft-group.xyz/api/manager/get-manager`
< p >
Для получения данных менеджера необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/manager/get-manager
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
manager_id
< / td >
< td >
ID менеджера
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/manager/get-manager?manager_id=1`
< p >
Возвращает объект < b > Менеджера< / b > . < br >
Каждый объект < b > Менеджер< / b > имеет такой вид:
< / p >
2021-11-15 12:57:21 +03:00
2021-11-17 12:24:02 +03:00
```json5
[
{
2022-01-05 17:11:31 +03:00
"id": 5,
"fio": "Иванов Иван Иванович",
"email": "testmail@mail.com",
"photo": "",
"gender": 0
2021-11-17 12:24:02 +03:00
}
]
```
< p >
Передаваемые параметры объекта < b > Менеджер< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
2022-01-05 17:11:31 +03:00
ID пользователя(работника) у
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< tr >
< td >
2022-01-05 17:11:31 +03:00
fio
2021-11-17 12:24:02 +03:00
< / td >
< td >
2022-01-05 17:11:31 +03:00
ФИО сотрудника(varchar(255))
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< tr >
< td >
email
< / td >
< td >
2022-01-05 17:11:31 +03:00
Почтовый адрес(string)
2021-11-17 12:24:02 +03:00
< / td >
< / tr >
< / table >
< p >
Если менеджер не найден будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "Incorrect manager ID",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
2021-11-25 12:33:08 +03:00
## Задачи
### Задача
`https://guild.craft-group.xyz/api/task/get-task`
< p >
Для получения данных задачи необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/task/get-task
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID менеджера
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/task/get-task?task_id=3`
< p >
Возвращает объект < b > Задачи< / b > . < br >
Каждый объект < b > Задачи< / b > имеет такой вид:
< / p >
```json5
{
2021-12-06 15:13:31 +03:00
"id": 14,
2021-11-25 12:33:08 +03:00
"project_id": 2,
2021-12-06 15:13:31 +03:00
"title": "Пробная 2",
"status": 0,
"created_at": "2021-12-03 17:22:15",
"updated_at": "2021-12-03 17:22:15",
2021-11-25 12:33:08 +03:00
"user_id": null,
2021-12-06 15:13:31 +03:00
"description": "смасмс",
"user_id_creator": 1
2021-11-25 12:33:08 +03:00
}
```
< p >
Передаваемые параметры объекта < b > Задача< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID задачи(int)
< / td >
< / tr >
< tr >
< td >
project_id
< / td >
< td >
ID проекта(int)
< / td >
< / tr >
< tr >
< td >
title
< / td >
< td >
Название задачи(string)
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Статус(int)
< / td >
< / tr >
< tr >
< td >
created_at
< / td >
< td >
Дата создания(string)
< / td >
< / tr >
< tr >
< td >
updated_at
< / td >
< td >
Дата изменения(string)
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
user_id
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID наблюдателя проекта(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
description
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
Описание задачи(string)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
user_id_creator
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID создателя задачи(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< / table >
< p >
Если задача не найдена будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "The task does not exist",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Список задач
`https://guild.craft-group.xyz/api/task/get-task-list`
< p >
Для получения списка данных задач необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/task/get-task-list
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
project_id
< / td >
< td >
ID проекта
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/task/get-task-list?project_id=2`
< p >
Возвращает массив объектов < b > Задачи< / b > . < br >
Каждый объект < b > Задачи< / b > имеет такой вид:
< / p >
```json5
[
{
"id": 3,
"project_id": 2,
"title": "polkjhgbfv task",
"status": 1,
"created_at": "2021-11-24 11:53:11",
"updated_at": "2021-11-24 11:53:11",
2021-12-06 15:13:31 +03:00
"user_id_creator": 1,
2021-11-25 12:33:08 +03:00
"user_id": null,
"description": "dfvdfvfdvfd"
},
{
"id": 7,
"project_id": 2,
"title": "polkjhgbfv taskdfsdfsd",
"status": 1,
"created_at": "2021-11-24 14:55:01",
"updated_at": "2021-11-24 14:55:01",
2021-12-06 15:13:31 +03:00
"user_id_creator": 1,
2021-11-25 12:33:08 +03:00
"user_id": null,
"description": "dfvdfvfdvfdsddsfds"
}
]
```
< p >
Передаваемые параметры объекта < b > Задача< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID задачи(int)
< / td >
< / tr >
< tr >
< td >
project_id
< / td >
< td >
ID проекта(int)
< / td >
< / tr >
< tr >
< td >
title
< / td >
< td >
Название задачи(string)
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Статус(int)
< / td >
< / tr >
< tr >
< td >
created_at
< / td >
< td >
Дата создания(string)
< / td >
< / tr >
< tr >
< td >
updated_at
< / td >
< td >
Дата изменения(string)
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
user_id_creator
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID создателя задачи(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID наблюдателя(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
description
< / td >
< td >
Описание задачи(string)
< / td >
< / tr >
< / table >
< p >
Если задачи не найдена будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "The project does not exist or there are no tasks for it",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Создать задачу
`https://guild.craft-group.xyz/api/task/create-task`
< p >
Для создания задачи необходимо отправить < b > POST< / b > запрос на URL https://guild.craft-group.xyz/task/create-task
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
project_id
< / td >
< td >
ID проекта(int)
< / td >
< / tr >
< tr >
< td >
title
< / td >
< td >
Название задачи(string)
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Статус(int)
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
user_id_creator
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID сотрудника, создатель задачи(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
description
< / td >
< td >
Описание задачи(string)
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`http://guild.loc/api/task/create-task`
< p >
Возвращает объект < b > Задачи< / b > . < br >
Каждый объект < b > Задачи< / b > имеет такой вид:
< / p >
```json5
{
"project_id": "2",
"title": "polkjhgbfv taskdfsdfsd",
"status": "1",
2021-12-06 15:13:31 +03:00
"user_id_creator": "1",
2021-11-25 12:33:08 +03:00
"description": "dfvdfvfdvfdsddsfds",
"created_at": {
"expression": "NOW()",
"params": []
},
"updated_at": {
"expression": "NOW()",
"params": []
},
"id": 12
}
```
< p >
Если требуемый параметр задачи не будет получен, будет отправлено сообщение следующего вида:
< / p >
```json5
{
"name": "Bad Request",
2021-12-06 15:13:31 +03:00
"message": "{\"user_id_creator\":[\"\С о а е
2021-11-25 12:33:08 +03:00
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
```
### Изменить задачу
`https://guild.craft-group.xyz/api/task/update`
< p >
Для изменения задачи необходимо отправить < b > POST< / b > запрос на URL https://guild.craft-group.xyz/task/update
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID задачи
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/task/update`
< p >
Возвращает объект < b > Задачи< / b > . < br >
Каждый объект < b > Задачи< / b > имеет такой вид:
< / p >
```json5
{
"id": 11,
"project_id": 2,
"title": "432423",
"status": 1,
"created_at": "2021-11-24 14:40:25",
"updated_at": "2021-11-25 11:44:30",
2021-12-06 15:13:31 +03:00
"user_id_creator": 5,
2021-11-25 12:33:08 +03:00
"user_id": 2,
"description": "888"
}
```
< p >
Параметры объекта < b > Задача< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID задачи(int)
< / td >
< / tr >
< tr >
< td >
project_id
< / td >
< td >
ID проекта(int)
< / td >
< / tr >
< tr >
< td >
title
< / td >
< td >
Название задачи(string)
< / td >
< / tr >
< tr >
< td >
status
< / td >
< td >
Статус(int)
< / td >
< / tr >
< tr >
< td >
created_at
< / td >
< td >
Дата создания(string)
< / td >
< / tr >
< tr >
< td >
updated_at
< / td >
< td >
Дата изменения(string)
< / td >
< / tr >
< tr >
< td >
2021-12-06 15:13:31 +03:00
user_id_creator
2021-11-25 12:33:08 +03:00
< / td >
< td >
2021-12-06 15:13:31 +03:00
ID сотрудника, создатель задачи(int)
2021-11-25 12:33:08 +03:00
< / td >
< / tr >
< tr >
< td >
user_id
< / td >
< td >
ID сотрудника(int)
< / td >
< / tr >
< tr >
< td >
description
< / td >
< td >
Описание задачи(string)
< / td >
< / tr >
< / table >
< p >
Если задача не найдена будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "The task does not exist",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
## Исполнители задачи
### Список исполнителей задачи
`https://guild.craft-group.xyz/api/task-user/get-task-users`
< p >
Для получения списка исполнителей необходимо отправить < b > GET< / b > запрос на URL https://guild.craft-group.xyz/api/task-user/get-task-users
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID задачи
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/task-user/get-task-users?task_id=10`
< p >
Возвращает массив сотрудников проекта закреплённых за задачей. < br >
Каждый ответ имеет такой вид:
< / p >
```json5
[
{
"id": 5,
"task_id": 10,
"project_user_id": 1
},
{
"id": 7,
"task_id": 10,
"project_user_id": 5
}
]
```
< p >
Параметры объекта < b > Исполнитель< / b > :
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
id
< / td >
< td >
ID исполнителя задачи(int)
< / td >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID задачи(int)
< / td >
< / tr >
< tr >
< td >
project_user_id
< / td >
< td >
ID сотрудника на проекте(int)
< / td >
< / tr >
< / table >
< p >
Если задача не найдена будет отправлено следующее сообщение:
< / p >
```json5
{
"name": "Not Found",
"message": "The task does not exist or there are no employees for it",
"code": 0,
"status": 404,
"type": "yii\\web\\NotFoundHttpException"
}
```
### Назначить сотрудника на задачу
2022-03-21 16:11:56 +03:00
`https://guild.craft-group.xyz/api/task-user/set-task-users`
2021-11-25 12:33:08 +03:00
< p >
Для назначения исполнителя необходимо отправить < b > POST< / b > запрос на URL https://guild.craft-group.xyz/api/task-user/set-task-user
< / p >
< p >
Требуемые параметры:
< / p >
< table >
< tr >
< th >
Параметры
< / th >
< th >
Значение
< / th >
< / tr >
< tr >
< td >
task_id
< / td >
< td >
ID задачи
< / td >
< / tr >
< tr >
< td >
project_user_id
< / td >
< td >
ID сотрудника на проекте
< / td >
< / tr >
< / table >
< p >
Пример запроса:
< / p >
`https://guild.craft-group.xyz/api/task-user/set-task-user`
< p >
Возвращает объект < b > Исполнителя задачи< / b > .< br >
Каждый ответ имеет такой вид:
< / p >
```json5
{
"task_id": "10",
"project_user_id": "5",
"id": 8
}
```
< p >
Если задача не найдена будет отправлено следующее сообщение:
< / p >
2021-11-12 14:30:01 +03:00
2021-11-25 12:33:08 +03:00
```json5
{
"name": "Bad Request",
"message": "{\"task_id\":[\"\З а а а
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
```
