Get Application Information

GET /apps

Enables the retrieval of application information based upon the query parameters given.

Resource URL

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

Parameters

page
optional
Default: 0
Example: /v1/apps?page=1
Used to retrieve more results. Can be incremented until the results returned are less than the max parameter.
max
optional
Default: 50
Example: /v1/apps?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.
name
optional
 
Example: /v1/apps?name=Bob
Filters applications based upon the contact person's name given. This will be treated as a fragment and use it to find applications that contain the given contact name. For example, if given "Bob" it would return both "Bobby Jones" and "Bob Smith".
email
optional
 
Example: /v1/apps?email=IDEAedu.org
Filters applications based upon the contact person's email address given. This will be treated as a fragment and use it to find applications that contain the given contact person email address. For example, if given "IDEAedu.org" it would return both "todd@IDEAedu.org" and "tanner@IDEAedu.org".

Response

The response will be an HTTP 200 with a JSON body. The body will include a list of applications that match the given query. It is possible to get an HTTP 200 but 0 total_results; this will happen when the query matches no records.

If there is an issue with the backend, a HTTP 500 (Internal Server Error) is returned. If the application name/key you are using doesn't have access to this REST end-point, you will get a 403 (Forbidden) error.

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 application objects will be returned in this section.
data.id
Example: "id": 1234
The unique identifier for this application.
data.key
Example: "key": "abcdefghijklmnopqrstuvwxyz1234567890"
The encrypted version of application key that is used.
data.name
Example: "name": "SampleApp123"
The name of the application.
data.contact
Example: "contact": { ... }
The contact information for this application.
data.contact.name
Example: "name": "Joe Technology"
The contact person's name.
data.contact.email
Example: "email": "joeTech@IDEAedu.org"
The contact person's email address.
data.read_only
Example: "read_only": true
True if this application can only read data (and not write); in other words, this application can only access using GET and not POST, PUT, nor DELETE. False if the application can perform all actions (GET, PUT, POST, and DELETE).
data.app_admin
Example: "app_admin": false
True if this application is an administration application.

Example

This request will get all applications that contain "IDEA" in their name.

Request

GET /v1/apps?name=IDEA

Response (as JSON)

HTTP 200
{
"max": 10,
"page": 0,
"total_results": 2,
"data": [
    {
        "id": 123,
        "key": "abcdefghijklmnopqrstuvwxyz1234567890",
        "name": "IDEA Online",
        "read_only": false,
        "app_admin": false,
        "contact": {
            "name": "The IDEA Center",
            "email": "contact@IDEAedu.org"
        }
    },
    {
        "id": 124,
        "key": "1234567890abcdefghijklmnopqrstuvwxyz",
        "name": "IDEA Input Interface",
        "read_only": false,
        "app_admin": true,
        "contact": {
            "name": "The IDEA Center",
            "email": "contact@IDEAedu.org"
        }
    }]
}