- 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 search response
Candidate search response schema
JSON schema
- {
- "$schema": "http://json-schema.org/draft-04/schema",
- "id": "http://api.xeebo.com/schema/xeebo-rest-candidate-search-response-schema-v1.0.0.json",
- "title": "Candidate search response",
- "description": "Candidate search response schema",
- "type": "object",
- "properties": {
- "status": {
- "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/statusCodeType"
- },
- "page": {
- "title": "Page Number",
- "description": "The current page number",
- "type": "integer",
- "additionalProperties": false
- },
- "pages": {
- "title": "Total available pages",
- "description": "Total available number of pagesr",
- "type": "integer",
- "additionalProperties": false
- },
- "total": {
- "title": "Total results",
- "description": "The total amount of available items for given query",
- "type": "integer",
- "additionalProperties": false
- },
- "results": {
- "title": "Candidates",
- "description": "A list of candidate related to the given search criteria",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "key": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/keyType"
- },
- "categories": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/categoriesType"
- },
- "city": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/cityType"
- },
- "country": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/countryType"
- },
- "drivingLicences": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/drivingLicencesType"
- },
- "education": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/resumeEducationType"
- },
- "employment": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/employmentType"
- },
- "occupation": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/occupationType"
- },
- "position": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/positionType"
- },
- "status": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/careerStateType"
- },
- "sectors": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/sectorsType"
- },
- "skills": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/skillsType"
- },
- "workload": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/workloadType"
- },
- "years": {
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/workExperienceYearsType"
- },
- "url": {
- "title": "Candidate detail page uri",
- "description": "URL pointing to the candidate detail page",
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/uriType"
- },
- "imgURL": {
- "title": "Candidate image uri",
- "description": "URL pointing to the candidate image",
- "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/uriType"
- }
- },
- "additionalProperties": false
- }
- },
- "code": {
- "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorCodeType"
- },
- "error": {
- "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorMessageType"
- },
- "description": {
- "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorDescriptionType"
- },
- "url": {
- "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorURLType"
- }
- },
- "required": [
- "status",
- "results"
- ],
- "additionalProperties": false
- }
JSON schema data description
| Path/Attribute | Title | Description | Required |
|---|