Classificators

Represents a list of system classificators.

URI
/api/v9/classificators

GET List classificators

List all system classificators that are used to describe some of the properties of institutions, courses, etc.

The classificators are grouped into classes with each classificator consisting of a set of abbreviations mapped to titles and weights. The weights are set so that “heavier” values will “sink” lower in the list.

Syntax
GET /api/v9/classificators
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/classificators"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonMedia type of the resource
Content-Length1234Size of the response body in bytes
X-Count3Number of returned system classificators

Response codes

Response codeDescription
200 OKThe list of classificators was successfully returned

Example response

Response
{
  {...},
  "Education level": {
    "SE": {
      "title": "Secondary education",
      "weight": 1
    },
    "VO": {
      "title": "Vocational education",
      "weight": 2
    },
    "PE": {
      "title": "Pre-education",
      "weight": 3
    },
    "BA": {
      "title": "Bachelor degree",
      "weight": 4
    },
    "MA": {
      "title": "Master degree",
      "weight": 5
    },
    "EX": {
      "title": "Exchange",
      "weight": 6
    },
    "IN": {
      "title": "Informal training",
      "weight": 7
    },
    "OQ": {
      "title": "Other qualification",
      "weight": 8
    },
    "PD": {
      "title": "Doctoral degree",
      "weight": 9
    }
  },
  {...}
}