Get Available Services

GET /services

Enables the retrieval of the available services provided by the IDEA REST API. The set of results is based upon the client's authentication; in other words, each client will have a set of available services.

Resource URL

https://api.ideasystem.org/v1/services

Parameters

page
optional
Default: 0
Example: /v1/services?page=1
Used to retrieve more results. Can be incremented until the results returned are less than the max parameter.
max
optional
Default: 100
Example: /v1/services?max=10
The max parameter can be used to limit how many results are returned. It is recommended that this value be set as low as possible given the client needs. The max allowable value is 100. If a value greater than 100 is specified, only 100 results will be returned.

Response

The response will be an HTTP 200 along with a JSON body that describes what services are available.

Response Parameters (JSON Body)

max
Example: "max": 50
Shows the maximum number of responses.
page
Example: "page": 1
Shows the page number.
total_results
Example: "total_results": 143
Shows the total number of results that are provided by the given query.
data
Example: "data": { ... }
An array of service objects will be returned in this section. The size of this array should match the total_results.
data.url
Example: "url": "https://api.ideasystem.org/reportService/report"
The URL for the REST end-point.
data.name
Example: "name": "Report Generation Service"
The name of the service.
data.description
Example: "description": "Enables report generation"
A human readable description of the service.

Example

This request will get all available services.

Request

GET /v1/services

Response (as JSON)

HTTP 200
{
    "max": 50,
    "page": 0,
    "total_results": 2,
    "data": [
        {
            "url": "https://api.ideasystem.org/v1/services/survey",
            "name": "Survey Upload Service",
            "description": "Enables the upload of survey definition and data",
        }
    ]
}