Dartmouth API Developer Portal

Vox Groups

This API returns information about all avialble Vox Groups.

It is the responsibility of the API consumer to ensure that Group informtion is only made available to appropriate end users.

Notes on usage

Returns resources describing the Group Name for a specific Vox Group.

The Resource ID for an individual resource is the Group name(Ex. Vox Dartmouth Staff).

Requests

GET /vox/groups

GET /vox/groups?id=All Staff

Required Scopes

Scope	Description
"api:vox:groups:read"	This scope is required for any results to be returned. No further document or attribute level access is configured.

Required Headers

Authorization: Bearer {jwt}

Search paramenters

Searching is allowed on any of the resource attributes in the query parameters. For example, to query group record for a specific group:

GET /vox/groups?id=All Staff

Paging

Any collection GET will include return headers allowing paging:

X-Request-ID: 66da34c9-569f-484b-b48e-49634efa7fc1
X-Total-Count: 99696

Subsequent pages can be accessed by specifying the continuation key, page size, and page number:

GET /vox/groups?continuation_key=66da34c9-569f-484b-b48e-49634efa7fc1&page=2&pagesize=100

Attribute Definitions

Attribute	Type	Notes
id	string
primary_data_source	string	Ex. sis, hrms, oim
cache_date	string	When this resource was last refreshed

Sample Collection Request

e.g. https://api.dartmouth.edu/api/vox/groups

Sample Collection Return

[
    {
        "id": "VOX All Undergraduates",
        "primary_data_source": "sis",
        "cache_date": "2021-03-07T11:44:10Z"
    },
    {
        "id": "VOX Arts and Sciences Faculty",
        "primary_data_source": "hrms",
        "cache_date": "2021-03-08T11:44:52Z"
    },
    {
        "id": "VOX Class of 2013",
        "primary_data_source": "sis",
        "cache_date": "2021-03-07T11:44:10Z"
    }
]

Sample Resource Request

e.g. https://api.dartmouth.edu/api/vox/groups/VOX%20All%20Undergraduates

Sample Resource Return

Currently Not Supported

Sample Collection Search Request

e.g. https://api.dartmouth.edu/vox/groups?id=VOX All Undergraduates

Sample Collection Return

[
    {
        "id": "VOX All Undergraduates",
        "primary_data_source": "sis",
        "cache_date": "2021-03-07T11:44:10Z"
    }
]