Get Classification of Instructional Programs (CIP) data

GET /cip

Enables the retrieval of Classification of Instructional Programs (CIP) data.

Note: Each CIP code has been mapped to a IDEA Discipline Code (http://www.IDEAedu.org/DisciplineCodes).

Resource URL

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

Parameters

page
optional
Default: 0
Example: /v1/cip?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/cip?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.
cip_name
optional
 
Example: /v1/cip?cip_name=Library+and+Information+Science.
Filters CIPs based upon the name given. This will be treated as a fragment and use it to find CIPs that contain the given name. For example, if given "Bio" it would return both "Biochemistry." and "Molecular Biophysics.".
cip_year
optional
 
Example: /v1/cip?cip_year=2010
Filters CIPs based upon the four digit year given.
cip_code
optional
 
Example: /v1/cip?cip_code=30.31
Filter CIPs that have the matching code.
discipline_code
optional
 
Example: /v1/cip?discipline_code=5002
Filter CIPs that map to the given discipline code.

Response

The response will be an HTTP 200 with a JSON body. The body will include a list of CIPs 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 an error occurs with invalid parameters (e.g, using a String when a boolean is expected), an HTTP 400 (Bad Request) is returned.

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 CIP objects will be returned in this section. The size of this array should match the total_results.
data.cip_code
Example: "cip_code": "30.31"
The unique identifier for this CIP. See http://nces.ed.gov/ipeds/cipcode/.
data.cip_year
Example: "cip_year": 2010
The year of this CIP.
data.cip_name
Example: "cip_name": "Human Computer Interaction."
The name of the CIP.
data.discipline_code
Example: "discipline_code": "3000"
The IDEA Discipline code this CIP maps to.
data.discipline_name
Example: "discipline_name": "Multi/Interdisciplinary Studies"
The IDEA Discipline name this CIP maps to.

Example

This request will get all CIPs that contain "Bio" in their name.

Request

GET /v1/cip?name=Bio

Response (as JSON)

HTTP 200
{
"max": 10,
"page": 0,
"total_results": 3,
"data": [
    {
        "cip_code": "01.1203",
        "cip_year": "2010",
        "cip_name": "Soil Microbiology.",
        "discipline_code": "205"
        "discipline_name": "Soil Sciences"
    },
    {
        "cip_code": "03.0502",
        "cip_year": "2010",
        "cip_name": "Forest Sciences and Biology.",
        "discipline_code": "305"
        "discipline_name": "Forestry and Related Sciences"
    },
    {
        "cip_code": "42.1101",
        "cip_year": "2010",
        "cip_name": "Physiological Psychology/Psychobiology.",
        "discipline_code": "4211"
        "discipline_name": "Physiological Psychology/Psychobiology"
    }]
}