Retrieve Archives

 

Description Retrieve Events from the Event Archive. Most events are available for 45 days. This list can be filtered by search criteria that is specified in the parameters section.  
URL Structure
{Base URL}/archives?{search_criteria}
HTTP Method GET  
Authentication Required  
Request Headers none
Parameters
search_criteria Required? Explanation
domain= Optional Limits the list where the domain attribute matches the string expression. The string may include wild characters ('*'). Since domains contain an embedded dot ("."), the period must be explicitly expressed in the search string. For example, 'edu.byu' will limit the search to a specific domain, 'edu.*' will limit the search to all 'edu' domains, and '*.byu*' will limit the search to any domain that starts with 'byu' in the first part of the domain.

entity=

 Optional Limits the list where the entity attribute matches the string expression. The string may include wild characters ('*').
event_dt= Required Defines a date-time range for the search. The expected parameter should be of the format '(start_dt, end_dt)'. The dates should be standard ISO format expressed in zulu time. Maximum time span is one day.
event_type= Optional Limits the list where the event_type attribute matches the string expression. The string may include wild characters ('*').
page_size Optional Defaults to 10. Maximum is 200.
page_start Optional Defaults to 1.

Note: When multiple parameters are provided, they are ANDed together. You are not allowed to provide two different instances of the same parameter in the same request. For example, you are not allowed to request '?endpoint=*hr.byu.edu*&endpoint=*fs.byu.edu' in an attempt to get all push client end point for the hr.byu.edu or the fs.byu.edu hosts. You would have to make two requests.

The return set is always from the most recent to the oldest.

Example Invocations

{Base URL}/archives?domain=edu.byu&entity=PRO&event_type=Address%20Changed
 
{Base URL}/archives?domain=edu.byu&entity=PRO&page_size=50
 
{Base URL}/archives?page_size=20&event_dt=(2015-01-01T00:00:00.00Z,2015-01-01T23:59:59.99Z)
 
{Base URL}/archives?page_size=200&domain=edu.byu&entity=PRO&event_type=Address%20Changed&event_dt=(2014-12-15T00:00:00.00Z,2014-12-31T23:59:59.99Z)
 
{Base URL}/archives?page_size=200&page_start=201&domain=edu.byu&entity=PRO&event_type=Address%20Changed&event_dt=(2014-12-15T00:00:00.00Z,2014-12-31T23:59:59.99Z)
 
Request Body None  
Returns 
{
  "events": {
    "event": {
      "event_header": {
        "domain": "edu.byu",
        "entity": "ID Card",
        "event_type": "Refund",
        "event_dt": "2015-01-07T10:10:01.00Z",
        "source_dt": "(null)",
        "archive_dt": "2015-01-07T17:10:07.13Z",
        "source_id": "null",
        "event_id": "2621ac20-5045-4de0-bca7-fc06ece26a53",
        "dispatch_id": "(null)"
      },
      "filters": "(null)",
      "event_body": "This is a test FOR xml attribute's",
      "history": "(null)"
    }
  }
 }

Errors
Return Code Additional Explanation
204 No results found with search criteria
400 Unknown parameter in search criteria
400 Invalid date format
400 Invalid page_size parameter. Must be an integer between 1 and 200.
400 Invalid page_start parameter. Must be an integer less than or equal to the size of the collection defined by the other parameters. 
{
  "fault_message": {
    "return_code": "400",
    "explanation": "Unknown parameter in search criteria",
    "error_data": "event_tpe"
  }
}
Notes none