Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
api:manual [2018/02/12 17:28] – external edit 127.0.0.1 | api:manual [2018/11/23 14:52] – [List of API calls] Lauri Elevant |
---|
| [[api:/api/journal|/api/journal]] | C | GET HEAD | List journal events. **Start point for many integrations** :!: | | | [[api:/api/journal|/api/journal]] | C | GET HEAD | List journal events. **Start point for many integrations** :!: | |
| [[api:/api/applicants|/api/applicants]] | C | GET HEAD | List applicants using filters set as parameters | | | [[api:/api/applicants|/api/applicants]] | C | GET HEAD | List applicants using filters set as parameters | |
| | [[api:/api/applicants|/api/applicants]] | C | POST | Create a new applicant / lead and send welcome letter | |
| [[api:/api/applicants/ID|/api/applicants/ID]] | R | GET HEAD | Return information about an applicant | | | [[api:/api/applicants/ID|/api/applicants/ID]] | R | GET HEAD | Return information about an applicant | |
| [[api:/api/applicants/ID/photo|/api/applicants/ID/photo]] | R | GET HEAD | Get the applicant's photo | | | [[api:/api/applicants/ID/photo|/api/applicants/ID/photo]] | R | GET HEAD | Get the applicant's photo | |
| [[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/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/tableviews/ID/tabledata|/api/tableviews/ID/tabledata]] | R | GET HEAD | Get the csv data from a tableview | | | [[api:/api/tableviews/ID/tabledata|/api/tableviews/ID/tabledata]] | R | GET HEAD | Get the csv data from a tableview | |
| | [[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 | |
| |
♦ 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. |