meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
api:api_journal [2018/11/16 16:26]
Lauri Elevant [List of journal events]
api:api_journal [2019/11/27 12:37] (current)
Lauri Elevant
Line 6: Line 6:
 List journal events from the system using the filters set as parameters. The number of journal events matching the search options is represented in the ''​X-Count''​ header - use the ''​HEAD''​ request to simply check if anything interesting has happened in the system. Use the ''​GET''​ request to actually fetch the events and follow them up on. List journal events from the system using the filters set as parameters. The number of journal events matching the search options is represented in the ''​X-Count''​ header - use the ''​HEAD''​ request to simply check if anything interesting has happened in the system. Use the ''​GET''​ request to actually fetch the events and follow them up on.
  
-**This is an important API call, as in many cases you may want to pull some information from DreamApply to your systems. In order to know when something interesting has happened in the system, just poll this API call regularly, each time saving the time of the last request. For next requests, use the stored timestamp for the ''​bySince''​ param. **+**This is an important API call, as in many cases you may want to pull some information from DreamApply to your systems. In order to know when something interesting has happened in the system, just poll this API call regularly, each time saving the ''​logged''​ timestamp or the incremental ID of the last request. For next requests, use the stored timestamp ​or ID for the ''​bySince''​ param. For example if your last processed event was 123 (as in the example below), your next call might be ''?​bySince=124'',​ in order to return rows starting from 124 (inclusive. This will skip all events up to and including 123.**
  
 For example, if you want to copy data to your system once an applicant'​s offer is ''​Enrolled'',​ 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 status is ''​Enrolled''​ 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'​s offer is ''​Enrolled'',​ 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 status is ''​Enrolled''​ and continue to poll more information about these applicants (documents, application data etc.)
Line 20: Line 20:
 ^ Name ^  ^ Description ^ Notes ^ ^ Name ^  ^ Description ^ Notes ^
 | ''​byEvents''​ | Optional | List of journal events you are interested in | [1] | | ''​byEvents''​ | Optional | List of journal events you are interested in | [1] |
-| ''​bySince''​ | Optional | A date from which you want to start searching from | [2] |+| ''​bySince''​ | Optional | A date or the ID from which you want to start searching from | [2] |
  
   * // Note [1]: See the list of journal events below. The list must be comma-separated. All list items are combined with logical ''​OR''​ operators - in other words a journal event is considered matching if it matches to any of the values provided in the list.//   * // Note [1]: See the list of journal events below. The list must be comma-separated. All list items are combined with logical ''​OR''​ operators - in other words a journal event is considered matching if it matches to any of the values provided in the list.//