DreamApply

https://docs.dreamapply.com
Admin
DreamApply is an application platform that provides a REST API and PHP SDK for developers to...
Tokens:3,494,488
Snippets:13,642
Trust Score:9.5
Update:11 months ago
Show doc for...
Tokens:
Raw
### Example API Request

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743199952

A cURL example demonstrating how to make a GET request to the /api/institutions endpoint with the correct authentication header.

```APIDOC
## Example API Request

### Description
This example shows how to make a GET request to the `/api/institutions` endpoint using cURL, including the necessary Authorization header.

### Method
GET

### Endpoint
`https://apply.uni.edu/api/institutions`

### Parameters
#### Request Header
- **Authorization** (string) - Required - `DREAM apikey="YOUR-API-KEY"`

### Request Example
```bash
curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
```

### Response
#### Success Response (200)
Returns a JSON object containing institution data. The exact structure depends on the API version and specific endpoint.

#### Response Example
```json
{
  "example": "institution data structure"
}
```
```

--------------------------------

### GET /api/intakes - HTTP Request Example

Source: https://docs.dreamapply.com/doku_id=api%3Aapi_intakes&rev=1464790312

An example HTTP GET request to retrieve a list of intakes. It demonstrates the required headers, including the Host and Authorization fields. The response is in JSON format, providing details about each intake's configuration and deadlines.

```http
GET /api/intakes
Host: apply.example.edu
Authorization: DREAM apikey="..."
```

--------------------------------

### GET HEAD /api/journal

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

List journal events. This endpoint is the start point for many integrations and supports both GET and HEAD methods.

```APIDOC
## GET /api/journal

### Description
List journal events. Start point for many integrations.

### Method
GET, HEAD

### Endpoint
/api/journal

### Parameters
#### Query Parameters
- (filters) (object) - Optional - Filtering parameters (specific fields not specified in source).

### Request Example
{
  "filters": {}
}

### Response
#### Success Response (200)
- **events** (array) - List of journal events

#### Response Example
{
  "events": []
}

```

--------------------------------

### Create Course

Source: https://docs.dreamapply.com/doku_id=api%3Aapi_courses&rev=1589214639

Creates a new blank course, useful for importing basic course lists from external systems. Full configuration typically requires using the DreamApply GUI.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course, useful for importing basic course lists from external systems. Full configuration typically requires using the DreamApply GUI. The URI of the newly created course is returned in the `Location` header.

### Method
POST

### Endpoint
/api/courses

### Request Body
(Note: The request body structure for creating a course is not detailed in the provided text. It is recommended to consult further documentation or use the GUI for guidance on required fields.)

### Request Example
```
POST /api/courses
Host: apply.example.edu
Authorization: DREAM apikey="..."
Content-Type: application/json

{ 
  "name": "New Course Name",
  "type": "UG",
  "status": "Draft"
  // ... other required fields 
}
```

### Response
#### Success Response (201 Created)
- **Location** (header) - The URI of the newly created course.

#### Error Response
- **400 Bad Request** - If required fields are missing or invalid.
- **401 Unauthorized** - If the API key is invalid or missing.
```

--------------------------------

### API Call Guidelines

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743200438

General guidelines for interacting with the DreamApply API, including handling of HEAD/GET requests, compression, filtering parameters, and resource ID usage.

```APIDOC
## API Call Guidelines

### Description
Provides general guidelines for interacting with the DreamApply API, covering request methods, parameter handling, and response structures.

### General Notes
*   **HEAD vs. GET**: `HEAD` and `GET` requests have identical syntax and responses, with `HEAD` omitting the response body. `HEAD` is recommended for checking resource existence, size, or metadata without transferring the full resource.
*   **Content-Length and Compression**: The `Content-Length` header may not reflect the actual transmitted data due to compression. The reported size for `HEAD` requests is uncompressed.
*   **Filtering Parameters**: Parameters starting with `by..` are for filtering (e.g., `byStatuses`).
*   **List Parameters**: Lists in filtering parameters can be comma or space-separated and use logical OR. Filtering parameters themselves use logical AND.
*   **Resource IDs**: Resource IDs (e.g., applicant ID `123`) are used as keys in JSON objects when enumerating resources. For example, `/api/applicants` might return a JSON object with applicant IDs as keys.

### Example Resource Enumeration

`/api/applicants` might return:
```json
{
  "123": { ... applicant properties ... },
  "124": { ... applicant properties ... },
  "125": { ... applicant properties ... }
}
```
To get details for a specific applicant, use their ID: `/api/applicants/124`.
```

--------------------------------

### GET /api/institutions Example

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

An example cURL command to fetch institution data from the DreamApply API. This request requires the `Authorization` header to be set with a valid API key.

```APIDOC
## GET /api/institutions

### Description
Fetches institution data. This is an example endpoint to demonstrate API usage and authentication.

### Method
GET

### Endpoint
`/api/institutions`

### Parameters
#### Query Parameters
None specified in the provided text.

#### Request Header
- **Authorization** (string) - Required - Format: `DREAM apikey="Your secret API Key"`

### Request Example
```bash
curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
```

### Response
#### Success Response (200)
- **(Unknown)** (type) - Description: The response format is not specified, but can be prettified with `| python -m json.tool` if JSON is returned.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### API Versioning Guide

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1758618088

Explains the versioning strategy, supported versions, and how to use version prefixes in API requests.

```APIDOC
## API Versioning

The API version number increments for backwards-incompatible changes or significant semantic/data structure changes. Backwards compatibility is a priority, and deprecated versions may remain available but not indefinitely.

### Supported API Versions

- **Version 1:** Deprecated
- **Version 2:** Deprecated
- **Version 3:** Supported (default)
- **Version 4:** Supported
- **Version 5:** Supported
- **Version 6:** Supported (latest, recommended)

### Specifying API Version

To use a specific API version, prefix your requests with the version number:

```
GET /api/v{version}/resource
```

**Example:**
```
GET /api/v3/applicants/123/photo
```

If the version number is omitted, the latest supported API version is used:

```
GET /api/applicants/123/photo
```

**Implications of Latest Version:** Using the latest version means queries not present in that version will result in an error. The version number applies to the entire API, not individual queries. It is recommended to always prefix queries with a specific API version for stability.

### Current API Version Query

To query the current API version:

```
GET /api/version
```

API versions will not be discontinued without prior notification and a reasonable transition period.
```

--------------------------------

### Get Applicant Invoices - API Request Example

Source: https://docs.dreamapply.com/doku_id=api%3Aapi_applicants_id_invoices&rev=1405172245

Example syntax for making a GET request to retrieve invoices for a specific applicant. Requires specifying the applicant ID in the URL and including the Host and Authorization headers.

```http
GET /api/applicants/123/invoices
Host: apply.example.edu
Authorization: DREAM apikey="..."
```

--------------------------------

### GET HEAD /api/applicants/ID/notes

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the notes on an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/notes

### Description
Get the notes on the applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/notes

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **notes** (array) - List of notes

#### Response Example
{
  "notes": []
}

```

--------------------------------

### Courses

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743200438

Endpoints for listing and creating course information.

```APIDOC
## GET HEAD /api/courses

### Description
Lists courses using filters set as parameters.

### Method
GET HEAD

### Endpoint
/api/courses

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filters for courses.

### Response
#### Success Response (200)
- **courses** (array) - A list of courses.

## POST /api/courses

### Description
Creates a new blank course.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Request Body
- **course_details** (object) - Required - Details for the new course.

### Response
#### Success Response (200)
- **course** (object) - The newly created course details.

## GET HEAD /api/courses/{ID}

### Description
Provides more detailed information about a specific course.

### Method
GET HEAD

### Endpoint
/api/courses/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID of the course.

### Response
#### Success Response (200)
- **course_details** (object) - Detailed information about the course.
```

--------------------------------

### GET HEAD /api/applicants/trackers

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of all trackers. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/trackers

### Description
Get a list of all trackers.

### Method
GET, HEAD

### Endpoint
/api/applicants/trackers

### Parameters
#### Query Parameters
- (filters) (object) - Optional - Filtering parameters (specific fields not specified in source).

### Request Example
{
  "filters": {}
}

### Response
#### Success Response (200)
- **trackers** (array) - List of trackers

#### Response Example
{
  "trackers": []
}

```

--------------------------------

### POST /api/courses

Source: https://docs.dreamapply.com/doku_do=diff&id=api%3Aapi_courses&rev=1406154370

Create a new blank course for importing from external systems. Requires subsequent configuration via DreamApply GUI for full setup including admission requirements, intakes, fees, etc.

```APIDOC
## POST /api/courses

### Description
Create a new blank course. This is useful when you want to automatically import a list of courses from another system into DreamApply. Please note however, that the needed fields for fully configuring an applicable course in DreamApply is quite long, including various settings for admission requirements, intakes, motivation letters, fees and so on. This data is typically not available in other systems, like Student Information Systems, at least not in the required depth. It is therefore recommended to use this API call to import a "basic list" of courses that will be then fine-tuned and fully configured using the dedicated GUI tools in DreamApply built for managing this data effectively.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Request Body
- **institution** (string) - Required - A valid institution ID in DreamApply (see the /api/institutions calls to learn it)
- **type** (string) - Required - Course type code (undergraduate, postgraduate, etc). Make a call to /api/classificators or use DreamApply GUI tools (System -> Classificators) to learn possible "Course type" classificator values

### Request Example
```json
{
  "institution": "/api/institutions/1",
  "type": "bsc"
}
```

### Response
#### Success Response (201)
- **Location** (string) - URI for the newly created course in the response header

#### Response Example
Headers include: Location: /api/courses/123
No response body typically returned for POST creation.
```

--------------------------------

### Authentication Header Setup

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743687123

Details on how to set up the authentication header required for all API requests except the version endpoint.

```APIDOC
## Authentication Header

### Description
Setup the authentication header required for all API requests except `/api/version`.

### Method
Any HTTP method

### Endpoint
All endpoints except `/api/version`

### Parameters
#### Headers
- **Authorization** (string) - Required - Must be in the format `DREAM apikey="YOUR-API-KEY"`

### Request Example
```
curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
```
```

--------------------------------

### GET HEAD /api/applicants/consents

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of all consents. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/consents

### Description
Get a list of all consents.

### Method
GET, HEAD

### Endpoint
/api/applicants/consents

### Parameters
#### Query Parameters
- (filters) (object) - Optional - Filtering parameters (specific fields not specified in source).

### Request Example
{
  "filters": {}
}

### Response
#### Success Response (200)
- **consents** (array) - List of consents

#### Response Example
{
  "consents": []
}

```

--------------------------------

### DreamApply API: Create Course (POST) Syntax and Parameters

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1406154369&rev2%5B1%5D=1638973166

Details the syntax and required parameters for the POST request to create a new course. It emphasizes the 'institution' and 'type' fields, recommending the GUI for full course configuration due to the complexity of required fields.

```http
POST /api/applicants
Host: apply.example.edu
Authorization: DREAM apikey="..."

==== Parameters ====

^ Name ^ ^ Description ^
| ''institution'' | **Required** | A valid institution ID in DreamApply (see the ''/api/institutions'' calls to learn it). |
| ''type'' | **Required** | Course type code (undergraduate, postgraduate, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course type'' classificator values.
```

--------------------------------

### GET HEAD /api/applicants/ID/photo

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the applicant photo. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/photo

### Description
Get the applicant's photo.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/photo

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **photo** (binary) - Image data

#### Response Example
[Binary image data]

```

--------------------------------

### Making an API Request with cURL

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1749475796

An example of how to make an initial API request using the cURL command-line tool. It demonstrates setting the Authorization header and the target API endpoint. The output can be prettified using 'python -m json.tool' if JSON data is expected.

```bash
curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
# Optional: add | python -m json.tool for JSON output prettification
```

--------------------------------

### GET HEAD /api/applicants/trackers/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific tracker. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/trackers/{ID}

### Description
Get information about a specific tracker.

### Method
GET, HEAD

### Endpoint
/api/applicants/trackers/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Tracker identifier

### Request Example
{}

### Response
#### Success Response (200)
- **tracker** (object) - Tracker details

#### Response Example
{
  "tracker": {}
}

```

--------------------------------

### Create Course

Source: https://docs.dreamapply.com/doku_do=diff&id=api%3Aapi_courses&rev=1406154369

Creates a new blank course, useful for bulk imports from external systems. It's recommended to use this for basic course creation, with further configuration done via the DreamApply GUI.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course. This is particularly useful for importing courses from external systems. It is recommended to create a basic course list via this API and then refine the details using the DreamApply GUI.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Request Body
- **institution** (string) - Required - The ID of the institution for the course.
- **type** (string) - Required - The course type code (e.g., 'undergraduate', 'postgraduate'). Use the /api/classificators endpoint or DreamApply GUI to find valid codes.

### Request Example
```json
{
  "institution": "/api/institutions/1",
  "type": "undergraduate"
}
```

### Response
#### Success Response (201 Created)
- **Location** (header) - The URI of the newly created course.

#### Response Example
(Header: Location: /api/courses/newly-created-course-id)
```

--------------------------------

### GET HEAD /api/applicants/consents/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific consent. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/consents/{ID}

### Description
Get information about a specific consent.

### Method
GET, HEAD

### Endpoint
/api/applicants/consents/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Consent identifier

### Request Example
{}

### Response
#### Success Response (200)
- **consent** (object) - Consent details

#### Response Example
{
  "consent": {}
}

```

--------------------------------

### POST /api/courses

Source: https://docs.dreamapply.com/doku_id=api%3Aapi_courses

Create a new blank course resource, suitable for importing basic course lists from external systems. The full configuration of a course, including admissions, intakes, and fees, should be completed via DreamApply's GUI. The URI of the created course is returned in the Location header.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course entry. This endpoint is intended for initial import of course data, with further details to be added through the DreamApply interface.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Request Body
No specific fields required; creates a blank course.

### Request Example
POST /api/courses
Host: apply.example.edu
Authorization: DREAM apikey="..."

### Response
#### Success Response (201)
- **Location** (header) - URI of the newly created course.

#### Response Example
No body; Location: /api/courses/123
```

--------------------------------

### GET HEAD /api/applicants/ID/matriculation

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the matriculation number for an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/matriculation

### Description
Get the matriculation number for this applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/matriculation

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **matriculation** (string) - Matriculation number

#### Response Example
{
  "matriculation": "string"
}

```

--------------------------------

### POST /api/courses

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1404253561&rev2%5B1%5D=1589214792

Creates a new blank course in DreamApply. Designed for importing course lists from external systems. Returns the URI of the created course in the Location header.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course in DreamApply. This is useful when automatically importing course lists from another system. Note that fully configuring a course requires many additional settings beyond the basic parameters. It is recommended to use this API to import a "basic list" of courses that will be fine-tuned using DreamApply's GUI tools.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Request Body
- **institution** (integer) - Required - A valid institution ID in DreamApply (see the `/api/institutions` calls to learn it)
- **type** (string) - Required - Course type code (undergraduate, postgraduate, etc). Make a call to `/api/classificators` or use DreamApply GUI tools (System -> Classificators) to learn possible "Course type" classificator values

#### Headers
- **Authorization** (string) - Required - API key in format: `DREAM apikey="..."`
- **Host** (string) - Required - Application host (e.g., apply.example.edu)

### Request Example
```json
{
  "institution": 1,
  "type": "UG"
}
```

### Response
#### Success Response (201)
Course successfully created. The URI for the new course is returned in the Location header.

#### Response Headers
- **Location** (string) - URI of the newly created course

#### Error Handling
- **400 Bad Request** - Missing required parameters or invalid institution/type values
- **401 Unauthorized** - Invalid or missing API key
- **403 Forbidden** - Insufficient permissions to create courses
- **500 Internal Server Error** - Server error during course creation
```

--------------------------------

### GET HEAD /api/applicants/ID/reference

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the reference code for an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/reference

### Description
Get the reference code for this applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/reference

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **reference** (string) - Reference code

#### Response Example
{
  "reference": "string"
}

```

--------------------------------

### GET HEAD /api/applicants/ID/applications/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about an applicant application. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/applications/{ID}

### Description
Get information about an applicant application.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/applications/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Application identifier

### Request Example
{}

### Response
#### Success Response (200)
- **application** (object) - Application details

#### Response Example
{
  "application": {}
}

```

--------------------------------

### DreamApply API: Create Course (POST)

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1406154369&rev2%5B1%5D=1722340208

This section details how to create a new course using a POST request. It requires 'institution' and 'type' as parameters and returns the URI of the newly created course in the 'Location' header. This is recommended for basic course creation, with further configuration best done via the GUI.

```HTTP
POST /api/applicants HTTP/1.1
Host: apply.example.edu
Authorization: DREAM apikey="..."
Content-Type: application/json

{
  "institution": "/api/institutions/1",
  "type": "undergraduate"
}
```

--------------------------------

### GET HEAD /api/applicants/ID/wishes

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the applicant's wishlist. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/wishes

### Description
Applicants wishlist.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/wishes

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **wishes** (array) - List of wishes

#### Response Example
{
  "wishes": []
}

```

--------------------------------

### DreamApply API: Create a new course (POST)

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1580392871&rev2%5B1%5D=1638973166

This snippet details the syntax and parameters for creating a new course via a POST request. It recommends creating a basic course via API and fine-tuning it with GUI tools due to the extensive configuration options.

```HTTP
POST /api/applicants
Host: apply.example.edu
Authorization: DREAM apikey="..."

==== Parameters ====
^ Name ^ ^ Description ^
| ''institution'' | **Required** | A valid institution ID in DreamApply (see the ''/api/institutions'' calls to learn it). |
| ''type'' | **Required** | Course type code (undergraduate, postgraduate, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course type'' classificator values. |
| ''mode'' | **Required** | Course mode code (full time, part time, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course mode'' classificator values. |
| ''name'' | **Required** | Up to 2048 characters. |
| ''awards_abbr'' | Optional | Abbreviation of the award (BSc, MSc, etc). |
| ''awards_full'' | Optional | Full name of the award (for example "Bachelor of Science"). Up to 2048 characters. |
| ''language'' | Optional | Accepts a 2-letter (alpha-2) ISO language code. |
| ''country'' | Optional | Accepts an [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country code]]. |
| ''location'' | Optional | The location where the studies take place (city, district, etc). Up to 256 characters. |
| ''code'' | Optional | Can be any text to uniquely identify this course in another system, like a Study Information System or course catalogue. Up to 128 characters. |
```

--------------------------------

### GET HEAD /api/applicants/ID/invoices/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about an applicant invoice. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/invoices/{ID}

### Description
Get information about an applicant invoice.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/invoices/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Invoice identifier

### Request Example
{}

### Response
#### Success Response (200)
- **invoice** (object) - Invoice details

#### Response Example
{
  "invoice": {}
}

```

--------------------------------

### API POST Request Syntax and Parameters

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1404253561&rev2%5B1%5D=1589214707

This snippet outlines the syntax and parameters for a POST request to create a new course via the API. It specifies required and optional fields, along with their descriptions and constraints.

```http
POST /api/applicants
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters:
^ Name ^ ^ Description ^
| ''institution'' | **Required** | A valid institution ID in DreamApply (see the ''/api/institutions'' calls to learn it). |
| ''type'' | **Required** | Course type code (undergraduate, postgraduate, etc). Make a call to [[api:api_classificators|/api/classificators]] or use DreamApply GUI tools (System -> Classificators) to learn possible ''Course type'' classificator values.  |
| ''name'' | Optional | Up to 2048 characters. |
| ''awards_abbr'' | Optional | Abbreviation of the award (BSc, MSc, etc). |
```

--------------------------------

### GET HEAD /api/applicants/ID/emails/ID/attachments

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of attachments for an email. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/emails/{ID}/attachments

### Description
Get a list of attachments of an email.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/emails/{ID}/attachments

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Email identifier

### Request Example
{}

### Response
#### Success Response (200)
- **attachments** (array) - List of attachments

#### Response Example
{
  "attachments": []
}

```

--------------------------------

### DreamApply API: Response Headers Examples

Source: https://docs.dreamapply.com/doku_do=diff&id=api%3Aapi_applications&rev=1464793357

Provides examples of response headers for application-related resources in the DreamApply API. These headers act as links to other API calls, allowing for expanded data retrieval.

```json
"offers": "/api/applications/16/offers",
"exports": "/api/applications/16/exports",
"documents": "/api/applications/16/documents",
"studyplans": "/api/applications/16/studyplans"
```

--------------------------------

### cURL Example Request

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743199827

An example of how to make an API request using cURL, including the necessary 'Authorization' header and the target URL. This demonstrates a practical implementation of API authentication for fetching institution data.

```bash
curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
# Optional: add "| python -m json.tool" to prettify JSON output.
```

--------------------------------

### GET HEAD /api/applications/ID/courses/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a course and application association. Supports GET and HEAD methods.

```APIDOC
## GET /api/applications/{ID}/courses/{ID}

### Description
Get information about a course and application association.

### Method
GET, HEAD

### Endpoint
/api/applications/{ID}/courses/{ID}

### Parameters
#### Path
```

--------------------------------

### POST /api/courses

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1404253532&rev2%5B1%5D=1722340208

Creates a new blank course in DreamApply. This is useful for bulk importing course data from external systems. It's recommended to create basic course entries here and then use the DreamApply GUI for detailed configuration.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course. Useful for automatically importing a list of courses from another system into DreamApply. It is recommended to import a "basic list" of courses and then fine-tune them using the DreamApply GUI.

The URI for the new course is returned in the 'Location' header.

### Method
POST

### Endpoint
/api/courses

### Parameters
#### Query Parameters
* **institution** (integer) - Required - A valid institution ID in DreamApply.
* **type** (string) - Required - Course type code (e.g., undergraduate, postgraduate). Refer to `/api/classificators` for possible values.
* **mode** (string) - Required - Course mode code (e.g., full time, part time). Refer to `/api/classificators` for possible values.
* **name** (string) - Required - Up to 2048 characters.
* **awards_abbr** (string) - Optional - Abbreviation of the award (e.g., BSc, MSc).
* **awards_full** (string) - Optional - Full name of the award (e.g., "Bachelor of Science"). Up to 2048 characters.
* **language** (string) - Optional - Accepts a 2-letter (alpha-2) ISO language code.
* **country** (string) - Optional - Accepts an ISO 3166-1 alpha-2 country code.
* **location** (string) - Optional - The location where studies take place. Up to 256 characters.
* **code** (string) - Optional - Unique identifier for the course in another system. Up to 128 characters.
* **prospect_uri** (string) - Optional - An URL for more course information.

### Request Example
```json
{
  "institution": 123,
  "type": "UG",
  "mode": "FT",
  "name": "Sample Top-Up Course",
  "language": "en",
  "country": "EE",
  "location": "Tallinn"
}
```

### Response
#### Success Response (201 Created)
- **Location** (string) - The URI of the newly created course (e.g., /api/courses/12345).

#### Response Example (Headers)
```
Content-Type: application/json
Content-Length: 0
Location: /api/courses/12345
```

#### Error Response (422 Unprocessable Entity)
- **message** (string) - Description of validation errors.
```

--------------------------------

### GET HEAD /api/applicants/ID/notes/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific applicant note. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/notes/{ID}

### Description
Get information about a specific applicant note.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/notes/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Note identifier

### Request Example
{}

### Response
#### Success Response (200)
- **note** (object) - Note details

#### Response Example
{
  "note": {}
}

```

--------------------------------

### GET HEAD /api/applicants/ID/wishes/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about an applicant wishlist item. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/wishes/{ID}

### Description
Get information about an applicant wishlist item.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/wishes/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Wish identifier

### Request Example
{}

### Response
#### Success Response (200)
- **wish** (object) - Wish details

#### Response Example
{
  "wish": {}
}

```

--------------------------------

### API Call Guidelines

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743687123

General guidelines for interacting with the DreamApply API, including information on HEAD vs. GET requests, compression, filtering parameters, and resource ID usage.

```APIDOC
## API Call Guidelines

This section outlines general practices and conventions for utilizing the DreamApply API.

### HEAD vs. GET Requests
- `HEAD` and `GET` requests have identical syntax and responses, with `HEAD` omitting the response body.
- `HEAD` requests are suitable for checking resource existence, size, or metadata without transferring the full data.

### Data Compression
- The API may utilize compression, meaning the `Content-Length` header might not reflect the actual transmitted data size.
- Resource sizes reported by `HEAD` requests are uncompressed.

### Filtering Parameters
- Parameters starting with `by..` are used for filtering (e.g., `byStatuses`).
- Lists in filtering parameters can be comma or space-separated and use logical OR operators.
- Filtering parameters themselves are combined using logical `AND` operators.

### Resource ID Usage
- Resource IDs (e.g., applicant ID `123`) are typically used as keys in JSON objects when enumerating resources (e.g., `/api/applicants`).
- Example: `/api/applicants` might return `{"123": { .. applicant properties .. }, ...}`.
- Individual resources can be accessed using their ID, e.g., `/api/applicants/123`.
```

--------------------------------

### API Version Management

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743200438

Guidelines for managing API versions and ensuring backward compatibility in DreamApply.

```APIDOC
## API Versioning Policy

### Description
DreamApply uses versioned APIs to maintain backward compatibility while introducing new features. API versions are incremented only when breaking changes occur.

### Version Support Status
| Version | Status           |
|---------|------------------|
| 1       | Deprecated       |
| 2       | Deprecated       |
| 3       | Supported (default) |
| 4       | Supported        |
| 5       | Supported (latest, recommended) |
| 6       | Not yet released |

### Version Usage Examples
#### Request with specific version
```
GET /api/v3/applicants/123/photo
```

#### Request without version (uses latest)
```
GET /api/applicants/123/photo
```

### Recommendations
- Always prefix queries with the current API version for stable interface
- Increment version number to unlock new features
- Version number defines the interface - omitted versions use "bleeding edge"

### Check Current Version
```
GET /api/version
```
```

--------------------------------

### GET HEAD /api/applicants/ID/trackers

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of tracker associations for an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/trackers

### Description
Get a list of tracker associations.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/trackers

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **trackers** (array) - List of tracker associations

#### Response Example
{
  "trackers": []
}

```

--------------------------------

### Application Statuses and Offer Types

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743200438

Endpoints for retrieving lists of application statuses and offer types.

```APIDOC
## GET HEAD /api/applications/statuses

### Description
Gets a list of all application statuses.

### Method
GET HEAD

### Endpoint
/api/applications/statuses

### Response
#### Success Response (200)
- **statuses** (array) - A list of application statuses.

## GET HEAD /api/applications/offers/types

### Description
Gets a list of all offer types.

### Method
GET HEAD

### Endpoint
/api/applications/offers/types

### Response
#### Success Response (200)
- **offer_types** (array) - A list of available offer types.
```

--------------------------------

### GET HEAD /api/applicants/ID/emails

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of emails sent to an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/emails

### Description
Get a list of emails that are sent to an applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/emails

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **emails** (array) - List of emails

#### Response Example
{
  "emails": []
}

```

--------------------------------

### GET HEAD /api/applicants/ID/consents

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get a list of consents associated with an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/consents

### Description
Get a list of consents that are associated with an applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/consents

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier

### Request Example
{}

### Response
#### Success Response (200)
- **consents** (array) - List of consents

#### Response Example
{
  "consents": []
}

```

--------------------------------

### GET HEAD /api/applications/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get the application contents (data input by the application). Supports GET and HEAD methods.

```APIDOC
## GET /api/applications/{ID}

### Description
Get the application contents (data input by the application).

### Method
GET, HEAD

### Endpoint
/api/applications/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Application identifier

### Request Example
{}

### Response
#### Success Response (200)
- **application** (object) - Application data

#### Response Example
{
  "application": {}
}

```

--------------------------------

### POST /api/courses

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1743199952

Creates a new blank course. Use this endpoint to add a new course to the system.

```APIDOC
## POST /api/courses

### Description
Creates a new blank course.

### Method
POST

### Endpoint
/api/courses

### Request Body
- **name** (string) - Required - The name of the new course.
- **institution_id** (string) - Required - The ID of the institution offering the course.

### Request Example
{
  "name": "New Course",
  "institution_id": "inst1"
}

### Response
#### Success Response (201)
- **course** (object) - The newly created course object.

#### Response Example
{
  "course": {
    "id": "course2",
    "name": "New Course"
  }
}
```

--------------------------------

### API Versioning Examples

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1749475796

Examples demonstrating how to specify API versions in requests, including using a specific version, omitting the version, and querying the current API version.

```APIDOC
## API Versioning Examples

### Using a Specific API Version
To use a specific API version (e.g., v3), prefix your endpoint with `/api/v<version>`.

### Method
GET

### Endpoint
`/api/v3/applicants/{id}/photo`

### Query Parameters
None

### Request Example
```http
GET /api/v3/applicants/123/photo
```

### Using the Latest API Version (Default)
If the version number is omitted, the latest version of the API is used. Be aware that deprecated endpoints will result in an error.

### Method
GET

### Endpoint
`/api/applicants/{id}/photo`

### Query Parameters
None

### Request Example
```http
GET /api/applicants/123/photo
```

### Querying the Current API Version
To check the current API version, use the `/api/version` endpoint.

### Method
GET

### Endpoint
`/api/version`

### Query Parameters
None

### Request Example
```http
GET /api/version
```
```

--------------------------------

### GET HEAD /api/applicants/ID/trackers/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific tracker set on an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/trackers/{ID}

### Description
Get information about a specific tracker set on an applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/trackers/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Tracker identifier

### Request Example
{}

### Response
#### Success Response (200)
- **tracker** (object) - Tracker details

#### Response Example
{
  "tracker": {}
}

```

--------------------------------

### POST /api/applicants Request Example

Source: https://docs.dreamapply.com/doku_difftype=sidebyside&do=diff&id=api%3Aapi_courses&rev2%5B0%5D=1406154370&rev2%5B1%5D=1589214707

Demonstrates how to make a POST request to create a new course in DreamApply. It includes required and optional parameters for course configuration, such as institution, type, name, and award details. The response includes a 'Location' header with the URI of the newly created course.

```http
POST /api/applicants
Host: apply.example.edu
Authorization: DREAM apikey="..."
Content-Type: application/json

{
  "institution": "/api/institutions/1",
  "type": "undergraduate",
  "name": "Computer Science",
  "awards_abbr": "BSc",
  "mode": "full time",
  "language": "en",
  "country": "US",
  "location": "New York",
  "code": "CS101",
  "prospect_uri": "http://example.edu/courses/cs"
}
```

--------------------------------

### GET HEAD /api/applicants/ID/emails/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific email sent to an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/emails/{ID}

### Description
Get information about a specific email sent to an applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/emails/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Email identifier

### Request Example
{}

### Response
#### Success Response (200)
- **email** (object) - Email details

#### Response Example
{
  "email": {}
}

```

--------------------------------

### API Versioning Examples

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1754906046

Examples demonstrating how to specify API versions in your requests, including using a specific version, omitting the version, and querying the current API version.

```APIDOC
## API Versioning

### Specifying a Specific API Version

To use a specific API version, prepend `/v<version_number>` to your endpoint.

**Method:** GET
**Endpoint:** `/api/v3/applicants/{id}/photo`

### Using the Latest API Version

If the version number is omitted, the latest supported API version is used.

**Method:** GET
**Endpoint:** `/api/applicants/{id}/photo`

### Querying the Current API Version

To determine the current API version, issue the following request:

**Method:** GET
**Endpoint:** `/api/version`

### Supported API Versions

*   **1:** Deprecated
*   **2:** Deprecated
*   **3:** Supported (default)
*   **4:** Supported
*   **5:** Supported
*   **6:** Supported (latest, recommended)

### Versioning Strategy

API version numbers are incremented only for backwards-incompatible changes or significant changes to semantics or data structure. Backwards compatibility is a priority, and previous versions will remain available for a limited time if compatibility is broken. Clients not aware of changes in newer versions will not be disrupted.
```

--------------------------------

### GET HEAD /api/applicants/ID/consents/ID

Source: https://docs.dreamapply.com/doku_id=api%3Amanual&rev=1756728318

Get information about a specific consent associated with an applicant. Supports GET and HEAD methods.

```APIDOC
## GET /api/applicants/{ID}/consents/{ID}

### Description
Get information about a specific consent associated with an applicant.

### Method
GET, HEAD

### Endpoint
/api/applicants/{ID}/consents/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - Applicant identifier
- **ID** (string) - Required - Consent identifier

### Request Example
{}

### Response
#### Success Response (200)
- **consent** (object) - Consent details

#### Response Example
{
  "consent": {}
}

```
Tokens:
Raw