- Overview
-
Rest API Schemas
- Application schema
- Application message request
- Application message response
- Application reject request
- Application reject response
- Candidate schema
- Candidate get response
- Candidate search request
- Candidate search response
- Dossier schema
- Dossier get response
- Dossier search request
- Dossier search response
- Profile schema
- Profile get response
- Publication schema
- Publication publish request
- Publication publish response
- Publication get response
- Publication abort response
-
Integration API Schemas
- Application schema
- Application apply request
- Application apply response
- Application message request
- Application message response
- Application retract request
- Application retract response
- Application update request
- Application update response
- Publication schema
- Publication fetch response
- Publication fetched response
- Resource Schemas
- Error Schemas
Application schema
Application schema definition including the europass PDF/XML 3.2.0
JSON schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://api.xeebo.com/schema/xeebo-integration-application-schema-v1.0.0.json",
"title": "Application schema",
"description": "Application schema definition including the europass PDF/XML 3.2.0",
"type": "object",
"definitions": {
"dateType": {
"title": "ISO Date",
"description": "ISO date string (e.g. 2018-12-31)",
"type": "string"
},
"localeType": {
"title": "Candidate language",
"description": "The candidate text language locale as lower case iso-639-alpha-2 language locale code",
"type": [
"string",
"null"
]
},
"uriType": {
"title": "URL",
"description": "An url pointing to a web page",
"type": "string",
"format": "uri"
},
"emailType": {
"title": "Email address",
"description": "A valid email address",
"type": "string",
"format": "email"
},
"langLevelType": {
"type": "string",
"enum": [
"A1",
"A2",
"B1",
"B2",
"C1",
"C2"
]
},
"userType": {
"title": "Person and information",
"description": "Describing a person and his/her personal data",
"type": "object",
"properties": {
"nickname": {
"title": "Nickname",
"description": "The nickname used at xeebo",
"type": "string"
},
"salutation": {
"title": "The contact salutation",
"type": "string"
},
"academic": {
"title": "Academic title",
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
}
},
"additionalProperties": false
},
"contactType": {
"title": "Person and contact options",
"description": "Describing a person and his/her contact options",
"type": "object",
"properties": {
"url": {
"title": "Profile page uri",
"description": "URL pointing to the xeebo profile page",
"$ref": "#/definitions/uriType"
},
"email": {
"title": "Contact email address",
"description": "Applicant contact email address",
"$ref": "#/definitions/emailType"
},
"phone": {
"title": "Contact phone number",
"description": "Applicant contact phone number",
"type": "string"
},
"mobile": {
"title": "Contact mobile phone number",
"description": "Applicant contact mobile number",
"type": "string"
}
},
"additionalProperties": false
},
"addressType": {
"title": "Address",
"description": "Describing an address",
"type": "object",
"properties": {
"street": {
"title": "Street",
"type": "string"
},
"co": {
"title": "Care of",
"description": "The care of address line or second address line",
"type": "string"
},
"poBox": {
"title": "Post office box",
"description": "The post office box address",
"type": "string"
},
"zip": {
"title": "Postal code",
"description": "The postal code reference for a given city",
"type": "string"
},
"city": {
"title": "The location city",
"type": "string"
},
"state": {
"title": "The location state",
"type": "string"
},
"country": {
"title": "Country code",
"description": "The aplha-2 country code",
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"companyAddressType": {
"title": "Company address",
"description": "Describing a company address",
"type": "object",
"allOf": [
{
"properties": {
"department": {
"title": "Company department",
"description": "Defines a company department if available",
"type": "string"
}
}
},
{
"$ref": "#/definitions/addressType"
}
]
},
"organisationType": {
"title": "Company address",
"description": "Describing a company address",
"type": "object",
"allOf": [
{
"properties": {
"name": {
"title": "Organisation name",
"description": "The organisation name",
"type": "string"
}
}
},
{
"$ref": "#/definitions/addressType"
}
]
},
"companyType": {
"properties": {
"name": {
"title": "Company name",
"type": "string"
},
"user": {
"title": "Company user information",
"$ref": "#/definitions/userType"
},
"contact": {
"title": "Company user contact information",
"$ref": "#/definitions/contactType"
},
"address": {
"title": "Company address information",
"$ref": "#/definitions/companyAddressType"
}
},
"additionalProperties": false
},
"applicantType": {
"properties": {
"user": {
"title": "Applicant personal information",
"$ref": "#/definitions/userType"
},
"contact": {
"title": "Applicant contact information",
"$ref": "#/definitions/contactType"
},
"address": {
"title": "Applicant address information",
"$ref": "#/definitions/addressType"
},
"gender": {
"title": "Applicant gender",
"description": "The applicants gender (M) male, (F) female",
"type": "string",
"enum": [
"M",
"F"
]
},
"birthDate": {
"title": "Applicant birthdate",
"description": "The applicants birthdate",
"$ref": "#/definitions/dateType"
},
"nationalities": {
"title": "Applicant nationalities",
"description": "The applicants nationalities",
"type": "array",
"items": {
"title": "Nationality country code",
"description": "The aplha-2 country code",
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"additionalProperties": false
},
"educationType": {
"title": "Education",
"description": "Education data",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/organisationType"
},
{
"properties": {
"start": {
"title": "Start date",
"description": "The education start date",
"$ref": "#/definitions/dateType"
},
"end": {
"title": "End date",
"description": "The education end date",
"$ref": "#/definitions/dateType"
},
"title": {
"title": "Qualification title",
"description": "Title of qualification awarded",
"type": "string"
},
"skills": {
"title": "Occupational skills",
"description": "Principal subjects occupational skills covered",
"type": "string"
},
"field": {
"$ref": "#/definitions/educationFieldType"
},
"level": {
"$ref": "#/definitions/educationLevelType"
},
"education": {
"title": "Education classification",
"description": "Level in EQF or national classification",
"type": "string"
},
"organisation": {
"title": "Organisation type",
"description": "The organisation type",
"type": "string"
},
"website": {
"title": "Organisation website",
"type": "string"
}
}
}
]
},
"educationsType": {
"title": "Educations",
"description": "List of applicants educations",
"type": "array",
"items": {
"$ref": "#/definitions/educationType"
},
"minItems": 0
},
"experienceType": {
"title": "Experience",
"description": "Experience data",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/organisationType"
},
{
"properties": {
"start": {
"title": "Start date",
"description": "The education start date",
"$ref": "#/definitions/dateType"
},
"end": {
"title": "End date",
"description": "The education end date",
"$ref": "#/definitions/dateType"
},
"occupation": {
"title": "Occupation",
"description": "Occupation",
"type": "string"
},
"activities": {
"title": "Activities",
"description": "Work activities",
"type": "string"
},
"sector": {
"title": "Business sector",
"description": "Organisation business sector",
"type": "string"
},
"website": {
"title": "Organisation website",
"type": "string"
}
}
}
]
},
"experiencesType": {
"title": "Experiences",
"description": "List of applicants experiences",
"type": "array",
"items": {
"$ref": "#/definitions/experienceType"
},
"minItems": 0
},
"languageType": {
"title": "Language",
"description": "Language data",
"type": "object",
"properties": {
"lang": {
"title": "Language code",
"description": "Two digit iso alpha-2 language code as lowercase",
"type": "string",
"pattern": "^[a-z]{2}$"
},
"listening": {
"title": "Listening",
"$ref": "#/definitions/langLevelType"
},
"reading": {
"title": "Reading",
"$ref": "#/definitions/langLevelType"
},
"interaction": {
"title": "Spoken Interaction",
"$ref": "#/definitions/langLevelType"
},
"production": {
"title": "Spoken Production",
"$ref": "#/definitions/langLevelType"
},
"writing": {
"title": "Writing",
"$ref": "#/definitions/langLevelType"
}
},
"additionalProperties": false
},
"languagesType": {
"title": "Languages",
"description": "List of applicants languages",
"type": "array",
"items": {
"$ref": "#/definitions/languageType"
},
"minItems": 0
},
"skillType": {
"title": "Skill",
"description": "Skill description text",
"type": "string"
},
"achievementDateType": {
"title": "Simple achievement",
"description": "Simple achievement with a single date",
"properties": {
"date": {
"title": "Achievement date",
"description": "The achievement date",
"$ref": "#/definitions/dateType"
},
"title": {
"title": "Achievement Title",
"description": "The achievement description",
"type": "string"
},
"description": {
"title": "Award description",
"description": "The achievement description",
"type": "string"
},
"web": {
"title": "Web page uri",
"description": "URL pointing to more achievement information",
"$ref": "#/definitions/uriType"
}
}
},
"achievementDateRangeType": {
"title": "Achievement with a time range",
"description": "Achievement with a date range",
"properties": {
"start": {
"title": "Achievement start date",
"description": "The achievement start date",
"$ref": "#/definitions/dateType"
},
"end": {
"title": "Achievement end date",
"description": "The achievement end date",
"$ref": "#/definitions/dateType"
},
"title": {
"title": "Achievement Title",
"description": "Achievement description",
"type": "string"
},
"description": {
"title": "Award description",
"description": "Achievement description",
"type": "string"
},
"web": {
"title": "Web page uri",
"description": "URL pointing to more achievement information",
"$ref": "#/definitions/uriType"
}
}
},
"achievementsType": {
"title": "Achievements",
"description": "Applicants achievements",
"properties": {
"awards": {
"title": "Award achievement",
"$ref": "#/definitions/achievementDateType"
},
"citations": {
"title": "Citation achievement",
"$ref": "#/definitions/achievementDateType"
},
"conferences": {
"title": "Conference achievement",
"$ref": "#/definitions/achievementDateRangeType"
},
"memberships": {
"title": "Memberships achievement",
"$ref": "#/definitions/achievementDateRangeType"
},
"projects": {
"title": "Projects achievement",
"$ref": "#/definitions/achievementDateRangeType"
},
"publications": {
"title": "Publications achievement",
"$ref": "#/definitions/achievementDateType"
},
"references": {
"title": "References achievement",
"$ref": "#/definitions/achievementDateType"
},
"seminars": {
"title": "Seminars achievement",
"$ref": "#/definitions/achievementDateRangeType"
},
"workshops": {
"title": "Workshops achievement",
"$ref": "#/definitions/achievementDateRangeType"
}
},
"additionalProperties": false
},
"skillsType": {
"title": "Skills",
"description": "Applicants skills",
"properties": {
"communication": {
"title": "Computer skills",
"$ref": "#/definitions/skillType"
},
"organisational": {
"title": "Organisational skills",
"$ref": "#/definitions/skillType"
},
"job": {
"title": "Job related skills",
"$ref": "#/definitions/skillType"
},
"computer": {
"title": "Computer skills",
"$ref": "#/definitions/skillType"
},
"other": {
"title": "Other skills",
"$ref": "#/definitions/skillType"
}
},
"additionalProperties": false
},
"drivingLicencesType": {
"title": "Driving License",
"description": "List of driving license types",
"type": "array",
"items": {
"type": "string",
"enum": [
"A",
"B",
"C",
"D",
"A1",
"B1",
"C1",
"D1",
"BE",
"CE",
"DE",
"C1E",
"D1E"
]
},
"minItems": 0
},
"educationFieldType": {
"title": "Eduction Field",
"description": "The international standard classification of Education (Level 2) required for this job. http://www.unesco.org/education/information/nfsunesco/doc/isced_1997.htm",
"type": "string",
"enum": [
"01",
"09",
"14",
"21",
"22",
"31",
"32",
"34",
"38",
"42",
"44",
"46",
"48",
"52",
"54",
"58",
"62",
"64",
"72",
"76",
"81",
"84",
"85",
"86"
]
},
"educationLevelType": {
"title": "Eduction Level",
"description": "The educational background required for this job. European Qualifications Framework (EQF) Level, http://ec.europa.eu/education/lifelong-learning-policy/eqf_en.htm",
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"resumeEducationType": {
"title": "Short resume education",
"description": "Short resume education description",
"type": "object",
"properties": {
"field": {
"$ref": "#/definitions/educationFieldType"
},
"level": {
"$ref": "#/definitions/educationLevelType"
}
}
},
"resumeType": {
"title": "Short resume",
"description": "Additional resume information",
"type": "object",
"properties": {
"experience": {
"title": "Work experience years",
"description": "The minimal work experience years required for this job",
"type": "integer"
},
"position": {
"title": "Postion type",
"description": "The job position type. 10:Employee, 20:Position with responsibilities, 30:Executive position",
"type": "string",
"enum": [
"10",
"20",
"30"
]
},
"status": {
"title": "Career status",
"description": "The minmal career state reuqired for this job. 10:Learner, 20:Student 30:Job Beginner 40:Professional experienced 50:Supervisor 60:Manager 70:Director",
"type": "string",
"enum": [
"10",
"20",
"30",
"40",
"50",
"60",
"70"
]
},
"education": {
"$ref": "#/definitions/resumeEducationType"
},
"skills": {
"title": "Skills",
"description": "A list of skills required for this job",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"photoType": {
"title": "Photo",
"description": "Photo data",
"type": "object",
"properties": {
"name": {
"title": "Photo name",
"type": "string"
},
"data": {
"title": "Photo data",
"description": "Photo data base64 encoded",
"type": "string",
"contentEncoding": "base64"
},
"mimeType": {
"title": "Photo mime type",
"type": "string",
"enum": [
"image/jpeg",
"image/pjpeg",
"image/png",
"image/x-png"
]
},
"size": {
"title": "Photo data size",
"type": "string"
},
"md5": {
"title": "MD5 identifier",
"type": "string"
}
},
"additionalProperties": false
},
"docType": {
"title": "Document",
"description": "Document data",
"type": "object",
"properties": {
"name": {
"title": "Document name",
"type": "string"
},
"description": {
"title": "Document description",
"type": "string"
},
"typ": {
"title": "Document type",
"description": "The document type",
"type": "string",
"enum": [
"letter",
"resume",
"certificate",
"diploma",
"qualification",
"check",
"other"
]
},
"data": {
"title": "Document data",
"description": "Document data base64 encoded",
"type": "string",
"contentEncoding": "base64"
},
"mimeType": {
"title": "Document mime type",
"type": "string",
"enum": [
"application/pdf",
"image/jpeg",
"image/pjpeg",
"image/png",
"image/x-png",
"text/plain"
]
},
"size": {
"title": "Document data size",
"type": "string"
},
"md5": {
"title": "MD5 identifier",
"type": "string"
}
},
"additionalProperties": false
},
"documentsType": {
"title": "Additional application documents",
"description": "List of additional application documents",
"type": "array",
"items": {
"$ref": "#/definitions/docType"
},
"minItems": 0
},
"questionBaseType": {
"title": "Question",
"description": "The application question definition",
"type": "object",
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"checkbox",
"radio",
"select",
"multiselect",
"textarea",
"textline"
]
},
"id": {
"title": "Question id",
"description": "The application question id",
"type": "string"
},
"title": {
"title": "Question text",
"description": "The application question text",
"type": "string"
}
}
},
"checkBoxQuestionType": {
"title": "Checkbox Question",
"description": "The checkbox question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"checkbox"
]
},
"value": {
"title": "Question answer",
"description": "The application question answer values",
"type": "array",
"items": {
"title": "List of checkbox vallues",
"description": "The aplha-2 country code",
"type": [
"integer",
"string",
"null"
]
}
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"radioQuestionType": {
"title": "Radio Question",
"description": "The radio question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"radio"
]
},
"value": {
"title": "Question answer",
"description": "The application question answer values",
"type": [
"integer",
"string",
"null"
]
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"selectQuestionType": {
"title": "Select Question",
"description": "The select question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"select"
]
},
"value": {
"title": "Question answer",
"description": "The application question answer values",
"type": [
"integer",
"string",
"null"
]
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"multiSelectQuestionType": {
"title": "Multi Select Question",
"description": "The multi select question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"multiselect"
]
},
"value": {
"title": "Question answer",
"description": "The application question answer values",
"type": "array",
"items": {
"title": "List of checkbox vallues",
"description": "The aplha-2 country code",
"type": [
"integer",
"string",
"null"
]
}
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"textAreaQuestionType": {
"title": "Multiline Text Question",
"description": "The multiline text (textarea) question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"textarea"
]
},
"value": {
"title": "Question answer value",
"description": "The question answer text value",
"type": [
"string",
"null"
]
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"textLineQuestionType": {
"title": "Text Line Question",
"description": "The single text line question type",
"type": "object",
"allOf": [
{
"properties": {
"typ": {
"title": "Question type",
"description": "The question type",
"type": "string",
"enum": [
"textline"
]
},
"value": {
"title": "Question answer value",
"description": "The question answer text value",
"type": [
"string",
"null"
]
}
}
},
{
"$ref": "#/definitions/questionBaseType"
}
]
},
"questionGroupType": {
"title": "Question Group",
"description": "The application question group group definition",
"type": "object",
"properties": {
"id": {
"title": "Question group id",
"description": "The application question group group id",
"type": "string"
},
"typ": {
"title": "Question group type",
"description": "The application question group type",
"type": "string",
"enum": [
"group"
]
},
"title": {
"title": "Question group text",
"description": "The application question group text",
"type": "string"
},
"description": {
"title": "Question group description",
"description": "The application question group description",
"type": "string"
},
"answers": {
"title": "Question group answers",
"description": "The application question group answers",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/checkBoxQuestionType"
},
{
"$ref": "#/definitions/radioQuestionType"
},
{
"$ref": "#/definitions/selectQuestionType"
},
{
"$ref": "#/definitions/multiSelectQuestionType"
},
{
"$ref": "#/definitions/textAreaQuestionType"
},
{
"$ref": "#/definitions/textLineQuestionType"
}
]
},
"minItems": 0
}
},
"additionalProperties": false
},
"questionnaireType": {
"title": "Application questionnaire",
"description": "Questionnaire",
"type": "object",
"properties": {
"id": {
"title": "Questionnaire id",
"description": "The application Questionnaire id",
"type": "string"
},
"typ": {
"title": "Questionnaire type",
"description": "The questionnaire type",
"type": "string",
"enum": [
"questionnaire"
]
},
"title": {
"title": "Questionnaire text",
"description": "The application questionnaire text",
"type": "string"
},
"description": {
"title": "Questionnaire description",
"description": "The application questionnaire description",
"type": "string"
},
"groups": {
"title": "Questionnaire groups",
"description": "The application questionnaire groups",
"type": "array",
"items": {
"$ref": "#/definitions/questionGroupType"
}
}
},
"additionalProperties": false
},
"questionsType": {
"title": "Application questions",
"description": "List of required and optional application questions, groups and questionnaires",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/checkBoxQuestionType"
},
{
"$ref": "#/definitions/radioQuestionType"
},
{
"$ref": "#/definitions/selectQuestionType"
},
{
"$ref": "#/definitions/multiSelectQuestionType"
},
{
"$ref": "#/definitions/textAreaQuestionType"
},
{
"$ref": "#/definitions/textLineQuestionType"
},
{
"$ref": "#/definitions/questionGroupType"
},
{
"$ref": "#/definitions/questionnaireType"
}
]
},
"minItems": 0
},
"applicationType": {
"title": "Application",
"description": "Contains additional application data",
"type": "object",
"properties": {
"resume": {
"$ref": "#/definitions/resumeType"
},
"drivingLicences": {
"$ref": "#/definitions/drivingLicencesType"
},
"educations": {
"$ref": "#/definitions/educationsType"
},
"experiences": {
"$ref": "#/definitions/experiencesType"
},
"languages": {
"title": "Foreign languages",
"$ref": "#/definitions/languagesType"
},
"achievements": {
"$ref": "#/definitions/achievementsType"
},
"skills": {
"$ref": "#/definitions/skillsType"
},
"photo": {
"$ref": "#/definitions/photoType"
},
"letter": {
"title": "Application letter",
"description": "Application letter as pdf or text document",
"$ref": "#/definitions/docType"
},
"cv": {
"title": "Europass CV PDF/XML document",
"description": "Europass CV PDF/XML document",
"$ref": "#/definitions/docType"
},
"documents": {
"$ref": "#/definitions/documentsType"
},
"questions": {
"$ref": "#/definitions/questionsType"
},
"email": {
"title": "Application contact email address",
"description": "Application contact email address",
"$ref": "#/definitions/emailType"
},
"url": {
"title": "Application page uri",
"description": "URL pointing to the xeebo application page",
"$ref": "#/definitions/uriType"
}
},
"additionalProperties": false
}
}
}
JSON schema data description
| Path/Attribute | Title | Description | Required |
|---|