Dartmouth API Developer Portal

Vox Group Memberships

This API returns information about current Members of different Vox groups.

It is the responsibility of the API consumer to ensure that the results are parsed into required state before it is made available to appropriate end users.

Notes on usage

Returns resources describing Member and its Vox Group info.

The Resource ID for an individual resource is in the form "{VoxGroupName}|{email}|{?netid}".

Requests

GET /vox/group_memberships

GET /vox/group_memberships?netid=f00123

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 all group membership records for a netid:

GET /vox/group_memberships?netid=f00123

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/group_memberships?continuation_key=66da34c9-569f-484b-b48e-49634efa7fc1&page=2&pagesize=100

Attribute Definitions

Attribute	Type	Notes
primary_data_source	string	Ex. sis, hrms, oim
id	string	VoxGroupName, email, and netid piped together (netid can be blank) Ex. VOX Staff\
group_name	string
netid	string
first_name	string
middle_name	string
last_name	string
name	string
email	string
cache_date	string	When this resource was last refreshed

Sample Collection Search Request

e.g. https://api.dartmouth.edu/api/vox/group_memberships?netid=f000123

Sample Collection Return

[
    {
        "primary_data_source": "hrms",
        "id": "VOX Staff|JohnDoe@Dartmouth.edu|f00123",
        "group_name": "VOX Staff",
        "netid": "f00123",
        "first_name": "John",
        "middle_name": "",
        "last_name": "Doe",
        "name": "John Doe",
        "email": "JohnDoe@Dartmouth.edu",
        "cache_date": "2021-03-08T11:46:36Z"
    }
]

Sample Resource Request

e.g. https://api.dartmouth.edu/api/vox/group_memberships/VOX Staff|JohnDoe@Dartmouth.edu|f00123

Sample Resource Return

Currently Not Supported