- 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
Candidate schema
Candidate schema definitions
JSON schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json",
"title": "Candidate schema",
"description": "Candidate schema definitions",
"type": "object",
"definitions": {
"versionType": {
"title": "Schema Version",
"description": "If the schema version string is not given the latest schema will get used which is currently 1.0.0",
"type": "string",
"pattern": "^[0-9]\\.[0-9]\\.[0-9]$"
},
"textType": {
"title": "Text",
"description": "Text including linebreaks",
"type": [
"string",
"null"
]
},
"textLineType": {
"title": "TextLine",
"description": "Text without linebreaks",
"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"
},
"dateType": {
"title": "ISO Datetime",
"description": "ISO datetime string",
"type": "string"
},
"keyType": {
"title": "Candidate reference id",
"description": "Key used for lookup detail data with candidate/<key>/get api",
"type": "string"
},
"categoryType": {
"title": "Category Type",
"description": "Job category types, see categories.json",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
},
"categoriesType": {
"title": "Job categories",
"description": "A list of job categories",
"$ref": "#/definitions/categoryType"
},
"ictLevelType": {
"title": "ICT Level Type",
"description": "ICT level type",
"enum": [
"A",
"B",
"C",
null
],
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectorType": {
"title": "Business Sector Type",
"description": "Business sector types, see sector.json",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
},
"sectorsType": {
"title": "Business sectors",
"description": "A list of business sectors",
"$ref": "#/definitions/sectorType"
},
"countryType": {
"title": "Candidate country code",
"description": "An iso-3166-alpha-2 country code",
"type": [
"string",
"null"
]
},
"careerStateType": {
"title": "Career status",
"description": "The minmal career status required 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"
]
},
"careerStatusType": {
"title": "Career status",
"description": "The minmal career status required for this job. 10:Learner, 20:Student 30:Job Beginner 40:Professional experienced 50:Supervisor 60:Manager 70:Director",
"type": "array",
"items": {
"enum": [
"10",
"20",
"30",
"40",
"50",
"60",
"70"
],
"type": "string"
},
"minItems": 0
},
"drivingLicencesType": {
"title": "Driving Licenses",
"description": "List of driving license types",
"type": "array",
"items": {
"enum": [
"A",
"B",
"C",
"D",
"A1",
"B1",
"C1",
"D1",
"BE",
"CE",
"DE",
"C1E",
"D1E"
],
"type": "string"
},
"minItems": 0
},
"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"
}
]
},
"occupationCodeType": {
"description": "The occupational field is described by a code and a label. E.g. code: 41150, label: Secretary.",
"type": "string",
"pattern": "^[0-9]{5}$"
},
"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"
}
]
},
"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"
]
},
"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 candidate 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"
},
"type": {
"title": "Occupation type",
"description": "Occupation type",
"$ref": "#/definitions/occupationCodeType"
},
"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 candidate experiences",
"type": "array",
"items": {
"$ref": "#/definitions/experienceType"
},
"minItems": 0
},
"shortEducationType": {
"title": "Short education",
"description": "Short education data",
"type": "object",
"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"
},
"field": {
"$ref": "#/definitions/educationFieldType"
},
"level": {
"$ref": "#/definitions/educationLevelType"
},
"education": {
"title": "Education classification",
"description": "Level in EQF or national classification",
"type": "string"
}
},
"additionalProperties": false
},
"shortEducationsType": {
"title": "Short educations",
"description": "List of sort candidate educations",
"type": "array",
"items": {
"$ref": "#/definitions/shortEducationType"
},
"minItems": 0
},
"shortExperienceType": {
"title": "Short candidate experience",
"description": "Short candidate experience data",
"type": "object",
"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"
},
"type": {
"title": "Occupation type code",
"description": "Occupation type code",
"$ref": "#/definitions/occupationCodeType"
},
"sector": {
"title": "Business sector",
"description": "Organisation business sector",
"type": "string"
}
},
"additionalProperties": false
},
"shortExperiencesType": {
"title": "Short Experiences",
"description": "List of short candidate experiences",
"type": "array",
"items": {
"$ref": "#/definitions/shortExperienceType"
},
"minItems": 0
},
"langLevelType": {
"type": "string",
"enum": [
"A1",
"A2",
"B1",
"B2",
"C1",
"C2"
]
},
"motherLanguagesType": {
"title": "Mother language code",
"description": "Language code,see europass language codes",
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z-]{0,7}$"
}
},
"languageType": {
"title": "Language",
"description": "Language data",
"type": "object",
"properties": {
"lang": {
"title": "Language code",
"description": "Language code,see europass language codes",
"$ref": "#/definitions/langType"
},
"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
},
"langQueryType": {
"title": "Languages",
"description": "List of language locales",
"type": "array",
"items": {
"$ref": "#/definitions/langType"
},
"minItems": 0
},
"phoneType": {
"title": "Phone",
"description": "Phone entry",
"type": "object",
"properties": {
"type": {
"title": "Phone type",
"description": "Phone type, one of home, work and mobile",
"type": "string",
"enum": [
"home",
"work",
"mobile"
]
},
"contact": {
"title": "Phone number",
"description": "Phone number",
"type": "string"
}
},
"additionalProperties": false
},
"phonesType": {
"title": "Phones",
"description": "Lists the telephone type and number owned by the individual.",
"items": {
"$ref": "#/definitions/phoneType"
},
"minItems": 0
},
"websiteType": {
"title": "Website entry",
"description": "Website entry",
"type": "object",
"properties": {
"type": {
"title": "Website type",
"description": "Website type",
"type": "string",
"enum": [
"personal",
"business",
"work",
"portfolio"
]
},
"contact": {
"title": "Website addressr",
"description": "Website addressr",
"type": "string"
}
},
"additionalProperties": false
},
"websitesType": {
"description": "Lists the websites that are owned, built by or refer to the individual.",
"type": "array",
"items": {
"$ref": "#/definitions/websiteType"
},
"minItems": 0
},
"imType": {
"title": "Instant messaging account",
"properties": {
"type": {
"title": "nstant messaging account type",
"description": "nstant messaging account type",
"type": "string",
"enum": [
"gtalk",
"skype",
"icq",
"aim",
"msn",
"yahoo"
]
},
"contact": {
"title": "Instant messaging account id",
"description": "Instant messaging account id",
"type": "string"
}
},
"additionalProperties": false
},
"imsType": {
"description": "Lists the instant messaging accounts numbers owned by the individual.",
"type": "array",
"items": {
"$ref": "#/definitions/imType"
},
"minItems": 0
},
"epDateItemType": {
"title": "Europass item with date",
"properties": {
"title": {
"title": "Europass item title",
"description": "Europass item title",
"type": "string"
},
"description": {
"title": "Europass item description",
"description": "Europass item description",
"type": "string"
},
"web": {
"title": "Europass item website address",
"website address": "Europass item description",
"type": "string"
},
"date": {
"title": "Europass item date",
"description": "Europass item date",
"$ref": "#/definitions/dateType"
}
},
"additionalProperties": false
},
"epShortDateItemType": {
"title": "Europass item with date",
"properties": {
"title": {
"title": "Europass item title",
"description": "Europass item title",
"type": "string"
},
"date": {
"title": "Europass item date",
"description": "Europass item date",
"$ref": "#/definitions/dateType"
}
},
"additionalProperties": false
},
"epDateRangeItemType": {
"title": "Instant messaging account",
"properties": {
"title": {
"title": "Europass item title",
"description": "Europass item title",
"type": "string"
},
"description": {
"title": "Europass item description",
"description": "Europass item description",
"type": "string"
},
"web": {
"title": "Europass item website address",
"website address": "Europass item description",
"type": "string"
},
"start": {
"title": "Europass item start date",
"description": "Europass item start date",
"$ref": "#/definitions/dateType"
},
"end": {
"title": "Europass item end date",
"description": "Europass item end date",
"$ref": "#/definitions/dateType"
}
},
"additionalProperties": false
},
"epShortDateRangeItemType": {
"title": "Instant messaging account",
"properties": {
"title": {
"title": "Europass item title",
"description": "Europass item title",
"type": "string"
},
"start": {
"title": "Europass item start date",
"description": "Europass item start date",
"$ref": "#/definitions/dateType"
},
"end": {
"title": "Europass item end date",
"description": "Europass item end date",
"$ref": "#/definitions/dateType"
}
},
"additionalProperties": false
},
"epAwardsType": {
"description": "Lists of europass awards",
"type": "array",
"items": {
"$ref": "#/definitions/epDateItemType"
},
"minItems": 0
},
"epPublicationsType": {
"description": "Lists of europass publications",
"type": "array",
"items": {
"$ref": "#/definitions/epDateItemType"
},
"minItems": 0
},
"epProjectsType": {
"description": "Lists of europass projects",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epCitationsType": {
"description": "Lists of europass cititations",
"type": "array",
"items": {
"$ref": "#/definitions/epDateItemType"
},
"minItems": 0
},
"epMembershipsType": {
"description": "Lists of europass memberships",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epConferencesType": {
"description": "Lists of europass conferences",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epSeminarsType": {
"description": "Lists of europass seminars",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epWorkshopsType": {
"description": "Lists of europass workshops",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epReferencesType": {
"description": "Lists of europass references",
"type": "array",
"items": {
"$ref": "#/definitions/epDateItemType"
},
"minItems": 0
},
"epShortAwardsType": {
"description": "Lists of europass awards",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateItemType"
},
"minItems": 0
},
"epShortPublicationsType": {
"description": "Lists of europass publications",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateItemType"
},
"minItems": 0
},
"epShortProjectsType": {
"description": "Lists of europass projects",
"type": "array",
"items": {
"$ref": "#/definitions/epDateRangeItemType"
},
"minItems": 0
},
"epShortCitationsType": {
"description": "Lists of europass cititations",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateItemType"
},
"minItems": 0
},
"epShortMembershipsType": {
"description": "Lists of europass memberships",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateRangeItemType"
},
"minItems": 0
},
"epShortConferencesType": {
"description": "Lists of europass conferences",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateRangeItemType"
},
"minItems": 0
},
"epShortSeminarsType": {
"description": "Lists of europass seminars",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateRangeItemType"
},
"minItems": 0
},
"epShortWorkshopsType": {
"description": "Lists of europass workshops",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateRangeItemType"
},
"minItems": 0
},
"epShortReferencesType": {
"description": "Lists of europass references",
"type": "array",
"items": {
"$ref": "#/definitions/epShortDateItemType"
},
"minItems": 0
},
"skillType": {
"title": "Skill",
"description": "Skill description text",
"type": "string"
},
"resumeEducationType": {
"title": "Education",
"description": "Education description",
"type": "object",
"properties": {
"field": {
"$ref": "#/definitions/educationFieldType"
},
"level": {
"$ref": "#/definitions/educationLevelType"
}
}
},
"employmentType": {
"title": "Job employment type",
"description": "The job employment type",
"type": "string",
"enum": [
"permanent",
"temporary",
"apprenticeship",
"internship",
"tryout",
"holiday",
"freelance",
"supplementary"
]
},
"employmentsType": {
"title": "Job employment types",
"description": "A list of job employment types",
"type": "array",
"items": {
"$ref": "#/definitions/employmentType"
},
"minItems": 0
},
"geoType": {
"title": "Geo Point",
"description": "The geo point (location) including distance",
"type": "object",
"properties": {
"lon": {
"title": "Longitude",
"description": "The geo location longitude",
"type": "number"
},
"lat": {
"title": "Latitude",
"description": "The geo location latitude",
"type": "number"
},
"distance": {
"title": "Distance",
"description": "The geo location distance to lookup in km (kilometer). Default: 25km",
"type": "integer"
}
},
"required": [
"lon",
"lat"
],
"additionalProperties": false
},
"langType": {
"title": "Language code",
"description": "Language code,see europass language codes",
"type": "string",
"pattern": "^[a-z-]{0,7}$"
},
"localeType": {
"title": "Candidate language",
"description": "The candidate text language locale as lower case iso-639-alpha-2 language locale code",
"type": [
"string",
"null"
]
},
"locationsType": {
"title": "Geo locations",
"description": "List of geo points to search for",
"type": "array",
"items": {
"$ref": "#/definitions/geoType"
},
"minItems": 0
},
"minimalExperienceYears": {
"title": "Minimal work experience years",
"description": "The minimal work experience in years",
"type": "integer"
},
"workExperienceYearsType": {
"title": "Work experience years",
"description": "The work experience in years",
"type": "integer"
},
"occupationType": {
"title": "Occupation",
"description": "The occupation (job name)",
"type": "string"
},
"positionType": {
"title": "Postion type",
"description": "The job position type. 10:Employee, 20:Position with responsibilities, 30:Executive position",
"type": "string",
"enum": [
"10",
"20",
"30"
]
},
"aliasType": {
"title": "Alias",
"description": "Anonymous user name",
"type": [
"string",
"null"
]
},
"cityType": {
"title": "City",
"description": "City name",
"type": [
"string",
"null"
]
},
"skillsType": {
"title": "Skills",
"description": "A list of skills required for this job",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
},
"workloadType": {
"title": "Job workload",
"description": "The job workload given as min and max integer",
"type": "object",
"properties": {
"min": {
"title": "Minimal amount of workload",
"description": "Minimal amount of workload in percent",
"type": [
"integer",
"null"
],
"enum": [
0,
10,
20,
30,
40,
50,
60,
70,
80,
90,
100
]
},
"max": {
"title": "Maximal workload",
"description": "Maximal amount of workload in percent",
"type": [
"integer",
"null"
],
"enum": [
10,
20,
30,
40,
50,
60,
70,
80,
90,
100
]
}
},
"required": [
"min",
"max"
],
"additionalProperties": false
}
}
}
JSON schema data description
| Path/Attribute | Title | Description | Required |
|---|