{ "openapi": "3.0.0", "info": { "title": "HURMA PUBLIC API V1 ENDPOINTS", "description": "AUTHENTICATION TIP: For secure access to our API,\n * please remember to put your authorization token in the request headers, not in the parameters.", "version": "1.0.0" }, "servers": [ { "url": "https://hurma.work/api/v1", "description": "Use your HURMA domain" } ], "paths": { "/candidate/{id}/comment": { "get": { "tags": [ "Candidate" ], "summary": "Information on candidate comments", "operationId": "aefc049cb90afbdb9297a071b56f6a6c", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Ідентифікатор кандидата", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidate.comment.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/candidate": { "get": { "tags": [ "Candidate" ], "summary": "Information on candidates", "operationId": "58248d515b37641db0eb610bef68a42b", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "responsible_recruiter_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "vacancy_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "stage_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "source", "in": "query", "description": "(Deprecated) Not selected = 999, LinkedIn = 1, Work.ua = 2, Robota.ua = 3, GRC = 4, Dou.ua = 5, Djinni.co = 6, Inco.works = 7, Recruiter chats = 8, Recommendation = 9, Employee recomendation = 10, Corporate website = 11, Personal appeal = 12, other = 13, Facebook = 14, Recruitment agency = 15, Public vacancy = 16, SuperJob = 17, Habr Career = 18", "required": false, "deprecated": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "vacancy_sources", "in": "query", "description": "Not selected = 999, LinkedIn = 1, Work.ua = 2, Robota.ua = 3, GRC = 4, Dou.ua = 5, Djinni.co = 6, Inco.works = 7, Recruiter chats = 8, Recommendation = 9, Employee recomendation = 10, Corporate website = 11, Personal appeal = 12, other = 13, Facebook = 14, Recruitment agency = 15, Public vacancy = 16, SuperJob = 17, Habr Career = 18", "required": false, "schema": { "type": "integer" }, "example": "vacancy_sources[] = 1" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidate.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } }, "post": { "tags": [ "Candidate" ], "summary": "Create a candidate", "description": "curl request example\ncurl --location --request POST 'https://hurma.work/api/v1/candidate' \\\n--header 'token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--form 'name='Stepan Andriyovych'' \\\n--form 'phone='phone'' \\\n--form 'email='email@email.com'' \\\n--form 'description='Additiona info'' \\\n--form 'hurma_vacancy_id='1'' \\\n--form 'cv=@'/home/user/downloads/StepanAndriyovych-cv.pdf''", "operationId": "04940c5d59fd57f79d59cc820211f3fc", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidate.create" } } } }, "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidate.create.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/candidate/{id}": { "get": { "tags": [ "Candidate" ], "summary": "Candidate information", "operationId": "5213e77126b0092003f3b0fb9726cdd9", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "candidate id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Candidate.single.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/custom-properties": { "get": { "tags": [ "CustomProperty" ], "summary": "Information on custom properties", "operationId": "eb4216f7f1871a31052233fba45c4d68", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomProperty.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/business-trip": { "get": { "tags": [ "Departments" ], "summary": "Business trip", "description": "Handle HTTP requests regarding Customers.", "operationId": "03c2c7de811481ee4122ce8973509677", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments": { "get": { "tags": [ "Departments" ], "summary": "Departments list", "description": "Handle HTTP requests regarding Customers.", "operationId": "f872668816930ee221eaefbd07b4a99e", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/home-work": { "get": { "tags": [ "Departments" ], "summary": "Remote work", "description": "Handle HTTP requests regarding Customers.", "operationId": "9094596d2588ccc892d513de8dec8091", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/not-in-office": { "get": { "tags": [ "Departments" ], "summary": "Absent in the office", "description": "Handle HTTP requests regarding Customers.", "operationId": "670d52edab3ea3ab86bc7f7705478511", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/sick-leave": { "get": { "tags": [ "Departments" ], "summary": "Sick leave", "description": "Handle HTTP requests regarding Customers.", "operationId": "cc7efb45ebe462292de73970c6df197e", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/sick-leave-documented": { "get": { "tags": [ "Departments" ], "summary": "Documented sick leave", "description": "Handle HTTP requests regarding Customers.", "operationId": "858fff6b79301e671ac5a9877e02f5b8", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/unpaid-vacations": { "get": { "tags": [ "Departments" ], "summary": "Unpaid vacation", "description": "Handle HTTP requests regarding Customers.", "operationId": "6b257ab828f7905e50e9771cc53b62c4", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/departments/{id}/vacations": { "get": { "tags": [ "Departments" ], "summary": "Vacation", "description": "Handle HTTP requests regarding Customers.", "operationId": "ca9b25bffc06f4eac6a433576a973c84", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Department id", "required": true, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/vacation/balance": { "get": { "tags": [ "Absence balance" ], "summary": "Information on vacation balance of employee", "operationId": "26156e71b1521561e9e8aa7c478cbed4", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "personal-token", "in": "header", "description": "Personal Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee.vacation.balance.single.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/vacation/balance": { "post": { "tags": [ "Absence balance" ], "summary": "Change absence vacation balance", "operationId": "090c37e905d4feb9ec71d5258cfe8084", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee.change.vacation.balance" } } } }, "responses": { "200": { "description": "ОК" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/business-trip": { "get": { "tags": [ "Employees" ], "summary": "Business trip", "description": "Handle HTTP requests regarding Customers.", "operationId": "dc12e6d203e7e7723af86a47a09e93dd", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees": { "get": { "tags": [ "Employees" ], "summary": "List employees", "description": "Handle HTTP requests regarding Customers.", "operationId": "1dce49c8aac6c9a42fcfcc681935049d", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "status", "in": "query", "description": "7 - employees on a probationary period, 8 - current and fired employees, 9 - current employees (including employees on probation)", "required": false, "schema": { "type": "integer" }, "example": "8" }, { "name": "email", "in": "query", "required": false, "schema": { "type": "string" }, "example": "email@gmail.com" }, { "name": "started_work_from", "in": "query", "description": "Format Y-m-d", "required": false, "schema": { "type": "string" }, "example": "2013-05-13" }, { "name": "started_work_to", "in": "query", "description": "Format Y-m-d", "required": false, "schema": { "type": "string" }, "example": "2013-05-13" }, { "name": "finished_work_from", "in": "query", "description": "Format Y-m-d", "required": false, "schema": { "type": "string" }, "example": "2013-05-13" }, { "name": "finished_work_to", "in": "query", "description": "Format Y-m-d", "required": false, "schema": { "type": "string" }, "example": "2013-05-13" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/home-work": { "get": { "tags": [ "Employees" ], "summary": "Remote work", "description": "Handle HTTP requests regarding Customers.", "operationId": "5065b1ade435c4ab7a015f5a3d55757d", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/not-in-office": { "get": { "tags": [ "Employees" ], "summary": "Absent in office", "description": "Handle HTTP requests regarding Customers.", "operationId": "e7f8ffa87f33a7e86cd751b445fd13d9", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/sick-leave": { "get": { "tags": [ "Employees" ], "summary": "Sick leave", "description": "Handle HTTP requests regarding Customers.", "operationId": "9e807f4d84a37fc23ad5d88b3e455aee", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/sick-leave-documented": { "get": { "tags": [ "Employees" ], "summary": "Documented sick leave", "description": "Handle HTTP requests regarding Customers.", "operationId": "ba0b5838c69dab32777bca534863eba0", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/unpaid-vacations": { "get": { "tags": [ "Employees" ], "summary": "Unpaid vacation", "description": "Handle HTTP requests regarding Customers.", "operationId": "cae00eb4a8355cbbbf0be568040138df", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/vacation": { "post": { "tags": [ "Absence" ], "summary": "Create absence vacation", "operationId": "0129c7f615654ec83f261293c96ace5f", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "personal-token", "in": "header", "description": "Personal Api token", "required": false, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee.create.vacation" } } } }, "responses": { "200": { "description": "ОК" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "409": { "description": "There are already absences during this period", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse409" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/vacation/remove": { "post": { "tags": [ "Absence" ], "summary": "Remove absence vacation", "operationId": "65323c246329ffa0bd77873095d20fd4", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "personal-token", "in": "header", "description": "Personal Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee.remove.vacation" } } } }, "responses": { "200": { "description": "ОК" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/employees/{id}/vacations": { "get": { "tags": [ "Employees" ], "summary": "Vacation", "description": "Handle HTTP requests regarding Customers.", "operationId": "f3a91f7be9d53eaa5db8bbd52f8dc2ed", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Employee id or email", "required": true, "schema": { "type": "string" }, "example": "ND or employees@mail.com" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Departments.employee.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/out-off-office": { "get": { "tags": [ "Out Of Office" ], "summary": "Out of office", "description": "Handle HTTP requests regarding Customers.", "operationId": "9fea753296b781c4045341eedaad5a91", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "status", "in": "query", "description": "7 - employees on a probationary period, 8 - current and fired employees, 9 - current employees (including employees on probation)", "required": false, "schema": { "type": "integer" }, "example": "8" }, { "name": "additional_info", "in": "query", "description": "if set 1 display absence with hours, if not set display only date of absence", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutOfOffice.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/overtimes-export": { "post": { "tags": [ "Overtime Export" ], "summary": "Overtime Export", "description": "curl request example\n * curl --location --request POST 'https://hurma.work/api/v1/overtimes-export' \\\n * --header 'token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n * --header 'personal-token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n * --form 'employees[]='1'' \\\n * --form 'end_date='31-05-2022'' \\\n * --form 'start_date='02-05-2022''", "operationId": "9a53f1b20b4b0c6aed71e20a873d6452", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "personal-token", "in": "header", "description": "Personal Api token", "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "employees[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": "[bg7, g9, vh3]" }, { "name": "start_period", "in": "query", "required": true, "schema": { "type": "string" }, "example": "01-01-2022" }, { "name": "end_period", "in": "query", "required": true, "schema": { "type": "string" }, "example": "31-01-2022" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverTime.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/payroll/report/{id}": { "get": { "tags": [ "Payroll" ], "summary": "Download payroll report", "description": "curl request example\ncurl --location --request GET 'https://hurma.work/api/v1/payroll/report/{id}' \\\n--header 'token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--header 'personal-token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--form 'id='7''", "operationId": "c6762b018cf0d56a4e133d3c22616568", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Report id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } }, "deprecated": true } }, "/payroll/report/file/{id}": { "get": { "tags": [ "Payroll" ], "summary": "Download payroll report", "description": "curl request example\ncurl --location --request GET 'https://hurma.work/api/v1/payroll/report/file/{id}' \\\n--header 'token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--header 'personal-token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--form 'id='7''", "operationId": "1a5bdb18670d0f69c1904e891cd3e846", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "Report id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll.download.file.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/payroll/report": { "get": { "tags": [ "Payroll" ], "summary": "Information on payroll reports", "operationId": "86a7dccd2a9795e11ab3d0896f456e4a", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payroll.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } }, "post": { "tags": [ "Payroll" ], "summary": "Generate payroll report", "description": "curl request example\ncurl --location --request POST 'https://hurma.work/api/v1/payroll/report' \\\n--header 'token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--header 'personal-token: 886308a96833251c04ee18fff519a7aa15073256d6a5460587bd892e40e58c53d0dcab74cdde736' \\\n--form 'name='report'' \\\n--form 'end_date='31-05-2022'' \\\n--form 'start_date='02-05-2022''", "operationId": "634506cc0064f7f4a83edbcdbe453f36", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "personal-token", "in": "header", "description": "Personal Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "name", "in": "query", "schema": { "type": "string" }, "example": "test name" }, { "name": "start_date", "in": "query", "schema": { "type": "string" }, "example": "01-01-2022" }, { "name": "end_date", "in": "query", "schema": { "type": "string" }, "example": "31-01-2022" } ], "responses": { "200": { "description": "ОК" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/responsible-recruiter": { "get": { "tags": [ "Assigned recruiter" ], "summary": "Information on assigned recruiters", "operationId": "2250ab23bdfe9c0c15fff670c1fa25af", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "candidate_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "vacancy_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responsible.recruiter.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/responsible-recruiter/{id}": { "get": { "tags": [ "Assigned recruiter" ], "summary": "Information on assigned recruiter", "operationId": "3b82105826e310c9d7095a5a814613bb", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "assigned recruiter id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Responsible.recruiter.single.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/stage": { "get": { "tags": [ "Stage" ], "summary": "Information on recruitment funnel stages", "operationId": "d8c39ff8c8c1e5b6eeb08bf236ec989c", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "parent_stage_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/stage/{id}": { "get": { "tags": [ "Stage" ], "summary": "Information on recruitment funnel stage", "operationId": "269dc3dcec285f4f9d9c4208acdf400c", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "funnel stage id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage.single.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/vacancy/stages": { "get": { "tags": [ "Job opening" ], "summary": "Job opening funnel stages info", "operationId": "1b99f11c8dc060d830c2f46ea230d09f", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "vacancy_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "stage_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "candidate_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vacancy.stages.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/vacancy": { "get": { "tags": [ "Job opening" ], "summary": "Information on job openings", "operationId": "16704c27d5b4cc0a64c4bbda42590738", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "recruiter_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "status", "in": "query", "description": "Open = 1, Pause = 2, Close = 3, In progress = 4, Canceled = 5", "required": false, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vacancy.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/vacancy/{id}": { "get": { "tags": [ "Job opening" ], "summary": "Information on job openings", "operationId": "9a9d4e69003842b2ce9ef3bcd19ad80a", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "id", "in": "path", "description": "job opening id", "required": true, "schema": { "type": "integer" }, "example": 1 } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vacancy.single.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } }, "/vacancy/stage/history": { "get": { "tags": [ "Job opening" ], "summary": "Information on actions on job opening funnel stages", "operationId": "cb84135c26300780bb756bee75767c7f", "parameters": [ { "name": "token", "in": "header", "description": "Api token", "required": true, "schema": { "type": "string" }, "example": "886308a96833251c041118fff519a7aa15v73256d6a5460587bd892e40e58c53d123ab74cdde736" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "10" }, { "name": "vacancy_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "stage_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "candidate_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "author_id", "in": "query", "required": false, "schema": { "type": "integer" }, "example": "1" }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2022-03-11 10:32:00" }, { "name": "date_to", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2022-03-11 10:32:00" } ], "responses": { "200": { "description": "ОК", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vacancy.stages.history.list.response" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse403" } } } }, "422": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse422" } } } } } } } }, "components": { "schemas": { "Candidate.comment.list.response": { "description": "Information on candidate comments", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "text": { "type": "string", "example": "Some comment" }, "author_id": { "description": "Id of employee", "type": "integer", "example": 1 }, "created_at": { "description": "Format Y-m-d H:i:s", "type": "string", "example": "2022-01-22 12:32:44" }, "updated_at": { "description": "Format Y-m-d H:i:s", "type": "string", "example": "2022-01-23 12:00:00" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Departments.response": { "description": "Information on department", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "people_id": { "type": "string", "example": "Jx" }, "day": { "type": "string", "example": "2020-03-16" }, "type_id": { "type": "integer", "example": 1 }, "type_description": { "type": "string", "example": "string" }, "status": { "type": "string", "example": "Approved" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean" }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "ErrorResponse403": { "description": "Error response", "properties": { "result": { "type": "string", "example": "Error" }, "error": { "type": "boolean" }, "code": { "type": "integer", "example": 403 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "ErrorResponse409": { "description": "Error response", "properties": { "result": { "type": "string", "example": "Error" }, "error": { "type": "boolean" }, "code": { "type": "integer", "example": 409 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "api.v1.candidate.custom_property.ItemArray": { "description": "custom property array value", "properties": { "id": { "type": "integer", "example": 1 }, "value": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "nullable": true } }, "type": "object" }, "api.v1.candidate.custom_property.ItemString": { "description": "custom property string value", "properties": { "id": { "type": "integer", "example": 2 }, "value": { "type": "string", "nullable": true } }, "type": "object" }, "api.v1.candidate.custom_property.ItemInteger": { "description": "custom property integer value", "properties": { "id": { "type": "integer", "example": 3 }, "value": { "type": "integer", "nullable": true } }, "type": "object" }, "ErrorResponse422": { "description": "Error response", "properties": { "result": { "type": "string", "example": "Error" }, "error": { "type": "boolean" }, "code": { "type": "integer", "example": 422 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Candidate.create": { "description": "Candidate data structure", "required": [ "name" ], "properties": { "name": { "description": "Full name", "type": "string", "example": "John Smith", "nullable": false }, "phone": { "description": "Phone number", "type": "string", "nullable": true }, "email": { "description": "Email", "type": "string", "nullable": true }, "description": { "description": "Description", "type": "string", "nullable": true }, "hurma_vacancy_id": { "description": "Vacancy id", "type": "integer", "example": 1, "nullable": true }, "cv": { "description": "File", "type": "string", "format": "binary", "nullable": true }, "position": { "description": "Position", "type": "string", "nullable": true }, "birth_date": { "description": "Format Y-m-d", "type": "string", "nullable": true }, "sex": { "description": "0 - no selected, 1 - men, 2 - women", "type": "string", "nullable": true }, "skype": { "description": "Skype", "type": "string", "nullable": true }, "linked_in": { "description": "Link to profile", "type": "string", "nullable": true }, "telegram": { "description": "Telegram nick", "type": "string", "nullable": true }, "current_job": { "description": "Current job", "type": "string", "nullable": true }, "job_comment": { "description": "Job comment", "type": "string", "nullable": true }, "education": { "description": "Education", "type": "string", "nullable": true }, "residence": { "description": "Residence", "type": "string", "nullable": true }, "relocate": { "description": "0 - false, 1 - true", "type": "string", "nullable": true }, "duties": { "description": "Duties", "type": "string", "nullable": true }, "additional_info": { "description": "Additional info", "type": "string", "nullable": true }, "custom_properties": { "description": "Custom properties", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/api.v1.candidate.custom_property.ItemArray" }, { "$ref": "#/components/schemas/api.v1.candidate.custom_property.ItemString" }, { "$ref": "#/components/schemas/api.v1.candidate.custom_property.ItemInteger" } ] }, "nullable": true } }, "type": "object" }, "Candidate.create.response": { "description": "Candidate creation result", "properties": { "result": { "type": "string", "example": "Success" }, "error": { "type": "boolean" }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Candidate.list.response": { "description": "Information on candidates", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v1.CandidateListResource" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Candidate.single.response": { "description": "Candidate data", "properties": { "result": { "$ref": "#/components/schemas/api.v1.CandidateListResource" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "api.v1.CandidateCustomPropertiesResource.Item": { "description": "Блок custom property с заполненными значениями", "properties": { "id": { "type": "integer", "example": 21 }, "name": { "type": "string", "example": "My block" }, "properties": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/api.v1.CandidateCustomPropertyResource.ItemArray" }, { "$ref": "#/components/schemas/api.v1.CandidateCustomPropertyResource.ItemString" }, { "$ref": "#/components/schemas/api.v1.CandidateCustomPropertyResource.ItemInteger" } ] } } }, "type": "object" }, "api.v1.CandidateCustomPropertyResource.ItemArray": { "description": "Блок значения custom property", "properties": { "id": { "type": "integer", "example": 21 }, "name": { "type": "string", "example": "My block" }, "type": { "type": "string", "enum": [ "text", "number", "textarea", "select", "multiselect" ], "example": "text" }, "value": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "nullable": true } }, "type": "object" }, "api.v1.CandidateCustomPropertyResource.ItemString": { "description": "Блок значения custom property", "properties": { "id": { "type": "integer", "example": 21 }, "name": { "type": "string", "example": "My block" }, "type": { "type": "string", "enum": [ "text", "number", "textarea", "select", "multiselect" ], "example": "text" }, "value": { "type": "string", "nullable": true } }, "type": "object" }, "api.v1.CandidateCustomPropertyResource.ItemInteger": { "description": "Блок значения custom property", "properties": { "id": { "type": "integer", "example": 21 }, "name": { "type": "string", "example": "My block" }, "type": { "type": "string", "enum": [ "text", "number", "textarea", "select", "multiselect" ], "example": "text" }, "value": { "type": "integer", "nullable": true } }, "type": "object" }, "api.v1.CandidateListResource": { "description": "APIv1 Candidate resource", "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Stepan Andriyovych" }, "source": { "description": "not selected = 0, LinkedIn = 1, Work.ua = 2, Rabota.ua = 3, HeadHunter(HH) = 4, Dou.ua = 5, Djinni.co = 6, Inco.works = 7, Recruiter chats = 8, Recomendation = 9, Emploee recomendation = 10, Corporate website = 11, Personal appeal = 12, other = 13, Facebook = 14, Recruitment agency = 15, Public vacancy = 16, SuperJob = 17 Habr Career = 18", "type": "integer", "example": 1 }, "position": { "type": "string", "example": "Team lead" }, "gender": { "description": "not selected = 0, Male = 1, Female = 2", "type": "integer", "example": 1 }, "current_positions": { "type": "string", "example": "Team lead" }, "wish_positions": { "type": "string", "example": "Team lead" }, "salary": { "properties": { "min_salary": { "type": "integer", "example": 1000 }, "max_salary": { "type": "integer", "example": 1000 }, "currency_code": { "type": "string", "example": "USD" } }, "type": "object" }, "experience": { "properties": { "experience_code": { "type": "integer", "example": 10 }, "experience": { "type": "string", "example": "Up to 1 yr." } }, "type": "object" }, "work_types": { "type": "array", "items": { "properties": { "type": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Full-time" } }, "type": "object" } }, "status_ids": { "type": "array", "items": { "type": "integer" } }, "blacklist": { "type": "integer", "example": 0 }, "languages": { "type": "array", "items": { "properties": { "language_id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "es" }, "level": { "type": "integer", "example": 2 } }, "type": "object" } }, "contacts": { "type": "array", "items": { "properties": { "type": { "type": "integer", "example": 2 }, "value": { "type": "string", "example": "es" } }, "type": "object" } }, "tags": { "type": "array", "items": { "properties": { "": { "type": "string", "example": "PHP" } }, "type": "object" } }, "recommended": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } }, "responsible_recruiters": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } }, "vacancies": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "stage_id": { "type": "integer", "example": 2 } }, "type": "object" } }, "custom_properties": { "type": "array", "items": { "$ref": "#/components/schemas/api.v1.CandidateCustomPropertiesResource.Item" } } }, "type": "object" }, "CustomProperty.list.response": { "description": "Information on custom properties", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/api.v1.CustomProperty.Item" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "api.v1.CustomProperty.Item": { "description": "Блок custom property", "properties": { "id": { "type": "integer", "example": 21 }, "name": { "type": "string", "example": "My block" }, "type": { "type": "string", "enum": [ "text", "number", "textarea", "select", "multiselect" ], "example": "text" }, "settings": { "type": "array", "items": { "type": "string" }, "example": "Array with options - ['options' => ['a', 'b', 'c']", "nullable": true }, "rules": { "properties": { "unique": { "type": "boolean", "example": true } }, "type": "object" } }, "type": "object" }, "Departments.list.response": { "description": "Department data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "type": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "HR Team" }, "number_of_members": { "type": "integer", "example": 5 }, "number_of_members_with_subteams": { "type": "integer", "example": 5 }, "team_leader_id": { "type": "string", "example": "Jx" }, "hr_ids": { "type": "array", "items": { "type": "string" } }, "managers": { "type": "array", "items": { "type": "string" } }, "subteams": { "type": "array", "items": { "type": "integer" } }, "parent_id": { "type": "integer", "example": null, "nullable": true } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Employee.vacation.balance.single.response": { "description": "Information on vacation balance of employee", "properties": { "result": { "properties": { "available_days": { "type": "string", "example": "15.67" } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Employee.change.vacation.balance": { "description": "Change absence vacation balance", "required": [ "id", "days", "action", "comment" ], "properties": { "id": { "description": "Id of employee", "type": "string", "example": "ND", "nullable": false }, "days": { "description": "Amount of days", "type": "string", "example": "1.67", "nullable": false }, "action": { "description": "Action type allowed values: add, sub, reset", "type": "string", "example": "add", "nullable": false }, "comment": { "description": "Comment", "type": "string", "example": "Change balance via api", "nullable": false } }, "type": "object" }, "Departments.employee.response": { "description": "Department data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "people_id": { "type": "string", "example": "MS" }, "event_id": { "type": "string", "example": "1" }, "day": { "type": "string", "example": "2020-04-15" }, "type_id": { "type": "integer", "example": 4 }, "type_description": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Employee.list.response": { "description": "Department data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "Yu" }, "name": { "type": "string", "example": "John Smith" }, "email": { "type": "string", "example": "Employee@email.com" }, "position": { "type": "string", "example": "HR" }, "grade": { "type": "string" }, "residence": { "type": "string", "nullable": true }, "residence_comment": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "skype": { "type": "string", "nullable": true }, "linked_in": { "type": "string", "nullable": true }, "birth_date": { "type": "string", "nullable": true }, "end_test": { "type": "string", "nullable": true }, "fired_date": { "type": "string", "nullable": true }, "start_date": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "telegram": { "type": "string", "nullable": true }, "additional_email": { "type": "string", "nullable": true }, "additional_phone": { "type": "string", "nullable": true }, "relocate": { "type": "boolean", "nullable": true }, "duties": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "additional_info": { "type": "string", "nullable": true }, "team": { "type": "array", "items": { "properties": { "id": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false } }, "type": "object" } }, "career": { "type": "array", "items": { "properties": { "team": { "type": "string", "nullable": true }, "start_date": { "type": "string", "nullable": false }, "end_date": { "type": "string", "nullable": true }, "test_period_start_date": { "type": "string", "nullable": true }, "test_period_end_date": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "grade": { "type": "string", "nullable": true }, "place": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "type": "object" } }, "contacts": { "type": "array", "items": { "properties": { "type_id": { "type": "integer", "nullable": true }, "type_name": { "type": "string", "nullable": false }, "value": { "type": "string", "nullable": true } }, "type": "object" } }, "languages": { "type": "array", "items": { "properties": { "name": { "type": "string", "nullable": true }, "level": { "type": "string", "nullable": true } }, "type": "object" } }, "educations": { "type": "array", "items": { "properties": { "place": { "type": "string", "nullable": true }, "period_start": { "type": "string", "nullable": true }, "period_end": { "type": "string", "nullable": true }, "specialization": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "type": "object" } }, "skills": { "type": "array", "items": { "properties": { "name": { "type": "string", "nullable": false } }, "type": "object" } }, "awards": { "type": "array", "items": { "properties": { "name": { "type": "string", "nullable": false } }, "type": "object" } }, "avatar": { "type": "string" }, "parent_team_ids": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Employee.create.vacation": { "description": "Employee create vacation data structure", "required": [ "id", "start_date", "end_date", "full_day", "busy_day_checking", "approved" ], "properties": { "id": { "description": "Id of employee", "type": "string", "example": "ND", "nullable": false }, "start_date": { "description": "Start date of vacation, format: d.m.Y", "type": "string", "example": "15.05.2023", "nullable": false }, "end_date": { "description": "End date of vacation, format: d.m.Y", "type": "string", "example": "15.05.2023", "nullable": false }, "full_day": { "description": "Vacation for the whole day or not", "type": "boolean", "example": "true", "nullable": false }, "busy_day_checking": { "description": "Enable\\disable check conflicts with vacations", "type": "boolean", "example": "true", "nullable": false }, "approved": { "description": "Approve status", "type": "boolean", "example": "true", "nullable": false }, "start_time": { "description": "Start time for vacation for part day, format: H:i", "type": "string", "example": "13:00", "nullable": true }, "end_time": { "description": "End time for vacation for part day, format: H:i", "type": "string", "example": "13:00", "nullable": true } }, "type": "object" }, "Employee.remove.vacation": { "description": "Employee create vacation data structure", "required": [ "id" ], "properties": { "id": { "description": "Vacation request id", "type": "string", "example": "xxx", "nullable": false } }, "type": "object" }, "OutOfOffice.home_work.additional": { "description": "OutOfOffice data", "properties": { "": { "type": "array", "items": { "properties": { "date": { "type": "string", "example": "2020-02-13" }, "is_full_day": { "type": "boolean", "example": "true" }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "used_minutes": { "type": "integer", "example": 480 } }, "type": "object" } } }, "type": "object" }, "OutOfOffice.list.response": { "description": "Department data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "Yu" }, "name": { "type": "string", "example": "John Smith" }, "email": { "type": "string", "example": "Employee@email.com" }, "end_test": { "type": "string", "nullable": true }, "fired_date": { "type": "string", "nullable": true }, "business_trip": { "type": "array", "items": { "type": "string" } }, "home_work": { "description": "With parameter 'additional_info=1'\n * OutOfOffice.home_work.additional scheme will be returned", "type": "array", "items": { "type": "string" } }, "sick_leave": { "type": "array", "items": { "type": "string" } }, "documented_sick_leave": { "type": "array", "items": { "type": "string" } }, "vacation": { "type": "array", "items": { "type": "string" } }, "unpaid_vacation": { "type": "array", "items": { "type": "string" } }, "overtime": { "type": "array", "items": { "type": "string" } }, "weekend_work": { "type": "array", "items": { "type": "string" } }, "night_shift": { "type": "array", "items": { "type": "string" } }, "day_transfer": { "properties": { "start": { "type": "array", "items": { "properties": { "date": { "type": "string", "example": "2020-02-13" }, "is_full_day": { "type": "boolean", "example": "true" }, "from": { "type": "string", "example": "18:00", "nullable": true }, "to": { "type": "string", "example": "18:30", "nullable": true }, "used_minutes": { "type": "integer", "example": 480 } }, "type": "object" } }, "end": { "type": "array", "items": { "properties": { "date": { "type": "string", "example": "2020-02-13" }, "is_full_day": { "type": "boolean", "example": "true" }, "from": { "type": "string", "example": "18:00", "nullable": true }, "to": { "type": "string", "example": "18:30", "nullable": true }, "used_minutes": { "type": "integer", "example": 480 } }, "type": "object" } } }, "type": "object" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=3" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=2", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "OverTime.response": { "description": "OverTimes", "type": "array", "items": { "properties": { "sum_shift_in_minutes": { "description": "Total shift in minutes", "type": "integer" }, "sum_shift_out_minutes": { "description": "Total shift out minutes", "type": "integer" }, "sum_overtime_minutes": { "description": "Total overtime in minutes", "type": "integer" }, "user_hash": { "description": "User hash", "type": "string" } }, "type": "object" } }, "Payroll.list.response": { "description": "Information on payroll reports", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "New" }, "start_period": { "type": "string", "example": "d-m-Y" }, "end_period": { "type": "string", "example": "d-m-Y" }, "created_at": { "type": "string", "example": "d-m-Y H:i:s" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Payroll.download.file.response": { "description": "Information on recruitment funnel stage", "properties": { "result": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Report" }, "content": { "type": "string", "example": "data:text/csv;base64..." }, "start_period": { "type": "string", "example": "d-m-Y" }, "end_period": { "type": "string", "example": "d-m-Y" }, "created_at": { "type": "string", "example": "d-m-Y" } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Responsible.recruiter.list.response": { "description": "Information on assigned recruiters", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Stepan Andriyovych" }, "vacancies_responsible_for": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } }, "candidates_responsible_for": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Responsible.recruiter.single.response": { "description": "Information on assigned recruiter", "properties": { "result": { "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Stepan Andriyovych" }, "vacancies_responsible_for": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } }, "candidates_responsible_for": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Andrej Afanas'evich" } }, "type": "object" } } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Stage.list.response": { "description": "Information on recruitment funnel stages", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "New" }, "parent_id": { "type": "integer", "example": 5, "nullable": true }, "parent_name": { "type": "string", "example": "Company Reject", "nullable": true } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Stage.single.response": { "description": "Information on recruitment funnel stage", "properties": { "result": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "New" }, "parent_id": { "type": "integer", "example": 5, "nullable": true }, "parent_name": { "type": "string", "example": "Company Reject", "nullable": true } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Vacancy.stages.list.response": { "description": "Job opening funnel stages data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "vacancy_id": { "type": "integer", "example": 10 }, "stage_id": { "type": "integer", "example": 1 }, "stage_name": { "type": "string", "example": "New" }, "candidate_id": { "type": "integer", "example": 5 } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Vacancy.list.response": { "description": "Job openings data", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Backend developer" }, "description": { "type": "string", "example": "Vacancy description" }, "demand": { "type": "string", "example": "Vacancy demand" }, "addition": { "type": "string", "example": "Addition info" }, "responsibility": { "type": "string", "example": "Responsibility" }, "working_conditions": { "type": "string", "example": "Working conditions" }, "number_of_positions": { "type": "integer", "example": 1 }, "residence": { "type": "string", "example": "Kharkiv" }, "hot_flag": { "type": "integer", "example": 1 }, "published": { "type": "integer", "example": 0 }, "status": { "description": "Open = 1, Pause = 2, Close = 3, In progress = 4, Canceled = 5", "type": "integer", "example": 1 }, "work_types": { "type": "array", "items": { "properties": { "type": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Full time" } }, "type": "object" } }, "salary": { "type": "array", "items": { "properties": { "from": { "type": "integer", "example": 800 }, "to": { "type": "integer", "example": 1200 }, "currency": { "type": "string", "example": "USD" } }, "type": "object" } }, "responsible": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "name": { "type": "string", "example": "Stepan Andriyovych" } }, "type": "object" } }, "created_at": { "description": "Date and time created (System's timezone)", "type": "string", "example": "2019-12-16 18:23:32" }, "close_date": { "description": "Date and time closed (System's timezone)", "type": "string", "example": "2019-12-16 18:23:32" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Vacancy.single.response": { "description": "Job opening data", "properties": { "result": { "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Backend developer" }, "description": { "type": "string", "example": "Job opening description" }, "demand": { "type": "string", "example": "Job opening demand" }, "addition": { "type": "string", "example": "Addition info" }, "responsibility": { "type": "string", "example": "Responsibility" }, "working_conditions": { "type": "string", "example": "Working conditions" }, "number_of_positions": { "type": "integer", "example": 1 }, "residence": { "type": "string", "example": "Kharkiv" }, "hot_flag": { "type": "integer", "example": 1 }, "published": { "type": "integer", "example": 0 }, "status": { "description": "Open = 1, Pause = 2, Close = 3, In progress = 4, Canceled = 5", "type": "integer", "example": 1 }, "work_types": { "type": "array", "items": { "properties": { "type": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Full time" } }, "type": "object" } }, "salary": { "type": "array", "items": { "properties": { "from": { "type": "integer", "example": 800 }, "to": { "type": "integer", "example": 1200 }, "currency": { "type": "string", "example": "USD" } }, "type": "object" } }, "responsible": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 2 }, "hashed_id": { "type": "string", "example": "GYy" }, "name": { "type": "string", "example": "Stepan Andriyovych" } }, "type": "object" } }, "created_at": { "description": "Date and time created (System's timezone)", "type": "string", "example": "2019-12-16 18:23:32" }, "close_date": { "description": "Date and time closed (System's timezone)", "type": "string", "example": "2019-12-16 18:23:32" } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" }, "Vacancy.stages.history.list.response": { "description": "Data on actions at job opening funnel stages", "properties": { "result": { "properties": { "current_page": { "type": "integer", "example": 1 }, "data": { "type": "array", "items": { "properties": { "vacancy_id": { "type": "integer", "example": 10 }, "stage_id": { "type": "integer", "example": 1 }, "candidate_id": { "type": "integer", "example": 1 }, "author_id": { "type": "integer", "example": 1 }, "date": { "type": "string", "example": "2022-03-11 10:32:12" } }, "type": "object" } }, "first_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "last_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1" }, "next_page_url": { "type": "string", "example": "https://hurma.work/api/path?page=1", "nullable": true }, "path": { "type": "string", "example": "https://hurma.work/api/path", "nullable": true }, "per_page": { "type": "integer", "example": 12 }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "example": 4 }, "total": { "type": "integer", "example": 4 } }, "type": "object" }, "error": { "type": "boolean", "example": false }, "code": { "type": "integer", "example": 200 }, "messages": { "type": "array", "items": { "description": "Message", "type": "string" } } }, "type": "object" } } } }