Description

Updates an existing 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/{domain}/{entity}/{event_type}
HTTP Method PUT  
Authentication Required  
Request Headers none
Parameters none  
Request Body
<event_type_definition xmlns="http://ws.byu.edu/namespace/event-hub/v1">   
   <domain/>          --leave blank (domain is identified in the URL)   
   <entity/>          --leave blank (entity is identified in the URL)  
   <event_type/>      --leave blank (event type is identified in the URL)  
   <description/>     --filled in if you want it changed
   <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>byu.edu</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": "byu.edu",
    "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>byu.edu</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": "byu.edu",
    "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 Event Type may only be updated by an Entity administrator.
404 Domain-Entity-Event Type does not exist.
<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>404</return_code>
   <explanation>
      Domain-Entity-Event Type does not exist
   </explanation>
   <error_data>byu.edu-AIM-Add Calss</error_data>
</fault_message>
{
  "fault_message": {
    "return_code": "404",
    "explanation": "Domain-Entity-Event Type does not exist",
    "error_data": "byu.edu-AIM-Add Calss"
  }
}
Notes

In order to update 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.