API reference

This list gives a broad overview of the available API requests. Click the links below to get detailed information about each API request.

Journal

Applicants

Applications

Institutions

Academic years

Academic terms

Intakes

Courses

Scoresheets

Rankings

Interviews

Invoices

Fees

Classificators

Tableviews

Reports

Administrators

Purged resources

Ping

Version

Return types

The DreamApply API defines the following object types:

• Collection
• Resource
• Association

An association is an object that represents a relationship between two resources. It is used for one-to-many and many-to-many relationships. In some cases, an association can include its own data. For example, an association between an applicant and a tracker may include the time when the relationship was established. For this reason, the association is treated as a specialized resource.

ID conventions

All resources have unique numeric IDs, such as applicant ID, application ID, tracker ID and institution ID.

• IDs carry no meaning or information
• IDs are permanent and will never change
• There may be gaps between IDs
• Deleted IDs are never reused

Some resources have unique properties, such as a tracker or a flag name. While these properties uniquely identify a resource, they cannot be used as IDs. These properties may change over time, and an ID must remain constant throughout the life of the resource.

Resource IDs are typically used as object keys in API responses. For example, GET /api/v10/applicants will return a collection of applicants as a JSON object with the resource IDs as keys:

{
  "123": { .. applicant properties .. },
  "124": { .. applicant properties .. },
  "125": { .. applicant properties .. }
}

You can get detailed information about a specific resource by using its ID. For example, GET /api/v10/applicants/123 will return the data about an applicant with ID 123:

"123": {
  "id": "...",
  "type": "...",
  "registered": "...",
  "name": {
    "full": "...",
    "given": "...",
    "middle": "...",
    "family": "..."
  },
  "email": "...",
  "phone": "...",
  "reference": "...",
  "matriculation": "...",
  "citizenship": "...",
  "notes": "...",
  "applications": "...",
  "trackers": "...",
  "photo": "...",
  "consents": "...",
  "invoices": "...",
  "wishes": "...",
  "documents": "..."
}