Get Institution Information

GET /institution/:institutionID

Enables the retrieval of institution information based upon the ID given.

Resource URL

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

Parameters

institution_id
required
 
Example: /v1/institution/1
The institution ID.

Response

The response will be an HTTP 200 with a JSON body. The body will include the institution information.

If there is an issue with the backend, a HTTP 500 (Internal Server Error) is returned. If an institution cannot be found with the given ID, an HTTP 404 (Not Found) will be returned.

Response Parameters (JSON Body)

id
Example: "id": 1234
The unique identifier for this institution.
fice
Example: "fice": "003919"
The FICE for this institution. This is a unique identifier used in the Higher Education Directory (HED) provided by Higher Education Publications Inc.
name
Example: "name": "IDEA University"
The name of the institution.

Example

This request will get an institution with ID 1234.

Request

GET /v1/institution/1234

Response (as JSON)

HTTP 200
{
    "id": 123,
    "fice": "001032",
    "name": "The IDEA Center"
}