| |
api:manual [2021/11/17 15:55] – [List of API calls] Lauri | api:manual [2024/07/30 11:50] (current) – external edit 127.0.0.1 |
---|
| [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | PUT | Set a tracker code to the applicant in question | | | [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | PUT | Set a tracker code to the applicant in question | |
| [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | DELETE | Remove the tracker code from the applicant in question | | | [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | DELETE | Remove the tracker code from the applicant in question | |
| [[api:/api/applicants/ID/documents|/api/applicants/ID/documents]] | C | GET HEAD | Get a list of documents for the applicant in question | | |
| [[api:/api/applicants/ID/documents/ID|/api/applicants/ID/documents/ID]] | R | GET HEAD | Get a specific applicant document (binary data) | | |
| [[api:/api/applicants/ID/studyplans|/api/applicants/ID/studyplans]] | C | GET HEAD | Get a list of study plans created by this applicant | | |
| [[api:/api/applicants/ID/studyplans/ID|/api/applicants/ID/studyplans/ID]] | R | GET HEAD | Get a specific study plan created by this applicant | | |
| [[api:/api/applicants/ID/invoices|/api/applicants/ID/invoices]] | C | GET HEAD | List invoices for this applicant | | | [[api:/api/applicants/ID/invoices|/api/applicants/ID/invoices]] | C | GET HEAD | List invoices for this applicant | |
| [[api:/api/applicants/ID/invoices/ID|/api/applicants/ID/invoices/ID]] | R | GET HEAD | Get information about an applicant invoice | | | [[api:/api/applicants/ID/invoices/ID|/api/applicants/ID/invoices/ID]] | R | GET HEAD | Get information about an applicant invoice | |
| [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | GET HEAD | Get the reference code for this applicant | | | [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | GET HEAD | Get the reference code for this applicant | |
| [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | PUT | Store a new reference code for this applicant | | | [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | PUT | Store a new reference code for this applicant | |
| | [[api:/api/applicants/ID/matriculation|/api/applicants/ID/matriculation]] | R | GET HEAD | Get the matriculation number for this applicant | |
| | [[api:/api/applicants/ID/matriculation|/api/applicants/ID/matriculation]] | R | PUT | Store a new matriculation number for this applicant | |
| [[api:/api/applicants/consents|/api/applicants/consents]] | C | GET HEAD | Get a list of all consents | | | [[api:/api/applicants/consents|/api/applicants/consents]] | C | GET HEAD | Get a list of all consents | |
| [[api:/api/applicants/consents/ID|/api/applicants/consents/ID]] | R | GET HEAD | Get information about a specific consent | | | [[api:/api/applicants/consents/ID|/api/applicants/consents/ID]] | R | GET HEAD | Get information about a specific consent | |
| [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | GET HEAD | Get information about a specific tracker | | | [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | GET HEAD | Get information about a specific tracker | |
| [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | DELETE | Delete a tracker, removing it from all applicants | | | [[api:/api/applicants/trackers/ID|/api/applicants/trackers/ID]] | R | DELETE | Delete a tracker, removing it from all applicants | |
| | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | GET HEAD | Get the notes on the applicant | |
| | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | PUT | Set the notes box on an applicant card, overwriting existing | |
| | [[api:/api/applicants/ID/notes|/api/applicants/ID/notes]] | R | PATCH | Append to existing applicant notes | |
| [[api:/api/applications|/api/applications]] | C | GET HEAD | Get a list of applications that match the set filtering criterion | | | [[api:/api/applications|/api/applications]] | C | GET HEAD | Get a list of applications that match the set filtering criterion | |
| [[api:/api/applications/ID|/api/applications/ID]] | R | GET HEAD | Get the application contents (data input by the application). | | | [[api:/api/applications/ID|/api/applications/ID]] | R | GET HEAD | Get the application contents (data input by the application). | |
| [[api:/api/applications/ID/offers/ID/type|/api/applications/ID/offers/ID/type]] | R | GET HEAD | Get the offer type of a specific application offer | | | [[api:/api/applications/ID/offers/ID/type|/api/applications/ID/offers/ID/type]] | R | GET HEAD | Get the offer type of a specific application offer | |
| [[api:/api/applications/ID/offers/ID/type|/api/applications/ID/offers/ID/type]] | R | PUT | Set the offer type of the application offer in question | | | [[api:/api/applications/ID/offers/ID/type|/api/applications/ID/offers/ID/type]] | R | PUT | Set the offer type of the application offer in question | |
| | [[api:/api/applications/ID/offers/ID/subject|/api/applications/ID/offers/ID/subject]] | R | GET HEAD | Get the subject line of a specific application offer | |
| | [[api:/api/applications/ID/offers/ID/subject|/api/applications/ID/offers/ID/subject]] | R | PUT | Set the subject line of the application offer in question | |
| | [[api:/api/applications/ID/offers/ID/comments|/api/applications/ID/offers/ID/comments]] | R | GET HEAD | Get the offer letter text/comments of a specific application offer | |
| | [[api:/api/applications/ID/offers/ID/comments|/api/applications/ID/offers/ID/comments]] | R | PUT | Set the offer letter text/comments of the application offer in question | |
| [[api:/api/applications/ID/offers/ID/confirm|/api/applications/ID/offers/ID/confirm]] | R | POST | Confirm an offer | | | [[api:/api/applications/ID/offers/ID/confirm|/api/applications/ID/offers/ID/confirm]] | R | POST | Confirm an offer | |
| [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | GET HEAD | Get the decision of a specific application offer | | | [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | GET HEAD | Get the decision of a specific application offer | |
| [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | PUT | Set the decision of the application offer in question | | | [[api:/api/applications/ID/offers/ID/decision|/api/applications/ID/offers/ID/decision]] | R | PUT | Set the decision of the application offer in question | |
| | [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | GET HEAD | Get the notes on the offer | |
| | [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | PUT | Set the notes box on an offer, overwriting existing | |
| | [[api:/api/applications/ID/offers/ID/notes|/api/applications/ID/offers/ID/notes]] | R | PATCH | Append to existing offer notes | |
| [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | GET HEAD | Get the extra score of a specific application offer | | | [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | GET HEAD | Get the extra score of a specific application offer | |
| [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | PUT | Set the extra score of the application offer in question | | | [[api:/api/applications/ID/offers/ID/score/extra|/api/applications/ID/offers/ID/score/extra]] | R | PUT | Set the extra score of the application offer in question | |
| [[api:/api/applications/ID/documents/ID|/api/applications/ID/documents/ID]] | R | GET HEAD | Get a specific applicant document (binary data) | | | [[api:/api/applications/ID/documents/ID|/api/applications/ID/documents/ID]] | R | GET HEAD | Get a specific applicant document (binary data) | |
| [[api:/api/applications/ID/scores|/api/applications/ID/scores]] | C | GET HEAD | Get a list of scores for this application | | | [[api:/api/applications/ID/scores|/api/applications/ID/scores]] | C | GET HEAD | Get a list of scores for this application | |
| [[api:/api/applications/ID/studyplans|/api/applications/ID/studyplans]] | C | GET HEAD | Get a list of study plans attached to this application | | |
| [[api:/api/applications/ID/studyplans/ID|/api/applications/ID/studyplans/ID]] | R | GET HEAD | Get a specific study plan attached to this application | | |
| [[api:/api/applications/ID/pdf|/api/applications/ID/pdf]] | C | GET HEAD | Get The PDF printout of this application | | | [[api:/api/applications/ID/pdf|/api/applications/ID/pdf]] | C | GET HEAD | Get The PDF printout of this application | |
| | [[api:/api/applications/ID/invoices|/api/applications/ID/invoices]] | C | GET HEAD | List invoices for this application | |
| | [[api:/api/applications/ID/invoices|/api/applications/ID/invoices]] | C | POST | Create an invoice for this application | |
| | [[api:/api/applications/ID/invoices/ID|/api/applications/ID/invoices/ID]] | R | GET HEAD | Get information about an application invoice | |
| [[api:/api/applications/flags|/api/applications/flags]] | C | GET HEAD | Get a list of all flags | | | [[api:/api/applications/flags|/api/applications/flags]] | C | GET HEAD | Get a list of all flags | |
| [[api:/api/applications/flags|/api/applications/flags]] | C | POST | Create a new flag | | | [[api:/api/applications/flags|/api/applications/flags]] | C | POST | Create a new flag | |