This is an old revision of the document!
/api/applicants/trackers
HEAD, GET
Get a list of all tracker codes currently in the system.
Syntax
GET /api/applicants/trackers Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234
POST
Add a new tracker using any text (2 to 16 characters) as the tracker code. If a tracker with this code exists, a 409 Conflict will be returned. You are expected to use the PUT verb to add existing flags to applicants, see /api/applicants/123/trackers/AGENT
In any case, the URI for the tracker created (or the tracker conflicting) is returned in the Location header.
This method simply creates a new tracker, but does not assign it to any applicants. You can later PUT the tracker to any number of applicants using PUT /api/applicants/trackers/AGENT.
Syntax
POST /api/applicants/trackers Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
name | Required | This is the unique tracker code, should be easily recognisable. 2 to 16 characters. |
notes | Required | This text will be used to additionally explain the meaning of the tracker code. 2 to 200 characters. |
Response headers
Content-Type: application/json Content-Length: 0 Location: /api/applicants/trackers/TEST
Response codes
201 Created | New tracker was created |
409 Conflict | A tracker with this code already exists |