List Subscriptions

Description List my Subscriptions. This list can be filtered by search criteria that is specified in the parameters section.  
URL Structure
{Base URL}/subscriptions?{search_criteria}
HTTP Method GET  
Authentication Required  
Request Headers none
Parameters
search_criteria Required? Explanation
eca_identity_id= Optional If not Identity is provided, it will default to the identity that authenticated. ECA administrators may supply the identity of the ECA. Event Hub administrators may supply the identity of any ECA.
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, 'byu.edu' 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_type= Optional Limits the list where the event_type attribute matches the string expression. The string may include wild characters ('*').

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.

Example Invocations

{Base URL}/subscriptions?eca_identity_id=
 
{Base URL}/subscriptions?eca_identity_id=585241162
 
{Base URL}/subscriptions?eca_identity_id=585241162&domain=byu.edu&entity=MyMap
 
{Base URL}/subscriptions?eca_identity_id=585241162&event_type=Add%20Class
 
Request Body None  
Returns 
<subscriptions xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <subscription>
      <eca_identity_id/>      --from Event Hub
      <eca_identity_name/>    --from Event Hub
      <domain/>               --from Event Hub
      <entity/>               --from Event Hub
      <event_type/>           --from Event Hub
   </subscription>
   ...repeat for every subscription that satisfies the search_criteria
</subscriptions>
 
<subscriptions xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <subscription>
      <eca_identity_id>585241162</eca_identity_id>
      <domain>byu.edu</domain>      
      <entity>AIM Waitlisting</entity>
      <event_type>Add Class</event_type>
   </subscription>
   <subscription>
      <eca_dentity_id>585241162</eca_identity_id>
      <domain>byu.edu</domain>      
      <entity>AIM Waitlisting</entity>
      <event_type>Add Class</event_type>
   </subscription>
</subscriptions>
 
{
  "subscriptions": {
    "subscription": [
      {
        "eca_identity_id": "585241162",
        "eca_identity_name": "HR Benefits",
        "domain": "edu.byu",
        "entity": "AIM WaitLising",
        "event_type": "Add Class"
      },
      {
        "eca_identity_id": "585241162",
        "eca_identity_name": "HR Benefits",
        "domain": "edu.byu",
        "entity": "AIM WaitLising",
        "event_type": "Add Class"
      }
    ]  
  }
}

Errors
Return Code Additional Explanation
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>404</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