Candidate search response
Candidate search response schema
JSON schema
  1. {
  2.     "$schema": "http://json-schema.org/draft-04/schema",
  3.     "id": "http://api.xeebo.com/schema/xeebo-rest-candidate-search-response-schema-v1.0.0.json",
  4.     "title": "Candidate search response",
  5.     "description": "Candidate search response schema",
  6.     "type": "object",
  7.     "properties": {
  8.         "status": {
  9.             "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/statusCodeType"
  10.         },
  11.         "page": {
  12.             "title": "Page Number",
  13.             "description": "The current page number",
  14.             "type": "integer",
  15.             "additionalProperties": false
  16.         },
  17.         "pages": {
  18.             "title": "Total available pages",
  19.             "description": "Total available number of pagesr",
  20.             "type": "integer",
  21.             "additionalProperties": false
  22.         },
  23.         "total": {
  24.             "title": "Total results",
  25.             "description": "The total amount of available items for given query",
  26.             "type": "integer",
  27.             "additionalProperties": false
  28.         },
  29.         "results": {
  30.             "title": "Candidates",
  31.             "description": "A list of candidate related to the given search criteria",
  32.             "type": "array",
  33.             "items": {
  34.                 "type": "object",
  35.                 "properties": {
  36.                     "key": {
  37.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/keyType"
  38.                     },
  39.                     "categories": {
  40.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/categoriesType"
  41.                     },
  42.                     "city": {
  43.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/cityType"
  44.                     },
  45.                     "country": {
  46.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/countryType"
  47.                     },
  48.                     "drivingLicences": {
  49.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/drivingLicencesType"
  50.                     },
  51.                     "education": {
  52.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/resumeEducationType"
  53.                     },
  54.                     "employment": {
  55.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/employmentType"
  56.                     },
  57.                     "occupation": {
  58.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/occupationType"
  59.                     },
  60.                     "position": {
  61.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/positionType"
  62.                     },
  63.                     "status": {
  64.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/careerStateType"
  65.                     },
  66.                     "sectors": {
  67.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/sectorsType"
  68.                     },
  69.                     "skills": {
  70.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/skillsType"
  71.                     },
  72.                     "workload": {
  73.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/workloadType"
  74.                     },
  75.                     "years": {
  76.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/workExperienceYearsType"
  77.                     },
  78.                     "url": {
  79.                         "title": "Candidate detail page uri",
  80.                         "description": "URL pointing to the candidate detail page",
  81.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/uriType"
  82.                     },
  83.                     "imgURL": {
  84.                         "title": "Candidate image uri",
  85.                         "description": "URL pointing to the candidate image",
  86.                         "$ref": "http://api.xeebo.com/schema/xeebo-rest-candidate-schema-v1.0.0.json#/definitions/uriType"
  87.                     }
  88.                 },
  89.                 "additionalProperties": false
  90.             }
  91.         },
  92.         "code": {
  93.             "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorCodeType"
  94.         },
  95.         "error": {
  96.             "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorMessageType"
  97.         },
  98.         "description": {
  99.             "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorDescriptionType"
  100.         },
  101.         "url": {
  102.             "$ref": "http://api.xeebo.com/schema/xeebo-error-schema-v1.0.0.json#/definitions/errorURLType"
  103.         }
  104.     },
  105.     "required": [
  106.         "status",
  107.         "results"
  108.     ],
  109.     "additionalProperties": false
  110. }
JSON schema data description
Path/Attribute Title Description Required