Recruitment Services API
Documentation for Integrators
Common request
headers/parameters
Common HTTP statuses in
responses
Workflow – Simple way of
using the API
Recruitment API
The recruitment API must be accessed via Recruitment Gateway that has address
https://recruitement.svea.com/
All response are encoded as json.
Each application shall be registered, updated with data. Also each application can/should contain attachments, link or uploaded documents. CV, Personal Letter and the code used to interact with this service.
When data is updated, the application can be send/marked as applied and a handler will be notifed.
Common request headers/parameters
Every call on Gateway has several headers and parameters that are either required or optional:
· X-Recruitment-Api-Key
o This header is required
o It represents Key of the caller
o Api Keys shall be created through [POST] /api/v1/key/generate
Common HTTP statuses in responses
We return following HTTP statuses in our responses that you can use when integrating:
· 200 OK
o All went OK
o We use this status code when returning some data, but also when we do not return any content
o If you request a list of records and we do not find any – we will return 200 OK with empty array
· 400 Invalid Request
o There was some validation error in Integrator’s request
o We provide error message in plain tex
· 404 Not Found
o When you request for a single record and we can’t retrieve it (e.g. no record in DB), we will return this status
· 500 Internal Server Error
o There was some error in our implementation or some unexpected behavior
o Error is returned as plain text; details are provided on our internal system
o Please report this to us
· 503 Service Unavailable
o Error is returned as plain text; details are provided on our internal system
o If you encounter this status multiple times or for longer period of time, please contact us
Workflow – Simple way of using the API
Application operations
Register
[POST] /api/v1/application/register
Create an application key connected to the provided input application data.
Input data
|
Name |
Type |
Description |
|
Email |
string |
|
|
Name |
string |
|
|
Password |
string |
|
|
Phone |
string |
|
Output data
|
Name |
Type |
Decription |
|
applicationKey |
string |
|
|
status |
bool |
|
|
message |
string |
|
Update
[PUT] /api/v1/application/update
Update application with provided metadata for given application.
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
Email |
string |
|
|
Name |
String |
|
|
Password |
String |
|
|
Phone |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
Update metadata
[PUT] /api/v1/application/updatemetadata
Update application with provided metadata for given application.
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
|
seniority |
Seniority |
|
|
role |
Role |
|
|
area |
Area |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
Apply
[POST] /api/v1/application/apply
Send application and include metadata and documents
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
Delete
[DELETE] /api/v1/application/delete
Delete application and metadata and documents connected to application.
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
Find
[GET] /api/v1/application/find?email={email}&password={password}
Find applications for given email and passwords.
Input data
|
Name |
Type |
Description |
|
email |
string |
|
|
password |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
|
ApplicationKeys |
List of strings |
|
View
[GET] /api/v1/application/view?applicationKey={applicationKey}&password={password}
View data for application and connected metadata and documents.
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
* |
|
Application ·
Email ·
applicantsName ·
pwd ·
phone ·
applicationKey ·
applicationStatus ·
documentList o
doctype o
linkType o
link o
time_stamp ·
created ·
updated ·
seniority ·
devRole ·
devArea |
String String String String String StatusType DocType LinkType String String String String Seniority Role Area |
|
Attachments - Add Link
[POST] /api/v1/attachment/addlink
Add link to external document to application.
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
|
docType |
DocType |
|
|
link |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
Upload document
[POST] /api/v1/attachment/upload/{extension}/{applicationKey}/{password}/{docType}
Upload a document and attach it to given application
Input data
|
Name |
Type |
Description |
|
applicationKey |
string |
|
|
password |
string |
|
|
docType |
DocType |
|
|
extension |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
|
docKey |
string |
|
Generate API Key
[POST] /api/v1/key/generate
Generate user api key, needs to be provided in each call to service.
Input data
|
Name |
Type |
Description |
|
userEmail |
string |
|
|
userPassword |
string |
|
Output data
|
Name |
Type |
Decription |
|
status |
bool |
|
|
message |
string |
|
|
userKey |
string |
|
Enumerations
Seniority
|
Type acronym |
Description |
|
Beginner |
|
|
Junior |
|
|
Intermediate |
|
|
Senior |
|
Role
|
Type acronym |
Description |
|
Tester |
|
|
Developer |
|
|
Architect |
|
Area
|
Type acronym |
Description |
|
Backend |
|
|
Frontend |
|
|
FullStack |
|
StatusTyoe
|
Type acronym |
Description |
|
Created |
|
|
InProgress |
|
|
Applied |
|
|
Deleted |
|
DocType
|
Type acronym |
Description |
|
Cv |
|
|
Letter |
|
|
Code |
|
|
Other |
|
Linktype
|
Type acronym |
Description |
|
HttpLink |
|
|
FileLink |
|