Update Application Information

PUT /app/:appID

Enables the update of application information. This can update the contact information (name and email) as well as the application name and key. The read only and app admin properties can also be updated. If something is omitted, it will not be updated. The only field that cannot be updated is the ID.

Resource URL

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

Data Parameters (JSON Body)

name
optional
Example: "name": "IDEA Online"
The update name of the application; if not provided, the application name will not be changed.
key
optional
Example: "key": "ABCDEFG0987654321"
The unencrypted key value that should be used; if not provided, the application key will not be changed.
read_only
optional
Example: "read_only": true
The new read only property that should be used; if not provided, the read only property will not be changed.
app_admin
optional
Example: "app_admin": false
The new app admin property that should be used; if not provided, the app admin property will not be changed.
contact
optional
Example: "contact": { ... }
The updated contact information.
contact.name
optional
Example: "name": "New Person"
The updated contact person's name; if not provided, the contact person's name will not be changed.
contact.email
optional
Example: "email": "new@IDEAedu.org"
The updated contact person's email address; if not provided, the contact person's email address will not be changed.

Response

The response will be an HTTP 200 with a JSON body. The body will be the newly updated application information (including all fields).

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)

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 update the name and key for the application with ID 1234.

Request

PUT /v1/app/1234

PUT Data (as JSON)

{
    "name": "Some New Name",
    "key": "ThisIsMyNewSecretKey"
}

Response (as JSON)

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