- 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
Dossier search request
Dossier search request schema
JSON schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://api.xeebo.com/schema/xeebo-rest-dossier-search-request-schema-v1.0.0.json",
"title": "Dossier search request",
"description": "Dossier search request schema",
"type": "object",
"properties": {
"version": {
"title": "Dossier data schema version",
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/versionType"
},
"query": {
"title": "Dossier search query",
"description": "The dossier search query criterias",
"type": "object",
"properties": {
"text": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/textLineType"
},
"categories": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/categoriesType"
},
"country": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/countryType"
},
"drivingLicences": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/drivingLicencesType"
},
"education": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/resumeEducationType"
},
"employment": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/employmentsType"
},
"languages": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/langQueryType"
},
"locations": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/locationsType"
},
"occupation": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/occupationType"
},
"position": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/positionType"
},
"status": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/careerStatusType"
},
"sectors": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/sectorsType"
},
"skills": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/skillsType"
},
"workload": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/workloadType"
},
"years": {
"$ref": "http://api.xeebo.com/schema/xeebo-rest-dossier-schema-v1.0.0.json#/definitions/minimalExperienceYears"
}
},
"additionalProperties": false
},
"page": {
"title": "Page Number",
"description": "The pager page batch number",
"type": "integer",
"additionalProperties": false
},
"size": {
"title": "Batch Size Number",
"description": "The pager batch size number",
"type": "integer",
"additionalProperties": false
},
"sort": {
"title": "Sort name",
"description": "The pager sort name",
"type": "string",
"enum": [
"categories",
"country",
"city",
"drivingLicences",
"employment",
"occupation",
"position",
"status",
"years",
"modified"
]
},
"order": {
"title": "Sort order",
"description": "The pager sort order",
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"query",
"page",
"size"
],
"additionalProperties": false
}
JSON schema data description
| Path/Attribute | Title | Description | Required |
|---|