API reference
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
This list is intended only to give a broad overview of the available API requests. Click the links below to read detailed information regarding each API request.
Journal
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/journal | R | GET, HEAD | List journal events. Start point for many integrations |
Applicants
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/applicants | C | GET, HEAD | List applicants using filters set as parameters |
/api/v9/applicants | C | POST | Create a new applicant / lead and send welcome letter |
/api/v9/applicants/ID | R | GET, HEAD | Return information about an applicant |
/api/v9/applicants/ID/photo | R | GET, HEAD | Get the applicant's photo |
/api/v9/applicants/ID/consents | C | GET, HEAD | Get a list of consents that are associated with an applicant |
/api/v9/applicants/ID/consents/ID | A | GET, HEAD | Get information about a specific consent associated with an applicant |
/api/v9/applicants/ID/emails | C | GET, HEAD | Get a list of emails that are sent to an applicant |
/api/v9/applicants/ID/emails/ID | A | GET, HEAD | Get information about a specific emails sent to an applicant |
/api/v9/applicants/ID/emails/ID/attachments | C | GET, HEAD | Get a list of attachments of an email |
/api/v9/applicants/ID/emails/ID/attachments/ID | A | GET, HEAD | Download a specific attachment (binary data) |
/api/v9/applicants/ID/trackers | C | GET, HEAD | Get a list of tracker associations |
/api/v9/applicants/ID/trackers/ID | A | GET, HEAD | Get information about a specific tracker set on an applicant |
/api/v9/applicants/ID/trackers/ID | A | PUT | Set a tracker code to the applicant in question |
/api/v9/applicants/ID/trackers/ID | A | DELETE | Remove the tracker code from the applicant in question |
/api/v9/applicants/ID/invoices | C | GET, HEAD | List invoices for this applicant |
/api/v9/applicants/ID/invoices/ID | R | GET, HEAD | Get information about an applicant invoice |
/api/v9/applicants/ID/wishes | C | GET, HEAD | Get the applicant's wishlist |
/api/v9/applicants/ID/wishes/ID | R | GET, HEAD | Get information about an applicant wishlist item |
/api/v9/applicants/ID/applications | C | GET, HEAD | List applications for this applicant |
/api/v9/applicants/ID/applications | C | POST | Create an application with minimal initial data |
/api/v9/applicants/ID/applications/ID | R | GET, HEAD | Get information about an applicant application |
/api/v9/applicants/ID/reference | R | GET, HEAD | Get the reference code for this applicant |
/api/v9/applicants/ID/reference | R | PUT | Store a new reference code for this applicant |
/api/v9/applicants/ID/matriculation | R | GET, HEAD | Get the matriculation number for this applicant |
/api/v9/applicants/ID/matriculation | R | PUT | Store a new matriculation number for this applicant |
/api/v9/applicants/ID/notes | R | GET, HEAD | Get the notes on the applicant |
/api/v9/applicants/ID/notes | R | POST | Create a new applicant note |
/api/v9/applicants/ID/notes/ID | R | GET, HEAD | Get information about a specific applicant note |
/api/v9/applicants/ID/notes/ID | R | PUT | Update a specific applicant note |
/api/v9/applicants/consents | C | GET, HEAD | Get a list of all consents |
/api/v9/applicants/consents/ID | R | GET, HEAD | Get information about a specific consent |
/api/v9/applicants/trackers | C | GET, HEAD | Get a list of all trackers |
/api/v9/applicants/trackers | C | POST | Create a new tracker |
/api/v9/applicants/trackers/ID | R | GET, HEAD | Get information about a specific tracker |
/api/v9/applicants/trackers/ID | R | DELETE | Delete a tracker, removing it from all applicants |
Applications
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/applications | C | GET, HEAD | Get a list of applications that match the set filtering criterion |
/api/v9/applications | C | POST | Create an application with minimal initial data |
/api/v9/applications/ID | R | GET, HEAD | Get the application contents (data input by the application) |
/api/v9/applications/ID | R | PATCH | Update specific application contents |
/api/v9/applications/ID/freeze | R | POST | Freeze the application data |
/api/v9/applications/ID/unfreeze | R | POST | Unfreeze the application data |
/api/v9/applications/ID/close | R | POST | Close an application |
/api/v9/applications/ID/courses | C | GET, HEAD | List courses that have been added to this application |
/api/v9/applications/ID/courses | C | POST | Add a course to the application |
/api/v9/applications/ID/courses/ID | A | GET, HEAD | Get information about a course and application association |
/api/v9/applications/ID/courses/ID | A | DELETE | Delete a course from the application |
/api/v9/applications/ID/courses/ID/priority | A | GET, HEAD | Get the priority of the course in the application |
/api/v9/applications/ID/courses/ID/priority | A | PUT | Set the priority of the course in the application |
/api/v9/applications/ID/flags | C | GET, HEAD | List all flags assigned to the application in question |
/api/v9/applications/ID/flags/ID | A | GET, HEAD | Get information about a specific flag set to an application |
/api/v9/applications/ID/flags/ID | A | PUT | Set the flag to the application in question |
/api/v9/applications/ID/flags/ID | A | DELETE | Remove the flag from the application in question |
/api/v9/applications/ID/offers | C | GET, HEAD | List offers created for this application |
/api/v9/applications/ID/offers/ID | R | GET, HEAD | Get information about a specific application offer |
/api/v9/applications/ID/offers/ID/type | R | GET, HEAD | Get the offer type of a specific application offer |
/api/v9/applications/ID/offers/ID/type | R | PUT | Set the offer type of the application offer in question |
/api/v9/applications/ID/offers/ID/subject | R | GET, HEAD | Get the subject line of a specific application offer |
/api/v9/applications/ID/offers/ID/subject | R | PUT | Set the subject line of the application offer in question |
/api/v9/applications/ID/offers/ID/comments | R | GET, HEAD | Get the offer letter text/comments of a specific application offer |
/api/v9/applications/ID/offers/ID/comments | R | PUT | Set the offer letter text/comments of the application offer in question |
/api/v9/applications/ID/offers/ID/attachments | R | GET, HEAD | Get the offer attachments |
/api/v9/applications/ID/offers/ID/attachments/ID | R | GET, HEAD | Get an offer attachment |
/api/v9/applications/ID/offers/ID/attachments/ID/download | R | GET, HEAD | Get an offer attachment (the binary blob) |
/api/v9/applications/ID/offers/ID/letters | R | GET, HEAD | Get the offer letters |
/api/v9/applications/ID/offers/ID/letters/ID | R | POST | Generate an offer letter |
/api/v9/applications/ID/offers/ID/letters/ID | R | GET, HEAD | Get an offer letter |
/api/v9/applications/ID/offers/ID/confirm | R | POST | Confirm an offer |
/api/v9/applications/ID/offers/ID/decision | R | GET, HEAD | Get the decision of a specific application offer |
/api/v9/applications/ID/offers/ID/decision | R | PUT | Set the decision of the application offer in question |
/api/v9/applications/ID/offers/ID/notes | R | GET, HEAD | Get the notes on the offer |
/api/v9/applications/ID/offers/ID/notes | R | POST | Create a new offer note |
/api/v9/applications/ID/offers/ID/notes/ID | R | GET, HEAD | Get information about a specific offer note |
/api/v9/applications/ID/offers/ID/notes/ID | R | PUT | Update a specific offer note |
/api/v9/applications/ID/offers/ID/score/extra | R | GET, HEAD | Get the extra score of a specific application offer |
/api/v9/applications/ID/offers/ID/score/extra | R | PUT | Set the extra score of the application offer in question |
/api/v9/applications/ID/offers/ID/score/extra | R | DELETE | Clear the extra score of the application offer in question |
/api/v9/applications/ID/tasks | C | GET, HEAD | List tasks created for this application |
/api/v9/applications/ID/tasks | C | POST | Add a new task to the application |
/api/v9/applications/ID/tasks/ID | R | GET, HEAD | Get information about a specific application task |
/api/v9/applications/ID/tasks/ID | R | DELETE | Delete a specific application task |
/api/v9/applications/ID/tasks/ID/status | R | GET, HEAD | Get the status of a specific application task |
/api/v9/applications/ID/tasks/ID/status | R | PUT | Set the status to the application task in question |
/api/v9/applications/ID/tasks/ID/documents | C | GET, HEAD | Get a list of documents attached to this task |
/api/v9/applications/ID/tasks/ID/documents | C | POST | Upload a new document to a task |
/api/v9/applications/ID/tasks/ID/documents/zip | R | GET, HEAD | Get all documents attached to a task (binary data) |
/api/v9/applications/ID/tasks/ID/documents/ID | R | GET, HEAD | Get a specific document from this task (binary data) |
/api/v9/applications/ID/exports | C | GET, HEAD | List all exports that have been generated from the application in question |
/api/v9/applications/ID/exports/ID | R | GET, HEAD | Fetch a specific application export identified by the export ID |
/api/v9/applications/ID/exports/ID/blobs | C | GET, HEAD | Get a list of the downloadable files (blobs) regarding this export |
/api/v9/applications/ID/exports/ID/blobs/blob | R | GET, HEAD | Retrieve a downloadable file (blob) regarding this export |
/api/v9/applications/ID/documents | C | GET, HEAD | Get a list of documents attached to this application |
/api/v9/applications/ID/documents | C | POST | Upload a new document to this application |
/api/v9/applications/ID/documents/zip | R | GET, HEAD | Get all documents attached to an application (binary data) |
/api/v9/applications/ID/documents/ID | R | GET, HEAD | Get a specific applicant document (binary data) |
/api/v9/applications/ID/scores | C | GET, HEAD | Get a list of scores for this application |
/api/v9/applications/ID/pdf | C | GET, HEAD | Get the PDF printout of this application |
/api/v9/applications/ID/invoices | C | GET, HEAD | List invoices for this application |
/api/v9/applications/ID/invoices | C | POST | Create an invoice for this application |
/api/v9/applications/ID/invoices/ID | R | GET, HEAD | Get information about an application invoice |
/api/v9/applications/ID/references | C | GET, HEAD | List references submitted for the application |
/api/v9/applications/ID/references/ID | R | GET, HEAD | Get information about a reference submitted for the application |
/api/v9/applications/flags | C | GET, HEAD | Get a list of all flags |
/api/v9/applications/flags | C | POST | Create a new flag |
/api/v9/applications/flags/ID | R | GET, HEAD | Get information about a specific flag |
/api/v9/applications/flags/ID | R | DELETE | Delete a flag, removing it from all applications |
/api/v9/applications/statuses | R | GET, HEAD | Get a list of all application statuses |
/api/v9/applications/offers/types | R | GET, HEAD | Get a list of all offer types |
/api/v9/applications/offers/types/id | R | GET, HEAD | Get information about a specific offer type |
Institutions
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/institutions | C | GET, HEAD | List institutions using filters set as parameters |
/api/v9/institutions/ID | R | GET, HEAD | Get more detailed information about a specific institution |
/api/v9/institutions/ID/departments | C | GET, HEAD | List departments under the given institution |
/api/v9/institutions/ID/departments/ID | R | GET, HEAD | Show information about a given institution department |
Courses
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/courses | C | GET, HEAD | List courses using filters set as parameters |
/api/v9/courses | C | POST | Create a new blank course |
/api/v9/courses/ID/ | R | GET, HEAD | Get more detailed information about a specific course |
Intakes
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/intakes | C | GET, HEAD | List configured intakes |
/api/v9/intakes/ID/ | R | GET, HEAD | Get more detailed information about a specific intake |
Invoices
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/invoices | C | GET, HEAD | List all issued invoices |
/api/v9/invoices/ID/ | R | GET, HEAD | Get more detailed information about an invoice |
/api/v9/invoices/ID/ | R | DELETE | Delete an invoice |
/api/v9/invoices/ID/transactions | C | GET, HEAD | List transactions of a specific invoice |
/api/v9/invoices/ID/transactions | C | POST | Create transaction for invoice (collect an invoice) |
/api/v9/invoices/ID/transactions/ID/ | R | GET, HEAD | Get more detailed information about a transaction |
/api/v9/invoices/series | R | GET, HEAD | List invoice series |
/api/v9/invoices/transactions | C | GET, HEAD | List transactions |
/api/v9/invoices/transactions/id/ | R | GET, HEAD | Get more detailed information about a transaction |
Fees
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/fees | C | GET, HEAD | List all available fees |
/api/v9/fees/ID/ | R | GET, HEAD | Get detailed information about a fee |
/api/v9/fees/ID/amounts | C | GET, HEAD | List fee amounts configured for different territories |
/api/v9/fees/ID/amounts/TerritoryName | C | GET, HEAD | Get a fee amount configured for a specific territory |
Academic terms
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/academic-terms | C | GET, HEAD | Get a list of all configured academic terms |
/api/v9/academic-terms/id | R | GET, HEAD | Get information about an academic term |
/api/v9/academic-terms/types | C | GET, HEAD | Get a list of all configured academic term types |
/api/v9/academic-terms/types/ID | R | GET, HEAD | Get information about an academic term type |
Academic years
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/academic-years | C | GET, HEAD | Get a list of all configured academic years |
/api/v9/academic-years/year | R | GET, HEAD | Get information about an academic year |
Classificators
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/classificators | R | GET, HEAD | Get a list of system classificators |
Reports
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/reports | C | GET, HEAD | List all available reports |
/api/v9/reports/ReportName | R | GET, HEAD | Request data from a specific report |
Scoresheets
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/scoresheets | C | GET, HEAD | List all scoresheets |
/api/v9/scoresheets/ID | R | GET, HEAD | Get info about a scoresheet |
/api/v9/scoresheets/ID/scores | C | GET, HEAD | Get scores |
/api/v9/scoresheets/ID/scores | C | POST | Append an application for scoring |
/api/v9/scoresheets/ID/scores/id | R | GET, HEAD | Get information about a score (points & metadata) |
/api/v9/scoresheets/ID/scores/id | R | PUT | Overwrite a score (points & metadata) |
/api/v9/scoresheets/ID/scores/id | R | PATCH | Update a score (points &metadata) |
/api/v9/scoresheets/ID/scores/id/points | R | GET, HEAD | Get the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/points | R | PUT | Set the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/points | R | DELETE | Clear the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | GET, HEAD | Get the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | PUT | Set the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | DELETE | Clear the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | GET, HEAD | Get the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | PUT | Set the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | DELETE | Clear the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | GET, HEAD | Get the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | PUT | Set the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | DELETE | Clear the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | GET, HEAD | Get the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | PUT | Set the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | DELETE | Clear the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | GET, HEAD | Get the subject of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | PUT | Set the subject of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | DELETE | Clear the subject of a scoresheet score |
Tableviews
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/tableviews | C | GET, HEAD | List all tableviews created with the GUI |
/api/v9/tableviews/ID | R | GET, HEAD | Get more information about a tableview |
/api/v9/tableviews/ID/tabledata | R | GET, HEAD | Get the csv data from a tableview |
Administrators
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/administrators | C | GET, HEAD | List all administrators in the system |
/api/v9/administrators/ID | R | GET, HEAD | Get information about an administrator |
Purged resources
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/purged-resources | C | GET, HEAD | Get a list of entities that were deleted from the system |
Ping
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/ping | R | GET, HEAD | Test authentication |
Version
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/version | R | GET, HEAD | Get the current API version |
Return types
The types are as follows:
- Collection
- Resource
- Association
The latter is an object that represents the relationship between two resources. It is used on one-to-many and many-to-many relationships. However, an association between an applicant and a tracker may carry some information itself, such as the time the association was established. Thus it is a special kind of resource.
Where a GET verb is specified, a HEAD verb is also always available.
A HEAD request will return everything that a GET request, except for the return body. See each individual API request for examples where this might be useful: retrieving only a count of items, getting just metadata (saving bandwidth), etc.