Differences

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

Link to this comparison view

api:api_applicants_trackers_code [2014/06/25 16:16] – created Lauri Elevantapi:api_applicants_trackers_code [2014/06/26 19:19] (current) – removed Lauri Elevant
Line 1: Line 1:
-====== /api/applicants/trackers/CODE ====== 
- 
-===== HEAD, GET ===== 
- 
-Use the ''HEAD'' verb to test if this tracker code (in this example we assume tracer code ''CODE'' but it can be anything) exists. A request with the ''GET'' verb returns some additional information about the tracker (e.g created date, notes etc.). 
- 
-==== Syntax ==== 
- 
-  GET /api/applicants/trackers/CODE 
-  Host: apply.example.edu 
-  Authorization: DREAM apikey="..." 
- 
-==== Response headers ==== 
- 
-  Content-Type: application/json 
-  Content-Length: 1234 
- 
-==== Response codes ==== 
- 
-| ''200 OK'' | The tracker exists | 
-| ''404 Not Found'' | The tracker does not exist | 
- 
- 
-===== DELETE ===== 
- 
-Remove the tracker code from the system, also removing it from all applicants. 
- 
-==== Syntax ==== 
- 
-  DELETE /api/applicants/trackers/CODE 
-  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 |