| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| api:api_journal [2024/02/15 10:00] – [Parameters] Lauri | api:api_journal [2024/10/28 11:51] (current) – [List of journal events] Safak |
|---|
| |
| For example, if you want to copy data to your system once an applicant is given a specific offer type, simply poll for the ''Offer was edited: ?'' event. This event is logged each time an offer is edited. If you go over the list of events received, you can easily pick out the ones where the offer type is the one you're looking for and continue to poll more information about these applicants (documents, application data etc.) | For example, if you want to copy data to your system once an applicant is given a specific offer type, simply poll for the ''Offer was edited: ?'' event. This event is logged each time an offer is edited. If you go over the list of events received, you can easily pick out the ones where the offer type is the one you're looking for and continue to poll more information about these applicants (documents, application data etc.) |
| | |
| | **This call will only return events from the last 6 months, for performance reasons.** If you need to access older events, please request an exemption from customer support. |
| ==== Syntax ==== | ==== Syntax ==== |
| |
| |
| ^ Name ^ ^ Description ^ Notes ^ | ^ Name ^ ^ Description ^ Notes ^ |
| | ''byEvents'' | Optional | List of journal events you are interested in | [1] | | | ''byEvents'' | **Required** | List of journal events you are interested in | [1] | |
| | ''bySince'' | Optional | An ISO datetime or the (sequential) ID from which you want to start searching from | [2] | | | ''bySince'' | Optional | An ISO datetime or the (sequential) ID from which you want to start searching from | [2] | |
| | ''byUntil'' | Optional | An ISO datetime or the (sequential) ID of the last even you wish to receive | [2] | | | ''byUntil'' | Optional | An ISO datetime or the (sequential) ID of the last even you wish to receive | [2] | |
| | ''Course was removed from application'' | Should be self-explanatory | | | ''Course was removed from application'' | Should be self-explanatory | |
| |Application submit|| | |Application submit|| |
| | ''Application was submitted'' | Application was assigned to an administrator for handling (manually or via Director) | | | ''Application was submitted'' | Application was submitted successfully | |
| | ''Application was re-submitted'' | Application was un-assigned from an administrator | | | ''Application was re-submitted'' | Application was submitted after being reopened previously | |
| |Application assign|| | |Application assign|| |
| | ''Application was assigned'' | A flag was added to the application | | | ''Application was assigned'' | Application was assigned to an administrator for handling (manually or via Director) | |
| | ''Application was un-assigned'' | A flag was removed to the application | | | ''Application was un-assigned'' | Application was un-assigned from an administrator | |
| |Application flags|| | |Application flags|| |
| | ''Application was flagged'' | A flag was added to the application | | | ''Application was flagged'' | A flag was added to the application | |