Jump to Content

API Reference

Documentation

Getting Started with Gooru
Standards - FAQs

Authentication

Authentication Flow
Anonymous Signin (Token)post
User Signin (Token)post
Signout (Delete Access Token)delete
Get Access Token Detailsget

Course

Create a New Coursepost
Update Existing Courseput
Fetch a Course by Idget
Delete Coursedelete
Reorder Units in Existing Courseput
Update the List of Collaborators for a Courseput
Move existing Unit and its children to existing Courseput

Assessment

Get an Assessment by Idget
Create a new Assessmentpost
Update an Existing Assessmentput
Delete an Assessmentdelete
Add a New Question to Assessmentput
Reorder Questions in Assessmentsput
Update the List of Collaborators for an Assesmentput
Delete External Assessmentdelete
Test APIpost

Collection

Get a Collection based on Idget
Create a new Collectionpost
Update an Existing Collectionput
Delete a Collectiondelete
Add a New Question to a Collectionput
Add a New Resource to Collectionput
Reorder Resources/Questions in Existing Collectionput
Update the List of Collaborators for a Collectionput

Profile

List Courses as Owner/Publicget
List Collections as Owner/Publicget
List Assessment as Owner/Publicget
List Resources as Owner/Publicget
List Questions as Owner/Publicget
Get Demographics (Get User)get
Search User(s)get

Questions

Get Question by idget
Create a new Questionpost
Update a Questionput
Delete Questiondelete
Update Score of a Questionput
Get Question By Ids - Bulkget

Resources

Get Resource by idget
Create a new Resourcepost
Update an existing Resourceput
Delete Resourcedelete

Static Lookup Values

Intro Static Lookup Values
List Educational Useget
List Access Hazardsget
List Reading Levelsget
List Advertisement Status in Contentget
List Media Featuresget
List Gradesget
List moments of learningget
List Audienceget
List Countriesget
List Depth of Knowledgeget
List 21 Century Skillsget
List schoolget
List school districtsget
List Licensesget
List Languagesget

Taxonomy

Taxonomy Overview
Fetch Taxonomy Subjectsget
Fetch Taxonomy Courses at a Frameworkget
Fetch Taxonomy Domains at a Frameworkget
Fetch Taxonomy Standards at a Frameworkget
Fetch Framework list by Subject (Gut)get

Users

Create user accountpost
Update user accountput
Find user by username or email Idget
Forgot passwordpost
Change email addresspost
Reset authenticate user passwordput

Search API

Gooru Search Overview
Searching with Gooru API
Query Syntax
Update Index API
Search Resource/ Question/ Collection/ Assessmentget
Search Rubicsget
Search Courseget

Suggest API

Suggest Overview
Location-based Suggestions
Performance-based Suggestions

Crosswalk API

Crosswalk Overview
Crosswalk API

New Player Widget

Integrating Gooru Player Widget
Integrating Gooru Application Widget

One Roster

Roster Sync API

Single Sign-On

Single Sign-On Overview
WS-Fed SSO
Google SSO
oAuth2 SSO

LTI Single Sign On

LTI Launch
LTI Outcomes Integration

Access Catalog

Download Catalogget

External Collections

Get a Collection based on Idget
Create a New External Collectionpost
Update an Existing External Collectionput
Delete External Collectiondelete

Gooru External Contents CRUD API

Get External Assessment By Idget
Create a new External Assessmentpost
Update an existing External Assessmentput
Delete External Assessmentdelete
Get External Collection By Idget
Get OA By Idget
Create a new External Collectionpost
Update an existing External Collectionput
Delete External Collectiondelete
Create a new Offline Activitypost
Update an existing Offline Activityput
Delete Offline Activitydelete
Update the List of Collaborators for an Offline Activityput
Fetch OA Summary by idget
Fetch OA Detail by idget
Create Task for OApost
Update Task of OAput
Delete Task of OAdelete
Add Task Submission for OApost
Delete Task Submission of OAdelete
Create OA Referencepost
Delete OA Referencedelete
Associate Teacher Rubric with OAput
Associate Student Rubric with OAput
List OA Subtypesget

Student Reports

Get Student’s Peers In Courseget
Get Student’s Peers In Unitget
Get Student’s Peers In Lessonget
Get Current Locationget
Get Student Course Performanceget
Get Student Performance In Unitget
Get Student Performance In Lessonget
Get Student Performance In Collection/Assessmentget
Session Statusget
User Sessionget

Auto Complete API

Publisher Autocompleteget
Keyword Autocompleteget

Aggregation API

Resource Subtype Aggregation APIget

Teacher Reports

Get All Students Performance In Courseget
Get All Students Performance In Unitget
Get All Students Performance In Lessonget
Get All Students Performance In Collection/Assessmentget
Get Teacher Given Grade for Studentget

Learning Maps API

Fetch Learning Maps By Competency/ Micro-competencyget
Fetch Learning Maps By Subjectget
Fetch Learning Maps By Courseget
Fetch Learning Maps By Domainget
Fetch Learning Maps By Search Termget
Fetch Learning Maps Statsget

New Class Performance APIs for NILE

Independent Learner: Get Learner Location (for All Courses, Assessments & Collections)get
Independent Learner: Get Learner Performance (for All Courses, Assessments & Collections)get
Independent Learner: Get Learner Course Performanceget
Independent Learner: Get Learner Performance In Unitget
Independent Learner: Get Learner Performance In Lessonget
Independent Learner: Get Collection/Assessment Summaryget
Independent Learner Sessionsget
Overall Performance : Get Assessment/Collection Performance in Courseget
Rubric Grading: Post Student Rubric Gradespost
Student View : Get Performance for All Classespost
Independent Learner: Get Current Location in Courseget
Rubric Grading: Get Questions pending gradingget
Rubric Grading: Get list of Students for a Question to be gradedget
Overall Performance : Get Course Informationget
Overall Performance: Get Learner Subjectsget
Rubric Grading: Get Answer for Rubric Gradingget
Daily Class Activity: Get Assessment/Collection Performance for DAILY CLASS ACTIVITY (POST)post
Daily Class Activity: Get Assessment Summary Reportget
Rubric Grading:Get Rubric Grading Summary for Questionget
Daily Class Activity: Get Assessment Performance based on Taxonomy Tagsget
Performance : Get NU Courses Competency Completion (Bulk API)post
Get Assessment Performance Report(Teacher View)post
Teacher Score Override:Update Student Assessment Scoreput
ATC Teacher View: Completion vs performance data for entire classget
Daily Class Activity: Get Collection Performance Report (Teacher View)get
Self Reporting: Student Self Scoring External Contentpost
Daily Class Activity: Get Collection Performance Reportpost
Daily Class Activity: Get Assessment Performance For Given Sessionget
In-Class:Get Assessment/Collection Performance In Chronological Orderget
Daily Class Activity: Get Collection Performance For Given Sessionget
Daily Class Activity: Get Performance for Classespost
DCA: Offline Activity Grading: Get OA pending gradingget
DCA: Offline Activity Grading: Get list of Students for OA to be gradedget
Independent Learner:Get Assessment/Collection Performance In Chronological Orderpost
Get Submissions for OA Gradingget
Student View: Get Assessment/Collection Performance (In-Class Performance)get
Student View: Get Location for All Classespost
Student View: Get Performance for All Classespost
Teacher View: Get Performance in All Classespost

Offline Reports

Offline Reporting: Teacher Inputs Student Assessment/Collection Data (per question/resource)post
Offline Reporting: Teacher Inputs Student Assessment/Collection Data (like Ext-Asmt/Ext-Coll)post

DCA Class Summary Reports

Get Class Summary for Yearget
Get Class Activities Summary for Monthget
Get All Class Members Coll/Asmt Summary for Monthget

Partner Integration

Integrating Partner Apps with Navigator
User Provisioning
User Delete
User Token
Data IN
Data OUT - Learner Skyline
Data Report via LTI

Powered by

Documentation

Getting Started with Gooru
Standards - FAQs

Authentication

Authentication Flow
Anonymous Signin (Token)post
User Signin (Token)post
Signout (Delete Access Token)delete
Get Access Token Detailsget

Course

Create a New Coursepost
Update Existing Courseput
Fetch a Course by Idget
Delete Coursedelete
Reorder Units in Existing Courseput
Update the List of Collaborators for a Courseput
Move existing Unit and its children to existing Courseput

Assessment

Get an Assessment by Idget
Create a new Assessmentpost
Update an Existing Assessmentput
Delete an Assessmentdelete
Add a New Question to Assessmentput
Reorder Questions in Assessmentsput
Update the List of Collaborators for an Assesmentput
Delete External Assessmentdelete
Test APIpost

Collection

Get a Collection based on Idget
Create a new Collectionpost
Update an Existing Collectionput
Delete a Collectiondelete
Add a New Question to a Collectionput
Add a New Resource to Collectionput
Reorder Resources/Questions in Existing Collectionput
Update the List of Collaborators for a Collectionput

Profile

List Courses as Owner/Publicget
List Collections as Owner/Publicget
List Assessment as Owner/Publicget
List Resources as Owner/Publicget
List Questions as Owner/Publicget
Get Demographics (Get User)get
Search User(s)get

Questions

Get Question by idget
Create a new Questionpost
Update a Questionput
Delete Questiondelete
Update Score of a Questionput
Get Question By Ids - Bulkget

Resources

Get Resource by idget
Create a new Resourcepost
Update an existing Resourceput
Delete Resourcedelete

Static Lookup Values

Intro Static Lookup Values
List Educational Useget
List Access Hazardsget
List Reading Levelsget
List Advertisement Status in Contentget
List Media Featuresget
List Gradesget
List moments of learningget
List Audienceget
List Countriesget
List Depth of Knowledgeget
List 21 Century Skillsget
List schoolget
List school districtsget
List Licensesget
List Languagesget

Taxonomy

Taxonomy Overview
Fetch Taxonomy Subjectsget
Fetch Taxonomy Courses at a Frameworkget
Fetch Taxonomy Domains at a Frameworkget
Fetch Taxonomy Standards at a Frameworkget
Fetch Framework list by Subject (Gut)get

Users

Create user accountpost
Update user accountput
Find user by username or email Idget
Forgot passwordpost
Change email addresspost
Reset authenticate user passwordput

Search API

Gooru Search Overview
Searching with Gooru API
Query Syntax
Update Index API
Search Resource/ Question/ Collection/ Assessmentget
Search Rubicsget
Search Courseget

Suggest API

Suggest Overview
Location-based Suggestions
Performance-based Suggestions

Crosswalk API

Crosswalk Overview
Crosswalk API

New Player Widget

Integrating Gooru Player Widget
Integrating Gooru Application Widget

One Roster

Roster Sync API

Single Sign-On

Single Sign-On Overview
WS-Fed SSO
Google SSO
oAuth2 SSO

LTI Single Sign On

LTI Launch
LTI Outcomes Integration

Access Catalog

Download Catalogget

External Collections

Get a Collection based on Idget
Create a New External Collectionpost
Update an Existing External Collectionput
Delete External Collectiondelete

Gooru External Contents CRUD API

Get External Assessment By Idget
Create a new External Assessmentpost
Update an existing External Assessmentput
Delete External Assessmentdelete
Get External Collection By Idget
Get OA By Idget
Create a new External Collectionpost
Update an existing External Collectionput
Delete External Collectiondelete
Create a new Offline Activitypost
Update an existing Offline Activityput
Delete Offline Activitydelete
Update the List of Collaborators for an Offline Activityput
Fetch OA Summary by idget
Fetch OA Detail by idget
Create Task for OApost
Update Task of OAput
Delete Task of OAdelete
Add Task Submission for OApost
Delete Task Submission of OAdelete
Create OA Referencepost
Delete OA Referencedelete
Associate Teacher Rubric with OAput
Associate Student Rubric with OAput
List OA Subtypesget

Student Reports

Get Student’s Peers In Courseget
Get Student’s Peers In Unitget
Get Student’s Peers In Lessonget
Get Current Locationget
Get Student Course Performanceget
Get Student Performance In Unitget
Get Student Performance In Lessonget
Get Student Performance In Collection/Assessmentget
Session Statusget
User Sessionget

Auto Complete API

Publisher Autocompleteget
Keyword Autocompleteget

Aggregation API

Resource Subtype Aggregation APIget

Teacher Reports

Get All Students Performance In Courseget
Get All Students Performance In Unitget
Get All Students Performance In Lessonget
Get All Students Performance In Collection/Assessmentget
Get Teacher Given Grade for Studentget

Learning Maps API

Fetch Learning Maps By Competency/ Micro-competencyget
Fetch Learning Maps By Subjectget
Fetch Learning Maps By Courseget
Fetch Learning Maps By Domainget
Fetch Learning Maps By Search Termget
Fetch Learning Maps Statsget

New Class Performance APIs for NILE

Independent Learner: Get Learner Location (for All Courses, Assessments & Collections)get
Independent Learner: Get Learner Performance (for All Courses, Assessments & Collections)get
Independent Learner: Get Learner Course Performanceget
Independent Learner: Get Learner Performance In Unitget
Independent Learner: Get Learner Performance In Lessonget
Independent Learner: Get Collection/Assessment Summaryget
Independent Learner Sessionsget
Overall Performance : Get Assessment/Collection Performance in Courseget
Rubric Grading: Post Student Rubric Gradespost
Student View : Get Performance for All Classespost
Independent Learner: Get Current Location in Courseget
Rubric Grading: Get Questions pending gradingget
Rubric Grading: Get list of Students for a Question to be gradedget
Overall Performance : Get Course Informationget
Overall Performance: Get Learner Subjectsget
Rubric Grading: Get Answer for Rubric Gradingget
Daily Class Activity: Get Assessment/Collection Performance for DAILY CLASS ACTIVITY (POST)post
Daily Class Activity: Get Assessment Summary Reportget
Rubric Grading:Get Rubric Grading Summary for Questionget
Daily Class Activity: Get Assessment Performance based on Taxonomy Tagsget
Performance : Get NU Courses Competency Completion (Bulk API)post
Get Assessment Performance Report(Teacher View)post
Teacher Score Override:Update Student Assessment Scoreput
ATC Teacher View: Completion vs performance data for entire classget
Daily Class Activity: Get Collection Performance Report (Teacher View)get
Self Reporting: Student Self Scoring External Contentpost
Daily Class Activity: Get Collection Performance Reportpost
Daily Class Activity: Get Assessment Performance For Given Sessionget
In-Class:Get Assessment/Collection Performance In Chronological Orderget
Daily Class Activity: Get Collection Performance For Given Sessionget
Daily Class Activity: Get Performance for Classespost
DCA: Offline Activity Grading: Get OA pending gradingget
DCA: Offline Activity Grading: Get list of Students for OA to be gradedget
Independent Learner:Get Assessment/Collection Performance In Chronological Orderpost
Get Submissions for OA Gradingget
Student View: Get Assessment/Collection Performance (In-Class Performance)get
Student View: Get Location for All Classespost
Student View: Get Performance for All Classespost
Teacher View: Get Performance in All Classespost

Offline Reports

Offline Reporting: Teacher Inputs Student Assessment/Collection Data (per question/resource)post
Offline Reporting: Teacher Inputs Student Assessment/Collection Data (like Ext-Asmt/Ext-Coll)post

DCA Class Summary Reports

Get Class Summary for Yearget
Get Class Activities Summary for Monthget
Get All Class Members Coll/Asmt Summary for Monthget

Partner Integration

Integrating Partner Apps with Navigator
User Provisioning
User Delete
User Token
Data IN
Data OUT - Learner Skyline
Data Report via LTI

Powered by

Create a New External Collection

post http://gooru.org/api/nucleus/v2/collections-external

Language

Credentials

Header

Click Try It! to start a request and see the response here!