guild/docs/api/profile.md
2022-03-21 19:08:39 +03:00

7.0 KiB
Raw Blame History

Профиль

Методы

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

Список

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

Возвращает объект Профиля.
Как выглядит можно посмотреть выше.

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

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 Должность