This is an old revision of the document!
/api/journal
HEAD, GET
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.
Syntax
GET /api/journal Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
Name | Description | Notes | |
---|---|---|---|
byEvents | Optional | List of journal events you are interested in | [1] |
bySince | Optional | A date 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 [2]: An ISO 8601 compatible date(time)
Response headers
Content-Type: application/json Content-Length: 1456 X-Count: 123
Response codes
400 Bad Request | One of the filters has bad parameters (see error description) |
Ordering of the results
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.
Response example
{ "123": { "registered": "2014-06-20T08:13:41+00:00", "name": { "given": "Joe", "middle": "", "family": "Smith" }, "email": "sample.applicant.21@example.com", "skype": null, "phone": "+372 123456789", "citizenship": "US", "trackers": "/api/applicants/123/trackers", "photo": "/api/applicants/123/photo", "documents": "/api/applicants/123/documents" } }
List of journal events
Event | |
---|---|
Applicant registered | |
Applicant was collected | |
Applicant was deleted | |
Applicant decision: ? | |
Application was created | |
Application was edited | |
Application was submitted | |
Application was re-submitted | |
Application was reopened | |
Application was silenced | |
Application was un-silenced | |
Application was migrated | |
Application was closed | |
Application was reverted | |
Application was marked as inactive | |
Application was flagged | |
Offer was edited: ? ' | |
Offer was confirmed: ? | |
Course was added to application | |
Course was removed from application | |
Document was uploaded | |
Referee was invited | |
Referee was invited | |
Referee committed reference | |
Invoice was issued | |
Invoice was reminded | |
Invoice was collected | |
Task was committed | |
Task was resolved | |
Task was commented |
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.