Skip to content

Commit

Permalink
Moved view the response/invitation to OpenAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
@DaniilIdrisov
DaniilIdrisov committed Apr 12, 2024
1 parent e42b281 commit a0e0967
Showing 1 changed file with 1 addition and 247 deletions.
248 changes: 1 addition & 247 deletions docs_eng/employer_negotiations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -493,253 +493,7 @@ required_arguments | list | Arguments that must also be passed if this argument
<a name="get-negotiation"></a>
## View the response/invitation

### Request

```
GET /negotiations/{nid}
```

where `nid` is the response/invitation ID.

Usually is taken from key `url` in
[the list of responses/invitations](#negotiations-list).

### Response

Successful server response is returned with `200 OK` code and contains:

```json
{
"id": "123456789",
"created_at": "2015-05-14T00:00:00+0300",
"updated_at": "2015-05-14T12:00:05+0300",
"has_updates": true,
"messages_url": "https://api.hh.ru/negotiations/123456789/messages",
"messaging_status": "ok",
"state": {
"id": "response",
"name": "Response"
},
"employer_state": {
"id": "response",
"name": "Response"
},
"actions": [
{
"id": "invitation",
"name": "Invite",
"enabled": true,
"method": "PUT",
"url": "https://api.hh.ru/negotiations/somecollection/123456789",
"resulting_employer_state": {
"id": "invitation",
"name": "Invitation"
},
"templates": [
{
"id": "invite_after_response",
"name": "Invite responded applicant",
"quick": false,
"url": "https://api.hh.ru/message_templates/invite_after_response?topic_id=123456789"
}
],
"arguments": [
{
"id": "message",
"required": true,
"required_arguments": []
},
{
"id": "send_sms",
"required": false,
"required_arguments": [
{
"id": "message"
}
]
},
{
"id": "address_id",
"required": false,
"required_arguments": [
{
"id": "message"
}
]
}
]
},
{
"id": "hold",
"name": "Think",
"enabled": true,
"method": "PUT",
"url": "https://api.hh.ru/negotiations/hold/123456789",
"arguments": [],
"resulting_employer_state": null,
"templates": []
}
],
"viewed_by_opponent": false,
"resume": {
"id": "0123456789abcdef",
"title": "Young specialist",
"url": "https://api.hh.ru/resumes/0123456789abcdef?topic_id=123456789",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"age": 19,
"alternate_url": "https://hh.ru/resume/0123456789abcdef?vacancyId=123456&t=123456789",
"created_at": "2015-02-06T12:00:00+0300",
"updated_at": "2015-04-20T16:24:15+0300",
"area": {
"id": "1",
"name": "Moscow",
"url": "https://api.hh.ru/areas/1"
},
"certificate": [
{
"achieved_at": "2015-01-01",
"owner": null,
"title": "test",
"type": "custom",
"url": "http://example.com/"
}
],
"education": {
"primary": [
{
"name": "Russian State Social University, Moscow",
"name_id": "39420",
"organization": "IT Department",
"organization_id": null,
"result": "",
"result_id": null,
"year": 2012
}
],
"level": {
"id": "higher",
"name": "Higher"
}
},
"total_experience": {
"months": 118
},
"experience": [
{
"area": {
"id": "1",
"name": "Moscow",
"url": "https://api.hh.ru/areas/1"
},
"company": "Roga i Kopyta",
"company_id": null,
"company_url": "http://example.com/",
"employer": null,
"end": "1999-03-01",
"industries": [
{
"id": "45.507",
"name": "Mining and dressing of ferrous, non-ferrous, precious, noble and rare metals"
}
],
"industry": null,
"start": "1998-01-01"
}
],
"gender": {
"id": "male",
"name": "Male"
},
"salary": {
"amount": 1000000,
"currency": "RUR"
},
"owner": {
"id": "123456",
"comments": {
"url": "https://api.hh.ru/applicant_comments/123456",
"counters": {
"total": 7
}
}
},
"negotiations_history": {
"url": "https://api.hh.ru/resumes/0123456789abcdef/negotiations_history"
},
"download": {
"pdf": {
"url": "https://hh.ru/api_resume_converter/0123456789abcdef/IvanovIvanIvanovich.pdf?type=pdf"
},
"rtf": {
"url": "https://hh.ru/api_resume_converter/0123456789abcdef/IvanovIvanIvanovich.rtf?type=rtf"
}
}
},
"vacancy": {
"address": null,
"alternate_url": "https://hh.ru/vacancy/123456",
"archived": false,
"area": {
"id": "1",
"name": "Moscow",
"url": "https://api.hh.ru/areas/1"
},
"created_at": "2015-05-14T11:00:00+0300",
"employer": {
"alternate_url": "https://hh.ru/employer/1",
"id": "1",
"logo_urls": {
"240": "https://hh.ru/employer-logo/1111.jpeg",
"90": "https://hh.ru/employer-logo/1111.jpeg",
"original": "https://hh.ru/employer-logo-original/1111.jpeg"
},
"name": "Roga i Kopyta",
"url": "https://api.hh.ru/employers/1",
"vacancies_url": "https://api.hh.ru/vacancies?employer_id=1"
},
"id": "123456",
"name": "Manager",
"premium": false,
"published_at": "2015-05-14T10:00:00+0300",
"response_letter_required": false,
"salary": null,
"type": {
"id": "closed",
"name": "Closed"
},
"url": "https://api.hh.ru/vacancies/123456?host=hh.ru"
},
"counters": {
"messages": 100,
"unread_messages": 50
},
"test_result": {
"url": "https://api.hh.ru/negotiations/1359970704/test/solution",
"alternate_url": "https://hh.ru/employer/vacancy_response/test?topicId=1359970704",
"score": 100,
"mark": "EXCELLENT"
}
}
```

Response body is identical
[to the element in the list of responses/invitations](#negotiations-list-item), and
contains key `vacancy` giving
[short info regarding vacancy](vacancies.md#nano).

<a name="messaging_status"></a>
Additionally, field `messaging_status` showing negotiation status
is returned for the response/invitation and field `professional_roles` containing professional roles list. Possible values
see in [messaging_status](https://api.hh.ru/openapi/en/redoc#tag/Public-directories/operation/get-dictionaries) reference guide.
Possible values
see in [professional_roles](https://api.hh.ru/openapi/en/redoc#tag/Public-directories/operation/get-professional-roles-dictionary) reference guide.

If response/invitation doesn't exist or not available to the current user,
`404 Not Found` response will be returned.


>!! Method is defined in [OpenAPI](https://api.hh.ru/openapi/en/redoc#tag/Employer-responsesinvitations/operation/get-negotiation-item)
## View the list of messages in the response/invitation

Expand Down

0 comments on commit a0e0967

Please sign in to comment.