Help Contents

 

Root

updated by Catch Admin (Sep 12, 2018)

Resource: Root ( /api/ )

Returns root-level response listing available resources.

This resource supports the following methods: GET

Methods

GET

Retrieves the list of available root-level resources.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Retrieve root-level resource links

This provides entry points to ensure clients don't have to be aware of URI structure when implementing an API client

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Links": [
    {
      "Title": "Groups",
      "Href": "http://localhost/http://localhost/api/Groups",
      "Rel": "Groups",
      "Description": "Allows the search and retrieval of groups.",
      "SupportedHttpMethods": [
        "GET",
        "POST"
      ],
      "SupportsOData": true,
      "SupportsTQL": false,
      "Help": "http://localhost/API_Resources_groups.html"
    }
  ]
}

Status Code

200 - OK