Get the Details of a Demographic Group

GET /demographic_group/:demographicGroupID

Enables the retrieval of the details for a specified demographic group.

Resource URL

https://api.ideasystem.org/v1/demographic_group/12

Response

The response will be an HTTP 200 along with a JSON body that describes what demographic groups are available. If an error occurs with the parameters that are passed in, an HTTP 404 will be returned along with an error message in a JSON body. All other errors will return an HTTP 500 (Internal Server Error).

Response Parameters (JSON Body)

id
Example: "id": 32
The ID for this demographic group.
parent_id
Example: "parent_id": 1
The ID of the parent demographic group.
sort_index
Example: "sort_index": 5
The sort index of the parent demographic group.
name
Example: "name": "Faculty Members"
The name for this demographic group.
abbreviation
Example: "abbreviation": "Faculty"
The abbreviated name for this demographic group.

Example

This request will get the details for a demographic group with ID 2.

Request

GET /v1/demographic_group/2

Response (as JSON)

HTTP 200
{
    "id": 2,
    "parent_id": 1,
    "sort_index": 2,
    "name": "Faculty Members",
    "abbreviation": "Faculty"
}