{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2b50891e-9423-4ec7-a90a-580f244453ab","name":"UniversitySite SDK (latest)","description":"The SDK provides access to UniversitySite data.\n\n# Overview\n\nThe SDK is made up of a REST based API that returns data in JSON format.\n\n_Prior Versions_\n\n- [v2020-01-02](https://documenter.getpostman.com/view/3947254/SWTBfder)\n    \n\n# Authentication\n\nThe API makes use of OAuth2 for authentication. Each service making use of the API will be given a `client_id` and `client_secret`. The service will use those credentials to request an access token. This access token will be sent along with each API request.\n\nVisit InstructorSite to create your credentials:\n\n<img src=\"https://user-images.githubusercontent.com/2644202/95913191-c5874280-0d9b-11eb-8c30-f4d94d148fbb.png\" alt=\"image\">\n\n# Changelog\n\n## 2025-12-02\n\n- New Endpoints\n    \n    - `/resources` - list recourses\n        \n    - `/resources/:resourceId` - get a resource\n        \n    - `/resources/:resourceId/learning-activity` - who viewed a resource and when\n        \n\n## 2025-04-15\n\n- New Filtering Params\n    \n    - `/courses/:courseId/learning-activity` - a filtering param is now available `modiefiedSince`\n        \n    - `/courses/:courseId/learning-activity` - a filtering param is now available `statusId`\n        \n\n## 2021-01-08\n\nTo make it easier to retrieve user records you can supply `email` as an alternative to the `userId` for the endpoints below.\n\n- New Endpoints\n    \n    - `/users/:email` - get a user\n        \n    - `/users/:email/plans` - get a user's plans\n        \n    - `/users/:email/course-learning-activity` - get a user's course learning ativity\n        \n    - `/users/:email/plans/:planId` - get a user's plan\n        \n    - `/users/:email/plans/additions` - get latest additions to a user's plans\n        \n\n## 2020-10-16\n\n- New Endpoints\n    \n    - `courses/:courseId/learning-activity` was added to return a list of users who have logged activity indicating progress with a given course\n        \n    - `users/:userId/course-learning-activity` was added to return a list of courses a user has interacted with\n        \n\n## 2020-03-16\n\n- New Endpoint\n    - `users/:userId/plans/additions` was added to return a list of the latest courses and events added to a uer's plans\n        \n\n## 2020-02-14\n\n- New Filtering Params\n    \n    - `/courses` - a filtering param is now available `isVisibleToLearningSite`\n        \n    - `/events` - a filtering param is now available `isVisibleToLearningSite`\n        \n    - `/plans` - a filtering param is now available `learnersCanOptIn`\n        \n- New Attributes\n    \n    - `/courses` - `courseIsVisibleToLearningSite` was added to the response as an attribute of each course\n        \n    - `/events` - `eventIsVisibleToLearningSite` was added to the response as an attribute of each event\n        \n\n# Rate limit\n\nThere are two rate limits in place. Each API endpoint that returns paged data is limited to 1 request per second. All other API endpoints are limited to 100 requests per second.\n\n# URLs\n\nSome of the API enpoints return partial URLs to pages within UniversitySite. For example, the API for `/courses` returns a property such `learnerUrl: '/learner/course?id=200'`. You will convert this partial URL to a full URL as shown below:\n\n``` javascript\n// javascript:\n// The baseUrl is the part of your API request \n// preceeding '/sdk/'. This example assumes \n// your API is at \n// http://localhost/universitysite/sdk/\nvar baseUrl = 'http://localhost/universitysite'\nvar partialUrl = `/learner/course?id=200'\n// compute full url\nvar fullUrl = baseUrl + partialUrl\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3947254","team":12228173,"collectionId":"2b50891e-9423-4ec7-a90a-580f244453ab","publishedId":"2sB3dVLmrv","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3947254/2sB3dVLmrv","privateUrl":"https://go.postman.co/documentation/3947254-2b50891e-9423-4ec7-a90a-580f244453ab","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2025-12-16T22:56:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1c70c01322de76b044e4b86ef0f124671c5b0cf3542b6d19cf720eb29150774d","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB3dVLmrv"}