guild/docs/api/profile.md
2022-12-27 11:45:28 +03:00

13 KiB
Raw Blame History

Профиль

Методы

Метод Описание
profile Возвращает список профилей
profile/{id} Возвращает один профиль
profile/profile-with-report-permission Получить профиль с флагом прав на просмотр отчётов этого пользователя
profile/get-main-data Получить получить основные данные профиля
profile/portfolio-projects Массив проектов в портфолио(для страницы мой код)

Список

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

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

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

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

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

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

Возвращает массив объектов Профилей.
Каждый объект Профиля имеет такой вид:

{
  "id": "1",
  "fio": "f23f",
  "passport": "f23", 
  "photo": "''", 
  "email": "f", 
  "gender": "1", 
  "dob": "2021-09-17", 
  "status": "2",
  "created_at": "2021-09-08 16:30:34",
  "updated_at": "2021-09-09 08:41:02",
  "resume": "", 
  "salary": "", 
  "position_id": "1",
  "deleted_at": null, 
  "id_user": "1", 
  "city": "", 
  "link_vk": "",
  "link_telegram": "",
  "vc_text": "",
  "level": "2", //
  "vc_text_short": "",
  "years_of_exp": "0",
  "specification": "",
  "skillValues": [ //Массив навыков привязанных к этому профилю
    {
      "id": "1",
      "card_id": "1", //card_id из таблицы card_skill
      "skill_id": "1",//skill_id из таблицы card_skill
      "skill": {
        "id": "1", //id из таблицы skill
        "name": "SQL",
        "category_id": "1"
      }
    },
    //...
  ],
  "achievements": [ //Массив достижений привязанных к этому профилю
    {
      "id": "7",
      "user_card_id": "1",//user_card_id из таблицы achievement_user_card
      "achievement_id": "1",//achievement_id из таблицы achievement_user_card
      "achievement": {
        "id": "1", //id из таблицы achievement
        "slug": "newguy",
        "title": "Новичок",
        "img": "",
        "description": "Ты начал у нас работу",
        "status": "1" // 1 - Активно, 2 - Неактивно
      }
    },
    //...
  ]
}

Одна запись

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

Возвращает объект Профиля.

{
    "id": 1,
    "fio": "йцукенг дльпдрьап",
    "photo": "",
    "gender": 0,
    "dob": null,
    "status": 3,
    "created_at": null,
    "updated_at": "2022-12-23 01:01:34",
    "salary": null,
    "position_id": 1,
    "deleted_at": null,
    "id_user": 1,
    "city": "",
    "vc_text": "<h3><strong>Itguild</strong></h3><h4>Стек  Yii2, MySQL, Adminlte, PHPWord, Widgets  Kartik, Yii2-mpdf</h4><p>Разработка модулей:</p><p>Тестирования кандидатов. Обеспечивает: подготовку тестовых анкет с различными типами вопросов(открытый вопрос; несколько вариантов ответа; истина — ложь и т. д.); проведения тестирования; автоматическое оценивание результата.</p><p>Управление сотрудниками. Обеспечивает: менеджмент сотрудников; контроль распределения и выполнения задч.</p><p>Документы. Обеспечивает: создание шаблонов документов и генирацию файлов на их основе в формате DOCX и PDF.</p><p>Доработка иеющихся функциональных модулей, тестирование, разработка апи, ведение документации проекта.</p><p>&nbsp;</p><h3><strong>keepminingstrong</strong></h3><h4>Стек  Yii2, swiftmailer, HTML, CSS</h4><p>Многоязычного сайта-визитка, с возможностью обратной связи для пользователей по средствам электронных сообщений.</p><p>&nbsp;</p><h3><strong>PeopleControl</strong></h3>",
    "level": 1,
    "vc_text_short": "<br><br><br><br><h3>dfghjk uuu@mail.com <br/<br/<br/<br/Женщина dfghj Middlejjkbd</h3><p>&nbsp;br</p><p>&nbsp;<i><br><strong> dcdvcds</strong></br></i></p><h4>kdsmc</h4><p>kjnd</p><p>&nbsp;</p><ul><li>djnj &nbsp;&nbsp;</li></ul><ol><li>dknckn &nbsp;</li></ol>",
    "years_of_exp": null,
    "specification": "",
    "test_task_getting_date": null,
    "test_task_complete_date": null,
    "resume_text": "<h3><strong>Itguild</strong></h3>\n        <h4>Стек  Yii2, MySQL, Adminlte, PHPWord, Widgets  Kartik, Yii2-mpdf</h4>\n        <p>Разработка модулей:</p>\n        <p>Тестирования кандидатов. Обеспечивает: подготовку тестовых анкет с различными типами вопросов(открытый вопрос; несколько вариантов ответа; истина — ложь и т. д.); проведения тестирования; автоматическое оценивание результата.</p>\n        <p>Управление сотрудниками. Обеспечивает: менеджмент сотрудников; контроль распределения и выполнения задч.</p>\n        <p>Документы. Обеспечивает: создание шаблонов документов и генирацию файлов на их основе в формате DOCX и PDF.</p>\n        <p>Доработка иеющихся функциональных модулей, тестирование, разработка апи, ведение документации проекта.</p>\n        <p>&nbsp;</p>\n        <h3><strong>keepminingstrong</strong></h3>\n        <h4>Стек  Yii2, swiftmailer, HTML, CSS</h4>\n        <p>Многоязычного сайта-визитка, с возможностью обратной связи для пользователей по средствам электронных сообщений.</p>\n        <p>&nbsp;</p>\n        <h3><strong>PeopleControl</strong></h3>",
    "resume_template_id": 4,
    "resume_tariff": null,
    "at_project": null,
    "skillValues": [
        {
            "id": 1,
            "card_id": 1,
            "skill_id": 1,
            "skill": {
                "id": 1,
                "name": "JS",
                "category_id": 1
            }
        }
    ],
    "achievements": []
}

Получить профиль с флагом прав на просмотр отчётов этого пользователя

https://guild.craft-group.xyz/api/profile/profile-with-report-permission

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

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

Параметры Значение
id ID профиля пользователя

Основные данные пользователя

https://guild.craft-group.xyz/api/profile/get-main-data?user_id=1

Требуемые параметры:

Параметры Значение
user_id Id профиля пользователя

Возвращает объект Пользователь.
Каждый объект Пользователь имеет такой вид:

{
  "fio": "Тест менеджер для апи запроса",
  "photo": null,
  "gender": 1,
  "level": 2,
  "years_of_exp": null,
  "specification": null,
  "position_name": "Должность 1"
}

Возвращаемые параметры:

Параметры Значение
fio ФИО
photo Ссылка на фото
gender Пол
level Уровень
years_of_exp Лет опыта
position_name Должность

Массив проектов в портфолио(для страницы мой код)

https://guild.craft-group.xyz/api/profile/profile/portfolio-projects?card_id=9

Требуемые параметры:

Параметры Значение
card_id Id профиля пользователя

Возвращает массив объектов Проект в портфолио.
Ответ имеет следующий вид:

[
  {
    "id": 11,
    "title": "yguyyyyy",
    "description": "пппппппппппп",
    "main_stack": "JS",
    "additional_stack": "jnvbklfbmklfdv",
    "link": "11111"
  },
  {
    "id": 12,
    "title": "smclksdmk",
    "description": "ссссссссссс",
    "main_stack": "JS",
    "additional_stack": "ksdlkcmskl",
    "link": "kwemfdkflefmkl"
  }
]

Возвращаемые параметры:

Параметры Значение
id Id
title название
description описание
main_stack основной язык проекта
additional_stack используемые технологии
link ссылка на репозиторий