This is an old revision of the document!
/api/applicants/ID/trackers/ID
HEAD, GET
Use the HEAD
verb to test if the applicant in question has this tracker code. A request with the GET
verb returns some additional information about the tracker (e.g created date, notes etc.).
Syntax
GET /api/applicants/123/trackers/1 Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234
Response codes
200 OK | The tracker is set |
404 Not Found | The tracker was not set |
PUT
Set a tracker code to the applicant in question. This requires that the tracker code already exists. Use POST
to create a tracker code first, then this API call will allow you to PUT
the tracker (identified by it's code) to any number of applicants.
Syntax
PUT /api/applicants/123/trackers/1 Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: text/plain Content-Length: 0
Response codes
204 No Content | Tracker was successfully set |
404 Not Found | Tracker was not found |
DELETE
Remove the tracker code from the applicant in question.
Syntax
HEAD /api/applicants/123/trackers/1 Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: text/plain Content-Length: 0
Response codes
204 No Content | Tracker was successfully deleted |