Get Available Disciplines

GET /disciplines

Enables the retrieval of the available disciplines provided by the IDEA Data Portal.

Resource URL

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

Parameters

page
optional
Default: 0
Example: /v1/disciplines?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/disciplines?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.
name
optional
 
Example: /v1/disciplines?name=Agriculture
The name parameter allows the user to request all discipline codes that have the names similar to the String given.
abbrev
optional
 
Example: /v1/disciplines?abbrev=AG
The abbrev parameter allows the user to request all discipline codes that have abbreviations similar to the String given.

Response

The response will be an HTTP 200 along with a JSON body that describes what discipline are available.

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 discipline code objects will be returned in this section.
data.id
Example: "id": 2
The ID for this discipline code.
data.code
Example: "code": 101
The code for this discipline.
data.name
Example: "name": "Agricultural Business and Management"
The name for this discipline code.
data.abbrev
Example: "abbrev": "AGBUSMT"
The abbreviated name for this discipline code.

Example

This request will get all available disciplines.

Request

GET /v1/disciplines

Response (as JSON)

HTTP 200
{
    "max": 10,
    "page": 0,
    "total_results": 337,
    "data": [
        {
        	"id": 1,
        	"code": 100,
        	"name": "Agricultural Business and Production",
        	"abbrev": "AGBUSPR"
        },
        {
        	"id": 3,
        	"code": 101,
        	"name": "Agricultural Business and Management",
        	"abbrev": "AGBUSMT"
        },
        {
        	"id": 2,
        	"code": 102,
        	"name": "Agricultural Mechanization",
        	"abbrev": "AGMECH"
        },
        ...
    ]
}

Example

This request will get all available disciplines that include "ag" in their name.

Request

GET /v1/disciplines?name=ag

Response (as JSON)

HTTP 200
{
    "max": 10,
    "page": 0,
    "total_results": 43,
    "data": [
        {
            "id": 1,
            "code": 100,
            "name": "Agricultural Business and Production",
            "abbrev": "AGBUSPR"
        },
        {
            "id": 3,
            "code": 101,
            "name": "Agricultural Business and Management",
            "abbrev": "AGBUSMT"
        },
        {
            "id": 2,
            "code": 102,
            "name": "Agricultural Mechanization",
            "abbrev": "AGMECH"
        },
        ...
    ]
}