Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
api:manual [2018/11/16 18:04] – [List of API calls] Lauri Elevant | api:manual [2019/04/02 11:08] – [Throttling] Anton Smirnov |
---|
| [[api:/api/applicants/ID/consents|/api/applicants/ID/consents]] | C | GET HEAD | Get a list of consents that are associated with an applicant | | | [[api:/api/applicants/ID/consents|/api/applicants/ID/consents]] | C | GET HEAD | Get a list of consents that are associated with an applicant | |
| [[api:/api/applicants/ID/consents/ID|/api/applicants/ID/consents/ID]] | A | GET HEAD | Get information about a specific consent associated with an applicant | | | [[api:/api/applicants/ID/consents/ID|/api/applicants/ID/consents/ID]] | A | GET HEAD | Get information about a specific consent associated with an applicant | |
| | [[api:/api/applicants/ID/emails|/api/applicants/ID/emails]] | C | GET HEAD | Get a list of emails that are sent to an applicant | |
| | [[api:/api/applicants/ID/emails/ID|/api/applicants/ID/emails/ID]] | A | GET HEAD | Get information about a specific emails sent to an applicant | |
| [[api:/api/applicants/ID/trackers|/api/applicants/ID/trackers]] | C | GET HEAD | Get a list of tracker associations | | | [[api:/api/applicants/ID/trackers|/api/applicants/ID/trackers]] | C | GET HEAD | Get a list of tracker associations | |
| [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | GET HEAD | Get information about a specific tracker set on an applicant | | | [[api:/api/applicants/ID/trackers/ID|/api/applicants/ID/trackers/ID]] | A | GET HEAD | Get information about a specific tracker set on an applicant | |
| [[api:/api/applications/ID/documents|/api/applications/ID/documents]] | C | GET HEAD | Get a list of documents attached to this application | | | [[api:/api/applications/ID/documents|/api/applications/ID/documents]] | C | GET HEAD | Get a list of documents attached to this application | |
| [[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/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/reports|/api/reports]] | C | GET HEAD | List all reports available | | | [[api:/api/reports|/api/reports]] | C | GET HEAD | List all reports available | |
| [[api:/api/reports/ReportName|/api/reports/ReportName]] | R | GET HEAD | Request data from a specific report | | | [[api:/api/reports/ReportName|/api/reports/ReportName]] | R | GET HEAD | Request data from a specific report | |
| | [[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/scores|/api/scoresheets/ID/scores]] | R | GET HEAD | Get scores | |
| [[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 | |
===== Throttling ===== | ===== Throttling ===== |
| |
All API calls placed to the same API key are, by default, limited to **60 queries per minute** and **600 queries per hour**. Please note that 60 queries/minute is not the same as 1 query per second, see below. | All API calls placed to the same API key are, by default, limited to **180 queries per minute** and **600 queries per hour**. Please note that 60 queries/minute is not the same as 1 query per second, see below. |
| |
If you exceed your API key queries-per-minute quota, you may start to receive ''429 Too Many Requests'' responses. This means that the request was **not** processed and will have to be issued again. | If you exceed your API key queries-per-minute quota, you may start to receive ''429 Too Many Requests'' responses. This means that the request was **not** processed and will have to be issued again. |