List Event Types

 

Description

List the Event Types visible on the Administrative Portal. This list can be filtered by search criteria that is specified in the parameters section.

The Administrative Portal is used by developers to manage their subscriptions.

  
URL Structure
{Base URL}/event-types?{search_criteria}
HTTP Method GET  
Authentication Required  
Request Headers none
Parameters
search_criteria Required? Explanation
domain= Optional Limits the list to an exact match on the domain attribute.
entity= Optional Limits the list to an exact match on the entity attribute.
event_type= Optional Limits the list to an exact match on the event_type attribute.

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 '?domain=edu.byu&domain=edu.byui' in an attempt to get all event types for BYU or BYU Idaho. You would have to make two requests.

Example Invocations

[Base URL}/event-types?domain=edu.byu
 
[Base URL}/event-types?domain=byu.edu&entity=AIM
 
[Base URL}/event-types?event_type=Add%20Class
 
Request Body none  
Returns 
<event_types xmlns="http://ws.byu.edu/namespace/event_hub/v1">
   <event_type_definition>   --This block repeats for each Event Type
      <domain/>              --from Event database
      <entity/>              --from Event database
      <event_type/>          --from Event database
      <description/>         --from Event database
      <filter_names>            
         <filter_name/>      --from Event database
                                  (repeats as needed)
      </filter_names>     
   </event_type_definition>
</event_types>
 
<event_types xmlns="http://ws.byu.edu/namespace/event_hub/v1">
   <event_type_definition> 
      <domain>edu.byu</domain>                
      <entity>AIM WaitListing</entity>                  
      <event_type>Add Class</event_type>            
      <description>
         Add a class registration to AIM from the WaitList queue
      </description>              
      <filter_names>
         <filter_name>college</filter_name>
         <filter_name>department</filter_name>
         <filter_name>year_term</filter_name>
         <filter_name>curriculum_id</filter_name>
         <filter_name>title_code</filter_name>
         <filter_name>teaching_area</filter_name>
         <filter_name>catalog_number</filter_name>
         <filter_name>section_number</filter_name>
      </filter_names>
   </event_type_definition>
   <event_type_definition> 
      <domain>edu.byu</domain>                
      <entity>MyMap</entity>                  
      <event_type>Add Class</event_type>            
      <description>
         Add a class registration from the MyMap planning module
      </description>           
      <filter_names>
         <filter_name>college</filter_name>
         <filter_name>department</filter_name>
         <filter_name>year_term</filter_name>
         <filter_name>curriculum_id</filter_name>
         <filter_name>title_code</filter_name>
         <filter_name>teaching_area</filter_name>
         <filter_name>catalog_number</filter_name>
         <filter_name>section_number</filter_name>
      </filter_names>
   </event_type_definition>
   ... repeat for all Event Types that satisfy search_criteria
</event_types>
 
{
  "event_types": {
    "event_type_definition": [
      {
        "domain": "edu.byu",
        "entity": "AIM WaitListing",
        "event_type": "Add Class",
        "description": 
          "Add a class registration to AIM from the WaitList queue",
        "filter_names": {
          "filter_name": [
            "college",
            "department",
            "year_term",
            "curriculum_id",
            "title_code",
            "teaching_area",
            "catalog_number",
            "section_number"
          ] 
        }
      },
      {
        "domain": "edu.byu",
        "entity": "MyMap",
        "event_type": "Add Class",
        "description": 
          "Add a class registration from the MyMap planning module",
        "filter_names": {
          "filter_name": [
            "college",
            "department",
            "year_term",
            "curriculum_id",
            "title_code",
            "teaching_area",
            "catalog_number",
            "section_number"
          ] 
        }
      }
    ... repeat for all Event Types that satisfy search_criteria
    ]  
  }
}

Errors

Return Code

 Additional Explanation
204 No Event Types Found
400 Unknown parameter in search criteria 
<fault_message xmlns="http://ws.byu.edu/namespace/event_hub/v1">
  <return_code/>    -- http return code
  <explanation/>    -- see the table above
  <error_data/>     -- from request
</fault_message>
 
<fault_message xmlns="http://ws.byu.edu/namespace/event_hub/v1">
   <return_code>400</return_code>
   <explanation>
      Unknown parameter in search criteria
   </explanation>
   <error_data>event_tpe</error_data>
</fault_message>
 
{
  "fault_message": {
    "return_code": "400",
    "explanation": "Unknown parameter in search criteria",
    "error_data": "event_tpe"
  }
}
Notes none