Description

Lists the set of Entities visible on the Administrative Portal.

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

 
URL Structure
{Base URL}/entities
HTTP Method GET  
Authentication Required  
Request Headers none
Parameters optional ?entity=SELF // will return the entity whose credential was passed in  
Request Body none  
Returns
<entities xmlns="http://ws.byu.edu/namespace/event-hub/v1">
  <entity_definition>  -- This block repeats for each entity
    <entity/>             --from Event database
    <description/>        --from Event database
    <domain/>             --from Event database
    <entity_ega/>         --from Event database
  </entity_definition>
</entities>
<entities xmlns="http://ws.byu.edu/namespace/event-hub/v1">
  <entity_definition>
     <entity>AIM WaitListing</entity>
     <description>
        Wait List module adds classes as space allows
     </description>
     <domain>byu.edu</domain>
     <entity_ega>388211692</entity_ega>
  </entity_definition>
  <entity_definition>
     <entity>MyMap</entity>
     <description>
        MyMap Student Planning and Registration module
     </description>
     <domain>byu.edu</domain>
     <entity_ega>382211692</entity_ega>
  </entity_definition>
  ...   -- repeat for all entities
</entities>
{
  "entities": {
    "entity_definition": [
      {
        "entity": "AIM WaitListing",
        "description": 
          "Wait List module adds classes as space allows",
        "domain": "byu.edu",
        "entity_ega": "388211692" 
      },
      {
        "entity": "MyMap",
        "description": 
          "MyMap Student Planning and Registration module",
        "domain": "byu.edu",
        "entity_ega": "382211692" 
      }
  ...  --repeat for all entities
    ]  
  }
}

Errors

Return Code Additional Explanations
204 No Entities Found
Notes none