-
Notifications
You must be signed in to change notification settings - Fork 168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
HH-123770 отделы работодателей #473
Open
vorobey92
wants to merge
7
commits into
master
Choose a base branch
from
HH-123770
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e89a20c
HH-123770 черновик апи по отделам
vorobey92 5780ba7
HH-123770 2-я итерация по отделам работодателя
vorobey92 f4a3e6c
HH-123770 'текущий' -> 'выбранный'
vorobey92 0925e7a
HH-123770 добавил описание ошибок
vorobey92 deeaed0
HH-123770 добавил пейджинг
vorobey92 4773b77
HH-123770 добавил отдел в просмотр и редактирование вакансии
vorobey92 05917f9
HH-123770 404, если нет отделов
vorobey92 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Отделы менеджера | ||
|
||
Менеджер может выполнять действия от лица нескольких отделов. Для взаимодействия с API в контексте определенного | ||
отдела работодателя нужно использовать соответсвующий отдел. | ||
У пользователя может быть несколько отделов, один из них является текущим. Какой отдел является текущим можно узнать, | ||
получив [список отделов менеджера](#get-manager-divisions). Текущий отдела используется, если в качестве авторизации посылать только токен | ||
(подробнее можно прочитать [здесь](#using-division)). | ||
|
||
* [Получение списка отделов пользователя](#get-manager-divisions) | ||
* [Выбор отдела при запросах](#using-division) | ||
|
||
<a name="get-manager-divisions"></a> | ||
## Получение списка отделов пользователя | ||
|
||
### Запрос | ||
|
||
``` | ||
GET /manager_divisions/mine | ||
``` | ||
|
||
### Ответ | ||
|
||
Успешный ответ приходит с кодом `200 OK` и содержит тело: | ||
|
||
```json | ||
{ | ||
iriss22 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"items": [ | ||
{ | ||
"id": "1", | ||
"name": "Департамент персонала" | ||
}, | ||
{ | ||
"id": "2", | ||
"name": "Департамент продаж" | ||
} | ||
], | ||
"current_division_id": "2" | ||
} | ||
``` | ||
|
||
где: | ||
|
||
Имя | Тип | Описание | ||
--- | --- | ------ | ||
items | список | список отделов менеджера | ||
current_division_id | строка | идентификатор текущего отдела (совпадает со значением переданного в заголовке) | ||
|
||
<a name="division-info"></a> | ||
#### Объект `division` | ||
|
||
Имя | Тип | Описание | ||
--- | --- | ------ | ||
id | строка | идентификатор отдела | ||
name | строка | название отдела компании | ||
|
||
### Ошибки | ||
|
||
* `403 Forbidden` — ошибка авторизации (пользователь не является менеджером) | ||
|
||
|
||
<a name="using-division"></a> | ||
## Выбор отдела при запросах | ||
|
||
Для работы под определенным отделом необходимо передать значение `division_id`, полученное из [списка](#get-manager-divisions), в заголовке: | ||
|
||
``` | ||
X-Manager-Division-Id: {division_id} | ||
``` | ||
|
||
Использовать данный заголовок можно во всех методах, доступных для работодателей. | ||
|
||
В заголовке можно передавать `division_id` текущего отдела, который также подразумевается по умолчанию, при отсутсвии заголовка. | ||
|
||
|
||
<a name="errors"></a> | ||
## Ошибки | ||
|
||
* `403 Forbidden` — отдел с переданным `division_id` не найден. Дополнительно к коду вернется причина ошибки | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
* `403 Forbidden` — ошибка авторизации (при запросах с авторизацией не работодателя) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
выбранного или переданного отдела, наверное. Можно ведь не текущий передать в заголовке