Enables the update of application to institution linking information. This will set which links are available. Specifically, the valid and known institutions specified in the payload will be the current links and returned in the response payload.

Institution IDs can be collected via the GET /institutions REST end-point.

Resource URL

Data Parameters (JSON Body)

The JSON body will hold a list of institution IDs. It is suggested that they be valid and known institutions. All others will be ignored.

Response

The response will be an HTTP 200 with a JSON body. HTTP 200 does NOT imply all the given institutions were linked to the application. The body will be the list of linked institutions after this update takes effect.

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)

The response body will hold the list of linked institutions (IDs of the institutions).

Example

This request will update the list of linked institutions to be 87654 and 86420 for the application with ID 1234.

Request

PUT Data (as JSON)

[
    87654, 86420
]

Response (as JSON)

HTTP 200
[
    87654, 86420
]