Dartmouth API Developer Portal

People-SIS Roles API

Returns information about security roles for the person specific to the SIS system.

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	30 minutes
Filtering	No

Required Scopes

Scope	Description
urn:dartmouth:people:read.sensitive	This scope is required to access people roles. Authorization to this scope requires multiple approvals from Student Affairs, Human Resources and Advancement

Request

GET /api/people/{netid}/sis_roles

Required Headers

Authorization: Bearer {jwt}

Parameters

Parameter Name	Type	Description	Valid values	Required

(none)

Notes on usage

SIS Roles are modeled as a subresource of people. Currently it is only possible to get sis roles for a particular person. Searching for holders of certain roles is not available.

The roles are returned as a collection. When the person does not have sis roles associated with their account a return status of 404 is returned and an empty array in the payload.

Returns

Status Code	Description
200	Person has sis roles associated with their account
404	Person does not have sis roles associated with their account

Sample Request

https://api.dartmouth.edu/api/people/d10073q/sis_roles

Sample Return

[
    {
        "role_name": "Z_DEGREEWORKS_FACMENU",
        "modified_date": "2013-04-02T19:05:12Z"
    },
    {
        "role_name": "Z_GRF_ALL",
        "modified_date": "2011-10-22T11:00:27Z"
    },
    {
        "role_name": "Z_UGF_ALL",
        "modified_date": "2016-02-05T12:00:51Z"
    },
    {
        "role_name": "Z_XXE_DASH_EE",
        "modified_date": "2007-10-16T11:30:13Z"
    }
]