Classificators

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of system classificators.

URI
/api/v10/classificators

List classificators

List all system classificators used to describe properties of institutions, courses and other entities.

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

Syntax
GET /api/v10/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/v10/classificators"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`1234`	The size of the response body in bytes
`X-Count`	`3`	The number of returned system classificators

Response codes

Response code	Description
`200 OK`	The 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
    }
  },
  {...}
}

Fees

Tableviews