Get Application Information

GET /app/:appID

Enables the retrieval of application information for a given application (appID).

Resource URL

https://api.ideasystem.org/v1/app/1234

Response

The response will be an HTTP 200 with a JSON body. The body will be the application with the given ID.

If the given application ID cannot be found, an HTTP 404 (Not Found) will be returned. 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)

id
Example: "id": 1234
The unique identifier for this application.
key
Example: "key": "abcdefghijklmnopqrstuvwxyz1234567890"
The encrypted version of application key that is used.
name
Example: "name": "SampleApp123"
The name of the application.
contact
Example: "contact": { ... }
The contact information for this application.
contact.name
Example: "name": "Joe Technology"
The contact person's name.
contact.email
Example: "email": "joeTech@IDEAedu.org"
The contact person's email address.
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).
app_admin
Example: "app_admin": false
True if this application is an administration application.

Example

This request will get an application with ID 1234.

Request

GET /v1/app/1234

Response (as JSON)

HTTP 200
{
    "id": 1234,
    "key": "abcdefghijklmnopqrstuvwxyz1234567890",
    "name": "IDEA Online",
    "read_only": false,
    "app_admin": false,
    "contact": {
        "name": "The IDEA Center",
        "email": "contact@IDEAedu.org"
    }
}