Candidate search request
Candidate search request schema
JSON schema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "id": "http://api.xeebo.com/schema/xeebo-rest-candidate-search-request-schema-v1.0.0.json", 
    "title": "Candidate search request", 
    "description": "Candidate search request schema", 
    "type": "object", 
    "properties": {
        "version": {
            "title": "Candidate data schema version", 
            "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/versionType"
        }, 
        "query": {
            "title": "Candidate search query", 
            "description": "The candidate search query criterias", 
            "type": "object", 
            "properties": {
                "text": {
                    "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/textLineType"
                }, 
                "categories": {
                    "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/categoriesType"
                }, 
                "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/employmentsType"
                }, 
                "languages": {
                    "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/langQueryType"
                }, 
                "locations": {
                    "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/locationsType"
                }, 
                "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/careerStatusType"
                }, 
                "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/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