List Domains

 

Description

Lists the set of Domains visible on the Administrative Portal.

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

  
URL Structure
{Base URL}/domains
HTTP Method GET  
Authentication Required  
Parameters none  
Request Headers none
Request Body none  
Returns 
<domains xmlns="http://ws.byu.edu/namespace/event-hub/v1">
  <domain_definition> -- This block repeats for each domain
    <domain/>         --from Event database
    <description/>    --from Event database
  </domain_definition>
</domains>
 
<domains xmlns="http://ws.byu.edu/namespace/event-hub/v1">
  <domain_definition>
    <domain>byu.edu</domain>
    <description>Brigham Young University</description>
  </domain_definition>
  <domain_definition>
    <domain>byui.edu</domain>
    <description>BYU Idaho</description>
  </domain_definition>
  ... -- repeat for all domains
</domains>
 
{
  "domains": {
    "domain_definition": [
      {
        "domain": "byu.edu",
        "description": "Brigham Young University"
      },
      {
        "domain": "byui.edu",
        "description": "BYU Idaho"
      }
  ...  --repeat for all domains
    ]  
  }
}

Errors
Return Code Additional Explanation
204 No Domains Found
Notes none