/api/journal

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 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.)

GET /api/journal
Host: apply.example.edu
Authorization: DREAM apikey="..."

• 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 [2]: An ISO 8601 compatible datetime (inclusive) or the journal event ID to start from (inclusive). The event ID-s are sequential integers, so you can simply save the last one you processed, and issue the next call with bySince=$lastID+1
• Note [3]: For backwards compatibility reasons, the default order/limit are set to “oldest-first” and 1024, respectively. In many cases, for example when polling for new events, it makes sense to fetch the last 10 items. In this case, set “order” to “newest-first” and “limit” to 10.
• Note [4]: Some elements in the returned objects are links to other API calls. Using the expand parameter, it is possible to expand this data to the actual records, saving additional API calls. The full list of possible expansions is applicant,application,course,institution,invoice,offer,document,flag,tracker. You can set one or multiple expansions, combining them in a comma-separated fashion to the expand parameter. Note also that using this parameter caps to limit to 512 due to performance reasons.
• Note [5]: Some events are not associated with any applications and these filters are thus unavailable. If you choose an incompatible event while also setting the byAcademicTermID or byAcademicYear filter, an error will be returned.

Content-Type: application/json
Content-Length: 1456
X-Count: 123

The returned journal events are ordered chronologically, so that the oldest events come first and the most recent event is last. The order is guaranteed even if the events happened in the same second.

There is also a hard limit of maximum 1024 records returned as the number of journal events can be very large indeed. If you receive 1024 records, it is most likely being limited.

{
  "123": {
      "logged": "2014-06-20T08:13:41+00:00",
      "event": "Application was created",
      "bind": [],
      "applicant": "/api/applicants/123",
      "application": "/api/applications/321"
  }
}

In some events, the name contains wildcards in the form of a question mark ?. This is used to “group” some very similar events together, in cases where the only differentiating factor is the status that something was set to etc.

You can also use the form Offer was confirmed: “Enrolled” if you are interested in a specific event, instead of the wildcard.