Description

Defines a new Event Type.

This makes the new Event Type visible on the Administrative Portal. The Administrative Portal is used by developers to manage their subscriptions.

 
URL Structure
{Base URL}/event-types
HTTP Method POST  
Authentication Required  
Request Headers none
Parameters none  
Request Body
<event_type_definition xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <domain/>             --required
   <entity/>             --required
   <event_type/>         --required
   <description/>        --optional
   <filter_names>        --optional
      <filter_name/>     --repeat this tag for each attribute
   </filter_names>
 </event_type_definition>
<event_type_definition xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <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",
    "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"
      ] 
    }
  }
}
Returns
<event_type_definition xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <domain/>              --from request
   <entity/>              --from request
   <event_type/>          --from request
   <description/>         --from request
   <filter_names>            
      <filter_name/>      --from request (repeats as needed)
   </filter_names>        
</event_type_definition>
<event_type_definition xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <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",
    "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"
      ] 
    }
  }
}

Errors

Return Code Additional Explanation
400 Missing Key Values
403 Not Authorized
404 Entity Not Found
409 Domain-Entity-Event Type combination already exists.
<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>409</return_code>
   <explanation>
      Domain-Entity-Event Type combination already exists
   </explanation>
   <error_data>byu.edu-AIM WaitListing-Add Class</error_data>
</fault_message>
{
  "fault_message": {
    "return_code": "409",
    "explanation": "Domain-Entity-Event Type combination already exists",
    "error_data": "edu.byu-AIM WaitListing-Add Class"
  }
}
Notes

In order to define an event type, you must authenticate as:

  • An Event Hub administrator,
  • The Entity EGA which will contain the Event Type, or
  • An administrator of the Entity EGA (future implementation).