Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
api:manual [2020/05/11 15:51] – Reference code calls Lauri Elevant | api:manual [2021/11/17 15:53] – [List of API calls] Lauri Elevant |
---|
| [[api:/api/applications/ID/offers|/api/applications/ID/offers]] | C | GET HEAD | List offers created for this application | | | [[api:/api/applications/ID/offers|/api/applications/ID/offers]] | C | GET HEAD | List offers created for this application | |
| [[api:/api/applications/ID/offers/ID|/api/applications/ID/offers/ID]] | R | GET HEAD | Get information about a specific application offer | | | [[api:/api/applications/ID/offers/ID|/api/applications/ID/offers/ID]] | R | GET HEAD | Get information about a specific application offer | |
| | [[api:/api/applications/ID/offers/ID|/api/applications/ID/offers/ID]] | R | POST | Confirm an 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 | 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/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/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/studyplans|/api/applications/ID/studyplans]] | C | GET HEAD | Get a list of study plans attached to 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/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/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 | |
| [[api:/api/institutions/ID/departments/ID|/api/institutions/ID/departments/ID]] | R | GET HEAD | Show information about a given institution department | | | [[api:/api/institutions/ID/departments/ID|/api/institutions/ID/departments/ID]] | R | GET HEAD | Show information about a given institution department | |
| [[api:/api/courses|/api/courses]] | C | GET HEAD | List courses using filters set as parameters | | | [[api:/api/courses|/api/courses]] | C | GET HEAD | List courses using filters set as parameters | |
| | [[api:/api/courses|/api/courses]] | C | POST | Create a new blank course | |
| [[api:/api/courses/ID|/api/courses/ID]] | R | GET HEAD | More detailed information about a specific course | | | [[api:/api/courses/ID|/api/courses/ID]] | R | GET HEAD | More detailed information about a specific course | |
| [[api:/api/intakes|/api/intakes]] | R | GET HEAD | List configured intakes | | | [[api:/api/intakes|/api/intakes]] | R | GET HEAD | List configured intakes | |
| [[api:/api/intakes/ID|/api/intakes/ID]] | R | GET HEAD | Get details of a specific intake | | | [[api:/api/intakes/ID|/api/intakes/ID]] | R | GET HEAD | Get details of a specific intake | |
| [[api:/api/invoices|/api/invoices]] | C | GET HEAD | List all issued invoices | | | [[api:/api/invoices|/api/invoices]] | C | GET HEAD | List all issued invoices | |
| [[api:/api/invoices/ID|/api/invoices/ID]] | R | GET HEAD | Get more information about an invoices | | | [[api:/api/invoices/ID|/api/invoices/ID]] | R | GET HEAD | Get more information about an invoice | |
| [[api:/api/invoices/ID|/api/invoices/ID]] | R | DELETE | Delete an invoice | | | [[api:/api/invoices/ID|/api/invoices/ID]] | R | DELETE | Delete an invoice | |
| | [[api:/api/invoices/ID/transactions|/api/invoices/ID/transactions]] | C | GET HEAD | List transactions of a specific invoice | |
| | [[api:/api/invoices/ID/transactions|/api/invoices/ID/transactions]] | C | POST | Create transaction for invoice ("collect invoice") | |
| | [[api:/api/invoices/ID/transactions/ID|/api/invoices/ID/transactions/ID]] | R | GET HEAD | Get more information about a transaction | |
| [[api:/api/invoices/series|/api/invoices/series]] | R | GET HEAD | List invoice series | | | [[api:/api/invoices/series|/api/invoices/series]] | R | GET HEAD | List invoice series | |
| | [[api:/api/invoices/transactions|/api/invoices/transactions]] | C | GET HEAD | List transactions | |
| | [[api:/api/invoices/transactions/ID|/api/invoices/transactions/ID]] | R | GET HEAD | Get more information about a transaction | |
| [[api:/api/academic-terms|/api/academic-terms]] | R | GET HEAD | Get a list of all academic terms configured | | | [[api:/api/academic-terms|/api/academic-terms]] | R | GET HEAD | Get a list of all academic terms configured | |
| [[api:/api/academic-terms/ID|/api/academic-terms/ID]] | R | GET HEAD | Get information about an academic term | | | [[api:/api/academic-terms/ID|/api/academic-terms/ID]] | R | GET HEAD | Get information about an academic term | |
| [[api:/api/scoresheets|/api/scoresheets]] | C | GET HEAD | List all scoresheets | | | [[api:/api/scoresheets|/api/scoresheets]] | C | GET HEAD | List all scoresheets | |
| [[api:/api/scoresheets/ID|/api/scoresheets/ID]] | R | GET HEAD | Get info about scoresheet | | | [[api:/api/scoresheets/ID|/api/scoresheets/ID]] | R | GET HEAD | Get info about scoresheet | |
| [[api:/api/scoresheets/ID/scores|/api/scoresheets/ID/scores]] | R | GET HEAD | Get scores | | | [[api:/api/scoresheets/ID/scores|/api/scoresheets/ID/scores]] | C | GET HEAD | Get scores | |
| | [[api:/api/scoresheets/ID/scores|/api/scoresheets/ID/scores]] | C | POST | Append an application for scoring | |
| | [[api:/api/scoresheets/ID/scores/ID|/api/scoresheets/ID/scores/ID]] | R | GET HEAD | Get information about a score | |
| | [[api:/api/scoresheets/ID/scores/ID/points|/api/scoresheets/ID/scores/ID/points]] | R | GET HEAD | Get the points of a scoresheet score | |
| | [[api:/api/scoresheets/ID/scores/ID/points|/api/scoresheets/ID/scores/ID/points]] | R | PUT | Set the points of a scoresheet score | |
| | [[api:/api/scoresheets/ID/scores/ID/points|/api/scoresheets/ID/scores/ID/points]] | R | DELETE | Clear the points of a scoresheet score | |
| | [[api:/api/scoresheets/ID/scores/ID/comments|/api/scoresheets/ID/scores/ID/comments]] | R | GET HEAD | Get the comments of a scoresheet score | |
| | [[api:/api/scoresheets/ID/scores/ID/comments|/api/scoresheets/ID/scores/ID/comments]] | R | PUT | Set the comments of a scoresheet score | |
| | [[api:/api/scoresheets/ID/scores/ID/comments|/api/scoresheets/ID/scores/ID/comments]] | R | DELETE | Clear the comments of a scoresheet score | |
| [[api:/api/tableviews|/api/tableviews]] | C | GET HEAD | List all tableviews created with the GUI | | | [[api:/api/tableviews|/api/tableviews]] | C | GET HEAD | List all tableviews created with the GUI | |
| [[api:/api/tableviews/ID|/api/tableviews/ID]] | R | GET HEAD | Get more information about a tableview | | | [[api:/api/tableviews/ID|/api/tableviews/ID]] | R | GET HEAD | Get more information about a tableview | |
| [[api:/api/administrators|/api/administrators]] | R | GET HEAD | List all administrators in the system | | | [[api:/api/administrators|/api/administrators]] | R | GET HEAD | List all administrators in the system | |
| [[api:/api/administrators/ID|/api/administrators/ID]] | R | GET HEAD | Get information about an administrator | | | [[api:/api/administrators/ID|/api/administrators/ID]] | R | GET HEAD | Get information about an administrator | |
| | [[api:/api/ping|/api/ping]] | R | GET HEAD | A dummy call for testing authentication | |
| |
♦ The types are as follows: **C**ollection, **R**esource, **A**ssociation. The latter is an object that represents the relationship between two resources. It is used on one-to-many and many-to-many relationships. However, an association between an applicant and a tracker may carry some information itself, such as the time the association was established. Thus is a special kind of resource. | ♦ The types are as follows: **C**ollection, **R**esource, **A**ssociation. The latter is an object that represents the relationship between two resources. It is used on one-to-many and many-to-many relationships. However, an association between an applicant and a tracker may carry some information itself, such as the time the association was established. Thus is a special kind of resource. |