Sites

Sites

Route Description
GET /sites Get all sites
GET /sites/{siteid} Get a site

Users

Users

Route Description
GET /users Get all users
GET /sites/users Get all users
GET /sites/{siteid}/users Get all users in a site
GET /users/{userid} Get a user
POST /sites/{siteid}/users Create a user
PUT /users/{userid} Update a user

User Emails

Route Description
GET /users/{userid}/emails Get all emails for a user
GET /users/{userid}/emails/{emailid} Get an email
POST /users/{userid}/emails Add an email
DELETE /users/{userid}/emails/{emailid} Delete an email

Organization Profile

Profile Categories

Route Description
GET /sites/categories/profile Get all profile categories
GET /sites/{siteid}/categories/profile Get all profile categories in a site
GET /sites/categories/profile/{categoryid} Get a profile category
GET /sites/{siteid}/categories/profile/{categoryid} Get a profile category

Profile Groups

Profile Group Assignment

Supervisor Access

Access over Profile Groups

Route Description
GET /sites/{siteid}/access/groups Get all profile groups you can give a user access over
GET /sites/{siteid}/access/groups/{groupid} Get a profile group you can give a user access over
GET /users/{userid}/access/groups Get all groups a user has access over
GET /sites/{siteid}/access/groups/{groupid}/users Get all users who have access over a profile group
POST /sites/{siteid}/access/groups/{groupid}/users Give a user access over a profile group
DELETE /users/{userid}/access/groups/{groupid} Remove a user's access over a profile group

Access to Application Features

Route Description
GET /sites/{siteid}/access/modules Get all features you can give a user access to
GET /sites/{siteid}/access/modules/{accessmoduleid} Get a features you can give a user access to
GET /users/{userid}/access/modules Get all features a user has access to
GET /users/{userid}/access/modules/{accessmoduleid} Get a feature a user has access to
GET /sites/{siteid}/access/modules/{accessmoduleid}/users Get all users who have access to a feature
POST /sites/{siteid}/access/modules/{accessmoduleid}/users Give a user access to a feature
DELETE /users/{userid}/access/modules/{accessmoduleid} Remove a user's access to a feature

Credentials

Credential Categories

Route Description
GET /sites/categories/credential Get all credential categories
GET /sites/{siteid}/categories/credential Get all credential categories in a site
GET /sites/categories/credential/{categoryid} Get a credential category
GET /sites/{siteid}/categories/credential/{categoryid} Get a credential category

Credentials

Route Description
GET /credentials Get all credentials
GET /credentials/{credentialid} Get a credential
GET /sites/categories/credential/{categoryid}/credentials Get all credentials in a category
GET /sites/{siteid}/categories/credential/{categoryid}/credentials Get all credentials in a category

Credential Assignment

Route Description
GET /users/{userid}/credentials Get a user's credential assignments
GET /credentials/{credentialid}/assignments Get a user's credential assignments
GET /credentials/{credentialid}/assignments/{assignmentid} Get a credential assignment
POST /credentials/{credentialid}/assignments Create a credential assignment
PUT /credentials/{credentialid}/assignments/{assignmentid} Update a user's credential assignment
DELETE /credentials/{credentialid}/assignments/{assignmentid} Delete a user's credential assignment

Courses

Courses

Route Description
GET /courses Get all courses
GET /courses/{courseid} Get a course
GET /sites/{siteid}/course/{courseid} Get a specific course for a specific site
GET /sites/{siteid}/courses Get all courses and activities for a specific site

Training Assignments

Training Assignments

Route Description
GET /sites/{siteid}/trainingassignments Get all training assignments for a site
GET /trainingassignments/{transcriptid} Get specific training assignment
PUT /trainingassignments/{transcriptid} Update training assignment
DELETE /trainingassignments/{transcriptid} Delete specific training assignment
POST /trainingassignments/user/{userid}/course/{courseid} Create new training assignment for a specific user
GET /users/{userid}/trainingassignments Get all training assignments for a user
GET /sites/{siteid}/course/{courseid}/trainingassignments Get all training assignments for a course