Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
api:api_applicants_id_trackers_id [2014/07/11 09:31] – [HEAD, GET] Lauri Elevantapi:api_applicants_id_trackers_id [2021/01/21 12:51] – external edit 127.0.0.1
Line 3: Line 3:
 ===== HEAD, GET ===== ===== HEAD, GET =====
  
-Use the ''HEAD'' verb to test if the applicant in question has this tracker. A request with the ''GET'' verb returns some additional information about the tracker (e.g created date, notes etc.).+Use the ''HEAD'' verb to test if the applicant in question has this tracker. A request with the ''GET'' verb returns some additional information about the tracker association (date assigned etc.).
  
 **Note that this will not return the tracker itself**, but rather represents the relationships between the applicant and the tracker. Follow the tracker URI in the response to retrieve further information about the tracker in question. **Note that this will not return the tracker itself**, but rather represents the relationships between the applicant and the tracker. Follow the tracker URI in the response to retrieve further information about the tracker in question.
Line 21: Line 21:
  
 | ''200 OK'' | The tracker is set | | ''200 OK'' | The tracker is set |
-| ''404 Not Found'' | The tracker was not set |+| ''404 Not Found'' | The tracker does not exist | 
 +| ''404 Not Found'' | The tracker was not set to this applicant |
  
-==== Example response ====+==== Response example ====
  
   {   {
Line 32: Line 33:
 ===== PUT ===== ===== PUT =====
  
-Set a tracker code to the applicant in question. **This requires that the tracker 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. +Set a tracker to the applicant in question. **This requires that the tracker already exists.** Use ''POST'' [[api:api_applicants_trackers|/api/applicants/trackers]] to create a tracker first, then this API call will allow you to ''PUT'' the tracker (identified by it's code) to any number of applicants. 
  
 In other words, this will not create a new tracker, but create a relationship (association) between an existing tracker and an applicant. In other words, this will not create a new tracker, but create a relationship (association) between an existing tracker and an applicant.
Line 49: Line 50:
  
 | ''204 No Content'' | Tracker was successfully set | | ''204 No Content'' | Tracker was successfully set |
-| ''404 Not Found'' | Tracker was not found |+| ''404 Not Found'' | The tracker does not exist |
  
  
Line 69: Line 70:
  
 | ''204 No Content'' | Tracker was successfully deleted | | ''204 No Content'' | Tracker was successfully deleted |
 +| ''404 Not Found'' | The tracker does not exist |
 +| ''404 Not Found'' | The tracker was not set to this applicant |
 +
api/api_applicants_id_trackers_id.txt · Last modified: 2023/03/08 20:56 by Lauri Elevant


  • Show page
  • Old revisions