Differences

This shows you the differences between two versions of the page.

--- api:api_applicants_123_trackers_agent [2014/06/19 17:00] – created Lauri
+++ api:api_applicants_123_trackers_agent [2014/06/25 16:15] (current) – removed Lauri
@@ Line 1: / Line 1: @@
-====== /api/applicants/123/trackers/AGENT ======
-===== HEAD, GET =====
-Use the ''HEAD'' verb to test if the applicant in question has this tracker code (in this example we assume tracer code ''AGENT'' but it can be anything). 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/AGENT
-  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.
-==== Syntax ====
-  PUT /api/applicants/123/trackers/AGENT
-  Host: apply.example.edu
-  Authorization: DREAM apikey="..."
-==== Response headers ====
-  Content-Type: text/plain
-  Content-Length: 0
-==== Response codes ====
-| ''200 OK'' | Tracker was successfully set |
-===== DELETE =====
-Remove the tracker code from the applicant in question.
-==== Syntax ====
-  HEAD /api/applicants/123/trackers/AGENT
-  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 |