This is an old revision of the document!
List applicants using the filters set as parameters. The number of applicants is represented in the
X-Count header - use the
HEAD request to simply count the number of applicants matching the filters. Use the
GET request to actually fetch them.
GET /api/applicants Host: apply.example.edu Authorization: DREAM apikey="..."
| ||Optional||List of ISO 3166-1 alpha-2 country codes|||
| ||Optional||List of tracker ID-s|| |
| ||Optional||List of tracker codes|| |
- Note : Lists can be either comma or space separated. All list items are combined with logical
ORoperators - in other words an application is considered matching if it matches to any of the values in the list.
- Note : you may use either tracker ID-s or codes to reference trackers. However ID-s are guaranteed not to change while the tracker codes offer no such guarantee.
Content-Type: application/json Content-Length: 1456 X-Count: 15
| ||On or the filters has bad parameters (see error description)|