Enables the retrieval of the available demographic groups provided by the IDEA REST API.

Resource URL

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

Response

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

Response Parameters (JSON Body)

data

Example: "data": { ... }

An array of demographic group objects will be returned in this section.

data.id

Example: "id": 32

The ID for this demographic group.

data.parent_id

Example: "parent_id": 2

The ID for the parent demographic group.

data.sort_index

Example: "sort_index": 32

The sort index for this demographic group.

data.name

Example: "name": "Faculty Members"

The name for this demographic group.

data.abbreviation

Example: "abbreviation": "Faculty"

The abbreviated name for this demographic group.

Example

This request will get all available demographic groups.

Request

GET /v1/demographic_groups

Response (as JSON)

HTTP 200
{
    "data": [
        {
            "id": 1,
            "sort_index": 1,
            "name": "Faculty Members",
            "abbreviation": "Faculty"
        },
        {
            "id": 2,
            "parent_id": 1,
            "sort_index": 2,
            "name": "Dean",
            "abbreviation": "Dean"
        }, ...
    ]
}