Application apply request
Application apply request schema
JSON schema
download schema 
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "id": "http://api.xeebo.com/schema/xeebo-integration-application-apply-request-schema-v1.0.0.json", 
    "title": "Application apply request", 
    "description": "Application apply request schema", 
    "type": "object", 
    "definitions": {
        "versionType": {
            "title": "Schema Version", 
            "description": "Schema version string", 
            "type": "string", 
            "pattern": "^[0-9]\\.[0-9]\\.[0-9]$"
        }, 
        "secretType": {
            "title": "Secret", 
            "description": "An identification secret", 
            "type": "string"
        }, 
        "idType": {
            "title": "Identifier", 
            "description": "Company, job, publication or application identifier", 
            "type": "string"
        }, 
        "commentType": {
            "title": "Optional Comment", 
            "description": "Comment written by applicant, optional for Recruiter", 
            "type": "string"
        }, 
        "localeType": {
            "title": "Locale", 
            "description": "Two digit iso alpha-2 language locale as lowercase", 
            "pattern": "^[a-z]{2}$"
        }, 
        "dateType": {
            "title": "ISO Datetime", 
            "description": "ISO datetime string", 
            "type": "string"
        }
    }, 
    "properties": {
        "version": {
            "title": "Application schema version", 
            "$ref": "#/definitions/versionType"
        }, 
        "secret": {
            "title": "A secret string", 
            "$ref": "#/definitions/secretType"
        }, 
        "comName": {
            "title": "Company identifier", 
            "description": "The xeebo company identifier. Same as used in your company profile page url.", 
            "$ref": "#/definitions/idType"
        }, 
        "jobName": {
            "title": "Job identifier", 
            "description": "A unique job identifier given from your system", 
            "$ref": "#/definitions/idType"
        }, 
        "pubName": {
            "title": "Publication identifier", 
            "description": "A unique publication identifier given from your system", 
            "$ref": "#/definitions/idType"
        }, 
        "appName": {
            "title": "Application identifier", 
            "description": "A unique application identifier given from our system", 
            "$ref": "#/definitions/idType"
        }, 
        "application": {
            "title": "Application information", 
            "description": "Contains all the application information", 
            "$ref": "http://api.xeebo.com/schema/xeebo-integration-application-schema-v1.0.0.json#/definitions/applicationType"
        }, 
        "applicant": {
            "title": "Applicant", 
            "description": "The applicant address and contact information applying to the related job", 
            "$ref": "http://api.xeebo.com/schema/xeebo-integration-application-schema-v1.0.0.json#/definitions/applicantType"
        }, 
        "employer": {
            "title": "Employer company", 
            "description": "Employer address and contact information", 
            "$ref": "http://api.xeebo.com/schema/xeebo-integration-application-schema-v1.0.0.json#/definitions/companyType"
        }, 
        "recruiter": {
            "title": "Recruiter company", 
            "description": "Recruiter address and contact information if available", 
            "$ref": "http://api.xeebo.com/schema/xeebo-integration-application-schema-v1.0.0.json#/definitions/companyType"
        }, 
        "comment": {
            "title": "Application comment", 
            "$ref": "#/definitions/commentType"
        }, 
        "locale": {
            "title": "Application locale", 
            "$ref": "#/definitions/localeType"
        }, 
        "created": {
            "title": "Application Date", 
            "description": "Date where the applicant generated the application", 
            "$ref": "#/definitions/dateType"
        }
    }, 
    "required": [
        "version", 
        "comName", 
        "jobName", 
        "pubName", 
        "appName", 
        "application", 
        "applicant", 
        "employer", 
        "locale", 
        "created"
    ], 
    "additionalProperties": false
}
JSON schema data description
Path/Attribute Title Description Required
version Application schema version Schema version string yes
secret A secret string An identification secret optional
comName Company identifier The xeebo company identifier. Same as used in your company profile page url. yes
jobName Job identifier A unique job identifier given from your system yes
pubName Publication identifier A unique publication identifier given from your system yes
appName Application identifier A unique application identifier given from our system yes
comment Application comment Comment written by applicant, optional for Recruiter optional
created Application Date Date where the applicant generated the application yes
locale Application locale Two digit iso alpha-2 language locale as lowercase yes
application Application information Contains all the application information yes
application.
url 		Application page uri URL pointing to the xeebo application page optional
application.
email 		Application contact email address Application contact email address optional
application.
resume 		Short resume Additional resume information optional
application.
letter 		Application letter Application letter as pdf or text document optional
application.
cv 		Europass CV PDF/XML document Europass CV PDF/XML document optional
application.
documents 		Additional application documents List of additional application documents optional
application.documents.
name 		Document name optional
application.documents.
description 		Document description optional
application.documents.
mimeType 		Document mime type optional
application.documents.
size 		Document data size optional
application.documents.
typ 		Document type The document type optional
application.documents.
md5 		MD5 identifier optional
application.
educations 		Educations List of applicants educations optional
application.educations.
name 		Organisation name The organisation name optional
application.educations.
street 		Street optional
application.educations.
co 		Care of The care of address line or second address line optional
application.educations.
poBox 		Post office box The post office box address optional
application.educations.
zip 		Postal code The postal code reference for a given city optional
application.educations.
city 		The location city optional
application.educations.
state 		The location state optional
application.educations.
country 		Country code The aplha-2 country code optional
application.educations.
start 		Start date The education start date optional
application.educations.
end 		End date The education end date optional
application.educations.
title 		Qualification title Title of qualification awarded optional
application.educations.
skills 		Occupational skills Principal subjects occupational skills covered optional
application.educations.
level 		Eduction Level The educational background required for this job. European Qualifications Framework (EQF) Level, http://ec.europa.eu/education/lifelong-learning-policy/eqf_en.htm optional
application.educations.
field 		Eduction Field The international standard classification of Education (Level 2) required for this job. http://www.unesco.org/education/information/nfsunesco/doc/isced_1997.htm optional
application.educations.
education 		Education classification Level in EQF or national classification optional
application.educations.
organisation 		Organisation type The organisation type optional
application.educations.
website 		Organisation website optional
application.
experiences 		Experiences List of applicants experiences optional
application.experiences.
name 		Organisation name The organisation name optional
application.experiences.
street 		Street optional
application.experiences.
co 		Care of The care of address line or second address line optional
application.experiences.
poBox 		Post office box The post office box address optional
application.experiences.
zip 		Postal code The postal code reference for a given city optional
application.experiences.
city 		The location city optional
application.experiences.
state 		The location state optional
application.experiences.
country 		Country code The aplha-2 country code optional
application.experiences.
start 		Start date The education start date optional
application.experiences.
end 		End date The education end date optional
application.experiences.
occupation 		Occupation Occupation optional
application.experiences.
activities 		Activities Work activities optional
application.experiences.
sector 		Business sector Organisation business sector optional
application.experiences.
website 		Organisation website optional
application.
languages 		Foreign languages List of applicants languages optional
application.languages.
lang 		Language code Two digit iso alpha-2 language code as lowercase optional
application.languages.
listening 		Listening optional
application.languages.
reading 		Reading optional
application.languages.
interaction 		Spoken Interaction optional
application.languages.
production 		Spoken Production optional
application.languages.
writing 		Writing optional
applicant Applicant The applicant address and contact information applying to the related job yes
applicant.
user 		Applicant personal information Describing a person and his/her personal data optional
applicant.user.
nickname 		Nickname The nickname used at xeebo optional
applicant.user.
salutation 		The contact salutation optional
applicant.user.
academic 		Academic title optional
applicant.user.
firstname 		optional
applicant.user.
lastname 		optional
applicant.
contact 		Applicant contact information Describing a person and his/her contact options optional
applicant.contact.
url 		Profile page uri URL pointing to the xeebo profile page optional
applicant.contact.
email 		Contact email address Applicant contact email address optional
applicant.contact.
phone 		Contact phone number Applicant contact phone number optional
applicant.contact.
mobile 		Contact mobile phone number Applicant contact mobile number optional
applicant.
address 		Applicant address information Describing an address optional
applicant.address.
co 		Care of The care of address line or second address line optional
applicant.address.
poBox 		Post office box The post office box address optional
applicant.address.
zip 		Postal code The postal code reference for a given city optional
applicant.address.
city 		The location city optional
applicant.address.
state 		The location state optional
applicant.address.
country 		Country code The aplha-2 country code optional
recruiter Recruiter company Recruiter address and contact information if available optional
recruiter.
name 		Company name optional
recruiter.
user 		Company user information Describing a person and his/her personal data optional
recruiter.user.
nickname 		Nickname The nickname used at xeebo optional
recruiter.user.
salutation 		The contact salutation optional
recruiter.user.
academic 		Academic title optional
recruiter.user.
firstname 		optional
recruiter.user.
lastname 		optional
recruiter.
contact 		Company user contact information Describing a person and his/her contact options optional
recruiter.contact.
url 		Profile page uri URL pointing to the xeebo profile page optional
recruiter.contact.
email 		Contact email address Applicant contact email address optional
recruiter.contact.
phone 		Contact phone number Applicant contact phone number optional
recruiter.contact.
mobile 		Contact mobile phone number Applicant contact mobile number optional
recruiter.
address 		Company address information Describing a company address optional
recruiter.address.
co 		Care of The care of address line or second address line optional
recruiter.address.
poBox 		Post office box The post office box address optional
recruiter.address.
zip 		Postal code The postal code reference for a given city optional
recruiter.address.
city 		The location city optional
recruiter.address.
state 		The location state optional
recruiter.address.
country 		Country code The aplha-2 country code optional
employer Employer company Employer address and contact information yes
employer.
name 		Company name optional
employer.
user 		Company user information Describing a person and his/her personal data optional
employer.user.
nickname 		Nickname The nickname used at xeebo optional
employer.user.
salutation 		The contact salutation optional
employer.user.
academic 		Academic title optional
employer.user.
firstname 		optional
employer.user.
lastname 		optional
employer.
contact 		Company user contact information Describing a person and his/her contact options optional
employer.contact.
url 		Profile page uri URL pointing to the xeebo profile page optional
employer.contact.
email 		Contact email address Applicant contact email address optional
employer.contact.
phone 		Contact phone number Applicant contact phone number optional
employer.contact.
mobile 		Contact mobile phone number Applicant contact mobile number optional
employer.
address 		Company address information Describing a company address optional
employer.address.
co 		Care of The care of address line or second address line optional
employer.address.
poBox 		Post office box The post office box address optional
employer.address.
zip 		Postal code The postal code reference for a given city optional
employer.address.
city 		The location city optional
employer.address.
state 		The location state optional
employer.address.
country 		Country code The aplha-2 country code optional