API reference
This API reference is only available in English. All API-responses are in mimetype application/json and UTF-8 encoding, except for Get profile photo which will have the mimetype as the uploaded photo, and Get CV (PDF) which will be a pdf-file. All API-requests shall be encoded in UTF-8.
Get CV (PDF)
Request
GET http://api.firmacv.no/getcv/?usid=1084&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx GET http://api.firmacv.no/getcv/?external_id=55468468&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx GET http://api.firmacv.no/getcv/?usid=1084&teid=55apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
Responses
PDF file or
{
"status": "error",
"message": "Error message"
}
Get company CVs
Request
GET http://api.firmacv.no/getcompanycvs/?apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
Response
{
"status": "success",
"companycvs": {
"1084": {
"usid": "1084",
"caid": "1",
"category_name": "Kategori",
"external_id": "987654321",
"email": "ronnie.oymoen@sourceit.no",
"user_name": "Ronnie \u00d8ymoen",
"created_datetime": "2015-08-06 13:53:23",
"company_admin": "0",
"description": "Beskrivelse",
"main_areas": "Hovedområder",
"current_position": "CEO",
"contact_phone": "+47 988 03 924",
"date_of_birth": "1980-01-01",
"gender": "M",
"template_name": "Sourceit - ny",
"partner": null,
"photo": "http:\/\/api.firmacv.no\/getphoto\/?usid=1&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
}
}
}
Get profile
Request
GET http://api.firmacv.no/getprofile/?apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx&usid=1084 GET http://api.firmacv.no/getprofile/?apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx&external_id=987654321
Response
{
"status": "success",
"profile": {
"usid": "1084",
"caid": "1",
"category_name": "Kategori",
"external_id": "987654321",
"email": "ronnie.oymoen@sourceit.no",
"user_name": "Ronnie \u00d8ymoen",
"created_datetime": "2015-08-06 13:53:23",
"license_expires": "2016-10-23 13:26:01",
"company_admin": "0",
"description": "Beskrivelse",
"main_areas": "Hovedområder",
"current_position": "CEO",
"contact_phone": "+47 988 03 924",
"date_of_birth": "1980-01-01",
"gender": "M",
"template_name": "Sourceit - ny",
"partner": null,
"photo": "http:\/\/api.firmacv.no\/getphoto\/?usid=1&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx",
"age":32
"3_internvurdering": "vurdering:1",
"6_nasjonalitet": "Norsk",
"4_oneliner": "oneliner",
"work": {
"1": {
"from_day": null,
"from_month": "03",
"from_year": "2015",
"to_day": null,
"to_month": null,
"to_year": null,
"company": "Sourceit AS",
"title": "CEO",
"description": "Beskrivelse"
},
"2": {
"from_day": null,
"from_month": "08",
"from_year": "2012",
"to_day": null,
"to_month": "03",
"to_year": "2015",
"company": "Sourceit AS",
"title": "Stillingstittel",
"description": "Beskrivelse"
}
},
"projects": {
"6": {
"from_day": null,
"from_month": "06",
"from_year": "2016",
"to_day": null,
"to_month": null,
"to_year": null,
"company": "Sourceit AS",
"title": "Stillingstittel",
"description": "Beskrivelse",
"customer": "Kunde",
"role": "Rolle",
"worth": null
},
"7": {
"from_day": null,
"from_month": "05",
"from_year": "2016",
"to_day": null,
"to_month": "06",
"to_year": "2016",
"company": "Sourceit AS",
"title": "Stillingstittel",
"description": "Beskrivelse",
"customer": "Kunde",
"role": "Rolle",
"worth": "Verdi/omfang"
}
},
"education": {
"20": {
"from_day": null,
"from_month": "08",
"from_year": "2004",
"to_day": null,
"to_month": "06",
"to_year": "2007",
"school_institution": "Skole/opplæringssted",
"title": "Kurstittel",
"acheived_course_title": "Oppnådd tittel",
"description": null
}
},
"course_certifications": {
"21": {
"from_day": null,
"from_month": "09",
"from_year": "2008",
"to_day": null,
"to_month": "09",
"to_year": "2008",
"school_institution": "Skole/opplæringssted",
"title": "Kurstittel",
"acheived_course_title": "Oppnådd tittel",
"description": null,
"expires_date": null
}
}
}
}
Get profile photo
Request
GET http://api.firmacv.no/getphoto/?usid=1084&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx GET http://api.firmacv.no/getphoto/?external_id=987654321&apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
Response
Update a profile
Updating an existing profile. Update by internal id (usid) or external_id.
If language is set to other than company default language, only fields in bold will be updated.
Available fields:
- user_name
- current_position
- caid (category id)
- born
- gender
- description
- main_areas
- teid (template id)
- external_id
- any custom fields (see getprofile)
- work
- from_day
- from_month
- from_year
- to_day
- to_month
- to_year
- company
- title
- description
- projects
- from_day
- from_month
- from_year
- to_day
- to_month
- to_year
- company
- customer
- title
- role
- worth
- description
- education
- from_day
- from_month
- from_year
- to_day
- to_month
- to_year
- company (updating field: school_institution)
- title (course title)
- acheived_course_title
- description
- course_certifications
- from_day
- from_month
- from_year
- to_day
- to_month
- to_year
- company (updating field: school_institution)
- title (course title)
- acheived_course_title
- description
Request
POST http://api.firmacv.no/updateprofile/?apikey=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx
POST data
{
"updateby": "external_id",
"updateprofile": {
"987654321": {
"user_name": "Ronny \u00d8ymoen",
"email": "ronny@sourceit.no",
"current_position": "SVP",
"language": "NOB",
"work": {
"updateby": "external_id",
"85546": {
"from_day": "01",
"from_month": "12",
"from_year": "2015",
"company": "Fake Company",
"title": "SVP"
},
"55468": {
"from_day": "05",
"from_month": "01",
"from_year": "2014",
"company": "Company",
"title": "Engineer"
}
}
},
"548587578": {
"language": "ENG",
"born": "1984-05-25",
"user_name": "Ola Nordmann",
"email": "ola@nordmann.no",
"current_position": "Jeger",
"company_admin": "1",
"description": "Ola Nordmann is a well known Norwegian character.",
"main_areas": "Troll hunting, wood chopping",
"contact_phone": "9988776655"
}
}
}
Responses
{
"status": "success"
}
{
"status": "warning",
"message": "Experience work with exid 85546 for user with external_id 987654321 was not found. Experience work with exid 55468 for user with external_id 987654321 was not found. ",
"ids_with_error": [987654321]
}
{
"status": "error",
"message": "Errors in all profiles. Experience work with exid 85546 for user with external_id 987654321 was not found. Experience work with exid 55468 for user with external_id 987654321 was not found. Profile with external_id 54858757833 was not found. ",
"ids_with_error": [987654321, 54858757833]
}