The SDK provides access to UniversitySite data.
\nThe SDK is made up of a REST based API that returns data in JSON format.
\nPrior Versions
\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.
Visit InstructorSite to create your credentials:
\n![\"image\"](\"https://user-images.githubusercontent.com/2644202/95913191-c5874280-0d9b-11eb-8c30-f4d94d148fbb.png\")
\n\nNew Endpoints
\n/resources - list recourses
/resources/:resourceId - get a resource
/resources/:resourceId/learning-activity - who viewed a resource and when
New Filtering Params
\n/courses/:courseId/learning-activity - a filtering param is now available modiefiedSince
/courses/:courseId/learning-activity - a filtering param is now available statusId
To make it easier to retrieve user records you can supply email as an alternative to the userId for the endpoints below.
New Endpoints
\n/users/:email - get a user
/users/:email/plans - get a user's plans
/users/:email/course-learning-activity - get a user's course learning ativity
/users/:email/plans/:planId - get a user's plan
/users/:email/plans/additions - get latest additions to a user's plans
New Endpoints
\ncourses/:courseId/learning-activity was added to return a list of users who have logged activity indicating progress with a given course
users/:userId/course-learning-activity was added to return a list of courses a user has interacted with
users/:userId/plans/additions was added to return a list of the latest courses and events added to a uer's plansNew Filtering Params
\n/courses - a filtering param is now available isVisibleToLearningSite
/events - a filtering param is now available isVisibleToLearningSite
/plans - a filtering param is now available learnersCanOptIn
New Attributes
\n/courses - courseIsVisibleToLearningSite was added to the response as an attribute of each course
/events - eventIsVisibleToLearningSite was added to the response as an attribute of each event
There 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.
\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:
// 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\nUse your client_id and client_secret to get an access token
After obtaining a token, send it along with each request. You can send it as an http header, query parameter, form parameter, or a cookie.
\n","urlObject":{"path":["sdk","v1.0","hello"],"host":["http://localhost/universitysite"],"query":[],"variable":[]}},"response":[{"id":"a4d8136b-2a5d-49b8-b5b8-3d8d9d714522","name":"Send access token using http header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/hello"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 16:49:46 GMT"},{"key":"Content-Length","value":"29"}],"cookie":[],"responseTime":null,"body":"\"Hello, 2019-11-29 16:49:46Z\""}],"_postman_id":"1292f574-450a-4858-8df3-ebf70fae77d0"},{"name":"Use token as query parameter","id":"e459defc-c696-4365-9960-72bcb575553f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost/universitysite/sdk/v1.0/hello?access_token={{access_token}}","description":"After obtaining a token, send it along with each request. You can send it as an http header, query parameter, form parameter, or a cookie.
\n","urlObject":{"path":["sdk","v1.0","hello"],"host":["http://localhost/universitysite"],"query":[{"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"d170a156-618d-40f8-b7fb-fd006105069d","name":"Send access token using query parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/hello?access_token=e58aca93-e640-43ec-a0cc-a68d69baa081","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","hello"],"query":[{"key":"access_token","value":"e58aca93-e640-43ec-a0cc-a68d69baa081"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 16:51:42 GMT"},{"key":"Content-Length","value":"29"}],"cookie":[],"responseTime":null,"body":"\"Hello, 2019-11-29 16:51:42Z\""}],"_postman_id":"e459defc-c696-4365-9960-72bcb575553f"},{"name":"Use token as form parameter","id":"62831e11-7f52-42fe-808d-343a3288217f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"access_token","value":"{{access_token}}","type":"text"}]},"url":"http://localhost/universitysite/sdk/v1.0/hello","description":"After obtaining a token, send it along with each request. You can send it as an http header, query parameter, form parameter, or a cookie.
\n","urlObject":{"path":["sdk","v1.0","hello"],"host":["http://localhost/universitysite"],"query":[],"variable":[]}},"response":[{"id":"e02d3a91-79ab-461a-a2b8-cc8848042f1d","name":"Send access token using form parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"access_token","value":"e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}]},"url":"http://localhost/universitysite/sdk/v1.0/hello"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 16:53:36 GMT"},{"key":"Content-Length","value":"29"}],"cookie":[],"responseTime":null,"body":"\"Hello, 2019-11-29 16:53:36Z\""}],"_postman_id":"62831e11-7f52-42fe-808d-343a3288217f"},{"name":"Use token as cookie","id":"e22666da-a495-4a45-a1cb-c31764e7e566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Cookie","value":"access_token={{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/hello","description":"After obtaining a token, send it along with each request. You can send it as an http header, query parameter, form parameter, or a cookie.
\n","urlObject":{"path":["sdk","v1.0","hello"],"host":["http://localhost/universitysite"],"query":[],"variable":[]}},"response":[{"id":"3e24a760-b6b2-4ed1-b0ff-4fa99577644c","name":"Send access token using form parameter Copy","originalRequest":{"method":"GET","header":[],"url":"http://localhost/universitysite/sdk/v1.0/hello"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 16:57:48 GMT"},{"key":"Content-Length","value":"29"}],"cookie":[],"responseTime":null,"body":"\"Hello, 2019-11-29 16:57:48Z\""}],"_postman_id":"e22666da-a495-4a45-a1cb-c31764e7e566"}],"id":"c472693e-62ff-453a-9930-600cbcac7c11","_postman_id":"c472693e-62ff-453a-9930-600cbcac7c11","description":""},{"name":"Courses","item":[{"name":"Get Courses","id":"e4bcde81-4e82-40c6-b79e-24b57dbbaf43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/courses?page=1&modifiedSince=2019-01-01&isVisibleToLearningSite=true","description":"Returns a page of 100 courses.
\n","urlObject":{"path":["sdk","v1.0","courses"],"host":["http://localhost/universitysite"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"modifiedSince","value":"2019-01-01"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"isVisibleToLearningSite","value":"true"}],"variable":[]}},"response":[{"id":"c70fb232-933f-4566-a979-2783dc811562","name":"Get Courses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/courses?page=1&modifiedSince=2019-01-01","host":["http://localhost/universitysite"],"path":["sdk","v1.0","courses"],"query":[{"key":"page","value":"1","description":"Required"},{"key":"modifiedSince","value":"2019-01-01","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Thu, 30 Jan 2020 15:29:01 GMT"},{"key":"Content-Length","value":"54292"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"courseID\": 200,\r\n \"prefix\": \"Business\",\r\n \"number\": 2,\r\n \"title\": \"Money Laundering\",\r\n \"description\": \"\",\r\n \"onDemand\": 0,\r\n \"instructorLed\": 1,\r\n \"courseIsActiveOrRetired\": \"Active\",\r\n \"courseIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2010-09-27T17:54:53.25Z\",\r\n \"dateEdited\": \"2019-01-23T22:22:42.38Z\",\r\n \"instructorUrl\": \"/instructor/courses/200\",\r\n \"learnerUrl\": \"/learner/course?id=200\",\r\n \"learnerPlayUrl\": null\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"courseID\": 200,\r\n \"audienceID\": 6,\r\n \"audience\": \"Attorneys\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"courseID\": 200,\r\n \"departmentID\": 3,\r\n \"department\": \"Attorney Development\"\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"courseID\": 200,\r\n \"tagID\": 35,\r\n \"tag\": \"Business\"\r\n },\r\n {\r\n \"courseID\": 200,\r\n \"tagID\": 2,\r\n \"tag\": \"CLE\"\r\n },\r\n {\r\n \"courseID\": 200,\r\n \"tagID\": 8,\r\n \"tag\": \"Litigation\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"courseID\": 209,\r\n \"prefix\": \"AICC\",\r\n \"number\": 1,\r\n \"title\": \"Coaching and Counseling\",\r\n \"description\": \"\",\r\n \"onDemand\": 1,\r\n \"instructorLed\": 0,\r\n \"courseIsActiveOrRetired\": \"Active\",\r\n \"courseIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2011-01-27T21:49:06.253Z\",\r\n \"dateEdited\": \"2019-08-20T15:01:34.953Z\",\r\n \"instructorUrl\": \"/instructor/courses/209\",\r\n \"learnerUrl\": \"/learner/course?id=209\",\r\n \"learnerPlayUrl\": \"/learner/course?id=209&play=1\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"courseID\": 209,\r\n \"audienceID\": 6,\r\n \"audience\": \"Attorneys\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"courseID\": 209,\r\n \"departmentID\": 2,\r\n \"department\": \"HR\"\r\n }\r\n ],\r\n \"tags\": []\r\n }\r\n }\r\n]"}],"_postman_id":"e4bcde81-4e82-40c6-b79e-24b57dbbaf43"},{"name":"Get a Course","id":"49b140e2-83a7-43f9-a942-4e1b98e31eb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/courses/:courseId","description":"Returns a single course.
\n","urlObject":{"path":["sdk","v1.0","courses",":courseId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"782731c7-5987-4c7f-aea3-ee9dc8660b35","type":"any","value":"3","key":"courseId"}]}},"response":[{"id":"e6f1d107-69e1-4592-b065-ff9c6639a5ff","name":"Get a Course","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/courses/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:21:17 GMT"},{"key":"Content-Length","value":"463"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"courseID\": 3,\r\n \"prefix\": \"MS Word PIP\",\r\n \"number\": 102,\r\n \"title\": \"Using the Spelling and Grammer feature\",\r\n \"description\": \"After completing this course you will be able to proof your document after editing is completed by correcting spelling errors.Returns a list of users who have logged activity indicating progress with a given course.
\n","urlObject":{"path":["sdk","v1.0","courses",":courseId","learning-activity"],"host":["http://localhost/universitysite"],"query":[{"key":"page","value":"1"},{"key":"modifiedSince","value":"2024-01-01"},{"key":"statudId","value":"101"}],"variable":[{"id":"53deedca-fa7a-420e-b563-ec303c3a31df","type":"any","value":"11730","key":"courseId"}]}},"response":[{"id":"0226dfaa-3694-4bc8-b3f3-94e506972c87","name":"Get a Course's Learning Activity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 825b7cfe-a33f-4608-b415-942c7113c3ee","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/courses/:courseId/learning-activity?page=1","host":["http://localhost/universitysite"],"path":["sdk","v1.0","courses",":courseId","learning-activity"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"courseId","value":"11730"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Tue, 13 Oct 2020 20:23:08 GMT"},{"key":"Content-Length","value":"419"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"userID\": 16,\n \"email\": \"NTriton@USLawFirm.com\",\n \"date\": \"2020-09-02T20:00:00Z\",\n \"status\": \"No Showed\",\n \"statusId\": 3\n },\n {\n \"userID\": 40,\n \"email\": \"TJ@firm.co\",\n \"date\": \"2020-09-02T20:00:00Z\",\n \"status\": \"Completed Successfully\",\n \"statusId\": 101\n },\n {\n \"userID\": 93,\n \"email\": \"tony.romo@footballfirm.com\",\n \"date\": \"2020-09-02T20:00:00Z\",\n \"status\": \"No Showed\",\n \"statusId\": 3\n }\n]"}],"_postman_id":"a5c5d2b9-8437-4832-b48c-b5d7caf0d26b"}],"id":"84cb9e96-5849-4810-9ccf-172b8bdf24f2","_postman_id":"84cb9e96-5849-4810-9ccf-172b8bdf24f2","description":""},{"name":"Resources","item":[{"name":"Get Resources","id":"bad8c4dc-b620-498a-b557-90f43313afad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/resources?page=1&modifiedSince=2019-01-01&isVisibleToLearningSite=true","description":"Returns a page of 100 resources.
\n","urlObject":{"path":["sdk","v1.0","resources"],"host":["http://localhost/universitysite"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"modifiedSince","value":"2019-01-01"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"isVisibleToLearningSite","value":"true"}],"variable":[]}},"response":[{"id":"9b9c5bfe-2fa2-45c6-a597-e0487d082f10","name":"Get Resources","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/resources?page=1&modifiedSince=2019-01-01","host":["http://localhost/universitysite"],"path":["sdk","v1.0","resources"],"query":[{"key":"page","value":"1","description":"Required"},{"key":"modifiedSince","value":"2019-01-01","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Thu, 30 Jan 2020 15:29:01 GMT"},{"key":"Content-Length","value":"54292"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"resourceID\": 100,\r\n \"title\": \"Sample Resource\",\r\n \"description\": \"\",\r\n \"isVideo\": false,\r\n \"resourceIsActiveOrRetired\": \"Active\",\r\n \"resourceIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2010-09-27T17:54:53.25Z\",\r\n \"dateEdited\": \"2019-01-23T22:22:42.38Z\",\r\n \"instructorUrl\": \"/instructor/resources/100\",\r\n \"learnerUrl\": \"/learner/resources/100\",\r\n \"expirationDate\": null\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"resourceID\": 100,\r\n \"audienceID\": 6,\r\n \"audience\": \"Attorneys\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"resourceID\": 100,\r\n \"departmentID\": 3,\r\n \"department\": \"Attorney Development\"\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"resourceID\": 100,\r\n \"tagID\": 35,\r\n \"tag\": \"Business\"\r\n }\r\n ]\r\n }\r\n }\r\n]"}],"_postman_id":"bad8c4dc-b620-498a-b557-90f43313afad"},{"name":"Get a Resource","id":"9363f7aa-45fb-40b7-add1-16169cc59d68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/resources/:resourceId","description":"Returns a single resource.
\n","urlObject":{"path":["sdk","v1.0","resources",":resourceId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"51c12f76-9696-423f-a7f9-67d0baab818d","type":"any","value":"100","key":"resourceId"}]}},"response":[{"id":"d5e3bdf8-7bb8-4300-85a6-95ffe6e6294c","name":"Get a Resource","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/resources/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:21:17 GMT"},{"key":"Content-Length","value":"463"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"resourceID\": 100,\r\n \"title\": \"Sample Resource\",\r\n \"description\": \"\",\r\n \"isVideo\": false,\r\n \"resourceIsActiveOrRetired\": \"Active\",\r\n \"resourceIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2010-09-27T17:54:53.25Z\",\r\n \"dateEdited\": \"2019-01-23T22:22:42.38Z\",\r\n \"instructorUrl\": \"/instructor/resources/100\",\r\n \"learnerUrl\": \"/learner/resources/100\",\r\n \"expirationDate\": null\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"resourceID\": 100,\r\n \"audienceID\": -9999,\r\n \"audience\": \"Everyone\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"resourceID\": 100,\r\n \"departmentID\": 1,\r\n \"department\": \"IT\"\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"resourceID\": 100,\r\n \"tagID\": 10,\r\n \"tag\": \"Office - Word\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"9363f7aa-45fb-40b7-add1-16169cc59d68"},{"name":"Get a Resource's Learning Activity","id":"d4536dc2-f22c-47df-9f14-c1ffd3f795b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/resources/:resourceId/learning-activity?page=1&modifiedSince=2024-01-01&actionId=1","description":"Returns a list of users who have logged activity indicating progress with a given resource.
\n","urlObject":{"path":["sdk","v1.0","resources",":resourceId","learning-activity"],"host":["http://localhost/universitysite"],"query":[{"key":"page","value":"1"},{"key":"modifiedSince","value":"2024-01-01"},{"key":"actionId","value":"1"}],"variable":[{"id":"8b3de473-3adb-433a-a4b2-ba05981bcf27","type":"any","value":"100","key":"resourceId"}]}},"response":[{"id":"40cd5659-5827-48ea-aef1-31c5cab7f866","name":"Get a Resource's Learning Activity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 825b7cfe-a33f-4608-b415-942c7113c3ee","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/resources/:resourceId/learning-activity?page=1","host":["http://localhost/universitysite"],"path":["sdk","v1.0","resources",":resourceId","learning-activity"],"query":[{"key":"page","value":"1"}],"variable":[{"key":"resourceId","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Tue, 13 Oct 2020 20:23:08 GMT"},{"key":"Content-Length","value":"419"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"userID\": 16,\n \"email\": \"NTriton@USLawFirm.com\",\n \"date\": \"2020-09-02T20:00:00Z\",\n \"action\": \"Viewed\",\n \"actionId\": 1\n },\n {\n \"userID\": 40,\n \"email\": \"TJ@firm.co\",\n \"date\": \"2020-09-02T20:00:00Z\",\n \"action\": \"Downloaded\",\n \"actionId\": 2\n }\n]"}],"_postman_id":"d4536dc2-f22c-47df-9f14-c1ffd3f795b1"}],"id":"65260455-a310-48ed-942f-33b9cadf5726","_postman_id":"65260455-a310-48ed-942f-33b9cadf5726","description":""},{"name":"Events","item":[{"name":"Get Events","id":"ae959aa6-f2b7-4341-a026-724cb70d008d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/events?page=1&modifiedSince=2019-01-01&isVisibleToLearningSite=true","description":"Returns a page of 100 events.
\n","urlObject":{"path":["sdk","v1.0","events"],"host":["http://localhost/universitysite"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"modifiedSince","value":"2019-01-01"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"isVisibleToLearningSite","value":"true"}],"variable":[]}},"response":[{"id":"adfc9014-9cb6-4c09-a478-cdbe66b67b1c","name":"Get Events","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/events?page=1","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","events"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:14:52 GMT"},{"key":"Content-Length","value":"99394"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"eventID\": 14804,\r\n \"startTime\": \"2019-03-28T14:00:00Z\",\r\n \"endTime\": \"2019-03-28T14:45:00Z\",\r\n \"prefix\": \"PD\",\r\n \"number\": 1,\r\n \"title\": \"How to make a sandwich\",\r\n \"description\": \"\",\r\n \"location\": \"Dallas\",\r\n \"courseID\": 7991,\r\n \"courseIsActiveOrRetired\": \"Active\",\r\n \"eventIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2017-04-12T13:00:54.11Z\",\r\n \"dateEdited\": \"2020-01-30T16:37:37.86Z\",\r\n \"parentEventID\": null,\r\n \"instructorUrl\": \"/instructor/events/14804\",\r\n \"learnerUrl\": \"/learner/event?id=14804\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"eventID\": 14804,\r\n \"audienceID\": -9999,\r\n \"audience\": \"Everyone\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"eventID\": 14804,\r\n \"departmentID\": 2,\r\n \"department\": \"HR\"\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"eventID\": 14804,\r\n \"tagID\": 1189,\r\n \"tag\": \"Benchmark Topic 1\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"eventID\": 14845,\r\n \"startTime\": \"2017-06-21T15:00:00Z\",\r\n \"endTime\": \"2017-06-21T16:00:00Z\",\r\n \"prefix\": \"Firm\",\r\n \"number\": 8,\r\n \"title\": \"Overtime Procedures for Staff\",\r\n \"description\": \"\",\r\n \"location\": \"Dallas\",\r\n \"courseID\": 7968,\r\n \"courseIsActiveOrRetired\": \"Active\",\r\n \"eventIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2017-05-31T14:33:57.49Z\",\r\n \"dateEdited\": \"2019-02-26T03:58:04.567Z\",\r\n \"parentEventID\": null,\r\n \"instructorUrl\": \"/instructor/events/14845\",\r\n \"learnerUrl\": \"/learner/event?id=14845\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"eventID\": 14845,\r\n \"audienceID\": -9999,\r\n \"audience\": \"Everyone\"\r\n }\r\n ],\r\n \"departments\": [],\r\n \"tags\": []\r\n }\r\n }\r\n]"}],"_postman_id":"ae959aa6-f2b7-4341-a026-724cb70d008d"},{"name":"Get an Event","id":"82fdf2f9-f888-45bc-a0c3-3047eee42c6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/events/:eventId","description":"Returns a single event.
\n","urlObject":{"path":["sdk","v1.0","events",":eventId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"5d57d72f-8599-4e2a-a4ff-ecb379e723ad","type":"any","value":"14804","key":"eventId"}]}},"response":[{"id":"6374faa1-a1f1-4020-9ea2-c39aa9528db5","name":"Get an Event","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/events/14804"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:22:42 GMT"},{"key":"Content-Length","value":"1624"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"eventID\": 14804,\r\n \"startTime\": \"2019-03-28T14:00:00Z\",\r\n \"endTime\": \"2019-03-28T14:45:00Z\",\r\n \"prefix\": \"PD\",\r\n \"number\": 1,\r\n \"title\": \"How to make a sandwich\",\r\n \"description\": \"\",\r\n \"location\": \"Dallas\",\r\n \"courseID\": 7991,\r\n \"courseIsActiveOrRetired\": \"Active\",\r\n \"eventIsVisibleToLearningSite\": true,\r\n \"dateCreated\": \"2017-04-12T13:00:54.11Z\",\r\n \"dateEdited\": \"2020-01-30T16:37:37.86Z\",\r\n \"parentEventID\": null,\r\n \"instructorUrl\": \"/instructor/events/14804\",\r\n \"learnerUrl\": \"/learner/event?id=14804\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"eventID\": 14804,\r\n \"audienceID\": -9999,\r\n \"audience\": \"Everyone\"\r\n }\r\n ],\r\n \"departments\": [\r\n {\r\n \"eventID\": 14804,\r\n \"departmentID\": 2,\r\n \"department\": \"HR\"\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"eventID\": 14804,\r\n \"tagID\": 1189,\r\n \"tag\": \"Benchmark Topic 1\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"82fdf2f9-f888-45bc-a0c3-3047eee42c6f"}],"id":"29fc6556-cc3d-4a8b-9c79-315979dd12b2","_postman_id":"29fc6556-cc3d-4a8b-9c79-315979dd12b2","description":""},{"name":"Plans","item":[{"name":"Get Plans","id":"4806ee3b-b466-4869-85f0-52dc5fb9dde2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/plans?page=1&modifiedSince=2020-01-01&learnersCanOptIn=true","description":"Returns a page of 100 plans.
\n","urlObject":{"path":["sdk","v1.0","plans"],"host":["http://localhost/universitysite"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"modifiedSince","value":"2020-01-01"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"learnersCanOptIn","value":"true"}],"variable":[]}},"response":[{"id":"a15b0e2f-6f29-4200-b4a7-f533f06b8140","name":"Get Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/plans?page=1","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","plans"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:16:42 GMT"},{"key":"Content-Length","value":"25633"}],"cookie":[],"responseTime":null,"body":"[\r\n\t{\r\n\t \"attributes\": {\r\n\t \"planID\": 14,\r\n\t \"name\": \"Associates CE Program\",\r\n\t \"description\": \"Program OverviewReturns a single plan.
\n","urlObject":{"path":["sdk","v1.0","plans",":planId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"10b00fb7-ad3f-4135-a3ca-4d337fea0c2b","type":"any","value":"14","key":"planId"}]}},"response":[{"id":"edd5e099-7df8-49e0-8d83-c342c6b93bf4","name":"Get a Plan","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/plans/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:24:03 GMT"},{"key":"Content-Length","value":"1269"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"attributes\": {\r\n\t \"planID\": 289,\r\n\t \"name\": \"Skills Academy A\",\r\n\t \"description\": \"\",\r\n\t \"status\": \"Active\",\r\n\t \"learnersCanOptIn\": false,\r\n\t \"dateCreated\": \"2017-05-24T11:46:58.597Z\",\r\n\t \"dateEdited\": \"2019-04-01T14:15:16.337Z\",\r\n\t \"instructorUrl\": \"/instructor/plans/289\",\r\n\t \"learnerUrl\": \"/learner/plan?id=289\"\r\n\t},\r\n\t\"relationships\": {\r\n\t \"courses\": [\r\n\t {\r\n\t \"planID\": 289,\r\n\t \"displaySequenceNumber\": null,\r\n\t \"courseID\": 785,\r\n\t \"prefix\": \"XX\",\r\n\t \"number\": 101,\r\n\t \"title\": \"Personal Insights I\",\r\n\t \"onDemand\": 0,\r\n\t \"instructorLed\": 1,\r\n\t \"instructorUrl\": \"/instructor/courses/785\",\r\n\t \"learnerUrl\": \"/learner/course?id=785\",\r\n\t \"learnerPlayUrl\": null\r\n\t },\r\n\t {\r\n\t \"planID\": 289,\r\n\t \"displaySequenceNumber\": null,\r\n\t \"courseID\": 786,\r\n\t \"prefix\": \"XX\",\r\n\t \"number\": 102,\r\n\t \"title\": \"Personal Insights II\",\r\n\t \"onDemand\": 0,\r\n\t \"instructorLed\": 1,\r\n\t \"instructorUrl\": \"/instructor/courses/786\",\r\n\t \"learnerUrl\": \"/learner/course?id=786\",\r\n\t \"learnerPlayUrl\": null\r\n\t }\r\n\t ],\r\n\t \"tags\": []\r\n\t}\r\n}"}],"_postman_id":"4e4b433f-a73f-49b2-af0f-43c8ab0bb9a8"}],"id":"29e476dd-c25b-4f70-a559-8d3dd1962b33","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"18b1a10a-5c2f-4a63-9277-9ad148ae6bd1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8bcf6d8a-c3ba-462f-98d5-1c1cd88228ed"}}],"_postman_id":"29e476dd-c25b-4f70-a559-8d3dd1962b33","description":""},{"name":"Users","item":[{"name":"Get Users","id":"3ad14076-e983-46ad-b3fa-87c197340cdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users?page=1&modifiedSince=2020-01-01","description":"Returns a page of 100 users.
\nImportant Notes: Filtering for recently modified users with the modifiedSince param, returns users having a recently modified attribute, but does not account for changes to audience membership. For example, if a user is added to a new Audience, s/he is not considered recently modified. To ensure that a user's audience membership is up to date, we recommend calling the /users/:userId endpoint to obtain a fresh copy the current user's audiences when they login to an app you create with this API.
Required
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"modifiedSince","value":"2020-01-01"}],"variable":[]}},"response":[{"id":"6b530358-51c9-40e4-8187-ea894d2a0bae","name":"Get Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users?page=1","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","users"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:17:47 GMT"},{"key":"Content-Length","value":"18925"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"id\": 3,\r\n \"nameLF\": \"Anderson, Katrina\",\r\n \"name\": \"Katrina Anderson\",\r\n \"networkAlias\": \"kanderson\",\r\n \"eMail\": \"kanderson@firm.com\",\r\n \"lastName\": \"Anderson\",\r\n \"firstName\": \"Katrina\",\r\n \"section\": \"\",\r\n \"department\": \"\",\r\n \"jobTitle\": \"SkillSite\",\r\n \"workPhone\": \"\",\r\n \"lastLogin\": \"2012-11-06T21:03:07.737Z\",\r\n \"officeLocation\": \"Minneapolis\",\r\n \"managerNameLF\": \"Masters, Autumn\",\r\n \"managerName\": \"Autumn Masters\",\r\n \"isDisabled\": false,\r\n \"dateCreated\": null,\r\n \"dateEdited\": \"2019-06-26T20:26:52.897Z\",\r\n \"customFieldValue1\": \"\",\r\n \"customFieldValue2\": \"\",\r\n \"customFieldValue3\": \"\",\r\n \"customFieldValue4\": \"\",\r\n \"customFieldValue5\": \"\",\r\n \"customFieldValue6\": \"\",\r\n \"customFieldValue7\": \"\",\r\n \"customFieldValue8\": \"\",\r\n \"customFieldValue9\": \"\",\r\n \"customFieldValue10\": \"\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"userID\": 3,\r\n \"audienceID\": 14,\r\n \"audience\": \"All Users\"\r\n },\r\n {\r\n \"userID\": 3,\r\n \"audienceID\": 8,\r\n \"audience\": \"Litigation Secretaries\"\r\n },\r\n {\r\n \"userID\": 3,\r\n \"audienceID\": 29,\r\n \"audience\": \"New Everyone\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"id\": 9,\r\n \"nameLF\": \"Nelson, Wendy\",\r\n \"name\": \"Wendy Nelson\",\r\n \"networkAlias\": \"wnelson\",\r\n \"eMail\": \"wnelson@firm.com\",\r\n \"lastName\": \"Nelson\",\r\n \"firstName\": \"Wendy\",\r\n \"section\": \"\",\r\n \"department\": \"\",\r\n \"jobTitle\": \"SkillSite\",\r\n \"workPhone\": \"\",\r\n \"lastLogin\": \"2015-11-17T14:19:29.303Z\",\r\n \"officeLocation\": \"Minneapolis\",\r\n \"managerNameLF\": \"Wallace, Daniel\",\r\n \"managerName\": \"Daniel Wallace\",\r\n \"isDisabled\": false,\r\n \"dateCreated\": null,\r\n \"dateEdited\": \"2019-09-09T15:01:49.543Z\",\r\n \"customFieldValue1\": \"\",\r\n \"customFieldValue2\": \"\",\r\n \"customFieldValue3\": \"\",\r\n \"customFieldValue4\": \"\",\r\n \"customFieldValue5\": \"\",\r\n \"customFieldValue6\": \"\",\r\n \"customFieldValue7\": \"\",\r\n \"customFieldValue8\": \"\",\r\n \"customFieldValue9\": \"\",\r\n \"customFieldValue10\": \"\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"userID\": 9,\r\n \"audienceID\": 14,\r\n \"audience\": \"All Users\"\r\n },\r\n {\r\n \"userID\": 9,\r\n \"audienceID\": 29,\r\n \"audience\": \"New Everyone\"\r\n }\r\n ]\r\n }\r\n },\r\n]"}],"_postman_id":"3ad14076-e983-46ad-b3fa-87c197340cdb"},{"name":"Get a User (via userId)","id":"c84738b0-a0b5-4f13-a9ee-b48999f554c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:userId","description":"Returns a single user.
\n","urlObject":{"path":["sdk","v1.0","users",":userId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"90941d69-d245-406b-9618-107443f48878","type":"any","value":"5","key":"userId"}]}},"response":[{"id":"3c53cb83-ffe1-459a-97a3-0e70abd0490f","name":"Get a User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:25:41 GMT"},{"key":"Content-Length","value":"384"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"id\": 5,\r\n \"nameLF\": \"Crane, Michael\",\r\n \"name\": \"Michael Crane\",\r\n \"networkAlias\": \"MCrane\",\r\n \"eMail\": \"MCrane@Firm.com\",\r\n \"lastName\": \"Crane\",\r\n \"firstName\": \"Michael\",\r\n \"section\": \"\",\r\n \"department\": \"\",\r\n \"jobTitle\": \"SkillSite\",\r\n \"workPhone\": \"\",\r\n \"lastLogin\": \"2012-11-06T20:55:10.303Z\",\r\n \"officeLocation\": \"Chicago\",\r\n \"managerNameLF\": null,\r\n \"managerName\": null,\r\n \"isDisabled\": false,\r\n \"dateCreated\": null,\r\n \"dateEdited\": null,\r\n \"customFieldValue1\": \"\",\r\n \"customFieldValue2\": \"\",\r\n \"customFieldValue3\": \"\",\r\n \"customFieldValue4\": \"\",\r\n \"customFieldValue5\": \"\",\r\n \"customFieldValue6\": \"\",\r\n \"customFieldValue7\": \"\",\r\n \"customFieldValue8\": \"\",\r\n \"customFieldValue9\": \"\",\r\n \"customFieldValue10\": \"\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"userID\": 5,\r\n \"audienceID\": 14,\r\n \"audience\": \"All Users\"\r\n },\r\n {\r\n \"userID\": 5,\r\n \"audienceID\": 29,\r\n \"audience\": \"New Everyone\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"c84738b0-a0b5-4f13-a9ee-b48999f554c6"},{"name":"Get a User (via email)","id":"10e3770e-ad63-43e1-ad6c-9f00ed5a4872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:email","description":"Returns a single user.
\n","urlObject":{"path":["sdk","v1.0","users",":email"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"591a02da-c0c0-40e4-9282-aaf4b3649bd6","type":"any","value":"somebody@somewhere.com","key":"email"}]}},"response":[{"id":"a21cfdc4-6062-4fe4-8104-5a277a3f0e41","name":"Get a User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/MCraine@Firm.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:25:41 GMT"},{"key":"Content-Length","value":"384"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"id\": 5,\r\n \"nameLF\": \"Crane, Michael\",\r\n \"name\": \"Michael Crane\",\r\n \"networkAlias\": \"MCrane\",\r\n \"eMail\": \"MCrane@Firm.com\",\r\n \"lastName\": \"Crane\",\r\n \"firstName\": \"Michael\",\r\n \"section\": \"\",\r\n \"department\": \"\",\r\n \"jobTitle\": \"SkillSite\",\r\n \"workPhone\": \"\",\r\n \"lastLogin\": \"2012-11-06T20:55:10.303Z\",\r\n \"officeLocation\": \"Chicago\",\r\n \"managerNameLF\": null,\r\n \"managerName\": null,\r\n \"isDisabled\": false,\r\n \"dateCreated\": null,\r\n \"dateEdited\": null,\r\n \"customFieldValue1\": \"\",\r\n \"customFieldValue2\": \"\",\r\n \"customFieldValue3\": \"\",\r\n \"customFieldValue4\": \"\",\r\n \"customFieldValue5\": \"\",\r\n \"customFieldValue6\": \"\",\r\n \"customFieldValue7\": \"\",\r\n \"customFieldValue8\": \"\",\r\n \"customFieldValue9\": \"\",\r\n \"customFieldValue10\": \"\"\r\n },\r\n \"relationships\": {\r\n \"audiences\": [\r\n {\r\n \"userID\": 5,\r\n \"audienceID\": 14,\r\n \"audience\": \"All Users\"\r\n },\r\n {\r\n \"userID\": 5,\r\n \"audienceID\": 29,\r\n \"audience\": \"New Everyone\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"10e3770e-ad63-43e1-ad6c-9f00ed5a4872"},{"name":"Get a User's Plans (via userId)","id":"7c72918e-e967-4427-8e65-d115aa56b1ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:userId/plans","description":"Returns a list of plans assigned to a user along with the completion status for each plan, its courses, and its credits.
\nImportant Notes: This endpoint provides a list of plans assigned to a given user and their completion status. Since completion status frequently changes, for example after completing a course in a plan, it is critical for the completion status to be always up to date. We don't recommend using this API to crawl the plan completion status for evey user, instead, when a user of your app needs to be presented with their plans and completion status use this API in realtime.
\n","urlObject":{"path":["sdk","v1.0","users",":userId","plans"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"0c36325b-78d0-4c24-88af-d6987a8cb7ea","type":"any","value":"3","key":"userId"}]}},"response":[{"id":"22dedae4-2d01-4c1e-9d92-ae4959316b41","name":"Get a User's Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/3/plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:29:46 GMT"},{"key":"Content-Length","value":"1862"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21921,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2011\",\r\n \"percentComplete\": 100,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2011-06-29T20:38:01.663Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2011-12-31T23:59:59Z\",\r\n \"dateCompleted\": \"2011-05-06T16:00:00Z\",\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 36,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"PSC\",\r\n \"number\": 1,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21921,\r\n \"courseID\": 221,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21927,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-05-17T16:41:12.29Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 49,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"MS Excel\",\r\n \"number\": 103,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21927,\r\n \"courseID\": 113,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 16,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21927,\r\n \"courseID\": 188,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21930,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-07-26T21:27:28.39Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 54,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 8,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 171,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 9,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 172,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n }\r\n]"}],"_postman_id":"7c72918e-e967-4427-8e65-d115aa56b1ca"},{"name":"Get a User's Plans (via email)","id":"0fc2fbfe-3e34-4440-a327-8cb29fa3e51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:email/plans","description":"Returns a list of plans assigned to a user along with the completion status for each plan, its courses, and its credits.
\nImportant Notes: This endpoint provides a list of plans assigned to a given user and their completion status. Since completion status frequently changes, for example after completing a course in a plan, it is critical for the completion status to be always up to date. We don't recommend using this API to crawl the plan completion status for evey user, instead, when a user of your app needs to be presented with their plans and completion status use this API in realtime.
\n","urlObject":{"path":["sdk","v1.0","users",":email","plans"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"d0513aad-07dd-4519-af68-27a197dfc57c","type":"any","value":"somebody@somewhere.com","key":"email"}]}},"response":[{"id":"540b50e0-089a-4749-a16a-32baf4525b7e","name":"Get a User's Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:email/plans","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","users",":email","plans"],"variable":[{"key":"email","value":"kanderson@firm.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:29:46 GMT"},{"key":"Content-Length","value":"1862"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21921,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2011\",\r\n \"percentComplete\": 100,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2011-06-29T20:38:01.663Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2011-12-31T23:59:59Z\",\r\n \"dateCompleted\": \"2011-05-06T16:00:00Z\",\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 36,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"PSC\",\r\n \"number\": 1,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21921,\r\n \"courseID\": 221,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21927,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-05-17T16:41:12.29Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 49,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"MS Excel\",\r\n \"number\": 103,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21927,\r\n \"courseID\": 113,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 16,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21927,\r\n \"courseID\": 188,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n },\r\n {\r\n \"attributes\": {\r\n \"planProgressID\": 21930,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-07-26T21:27:28.39Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 54,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 8,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 171,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 9,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 172,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n }\r\n]"}],"_postman_id":"0fc2fbfe-3e34-4440-a327-8cb29fa3e51b"},{"name":"Get a User's Course Learning Activity (via userId)","id":"c5a7b744-fa92-4f66-ae08-0461c6f2c4c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:userId/course-learning-activity","description":"Returns a list of courses a user has interacted with.
\n","urlObject":{"path":["sdk","v1.0","users",":userId","course-learning-activity"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"9218f7a5-0942-4c24-aab1-ca78a330f4dc","type":"any","value":"1","key":"userId"}]}},"response":[{"id":"b9236b10-c7f7-48cf-ab68-3167c811e4c6","name":"Get a User's Course Learning Activity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 825b7cfe-a33f-4608-b415-942c7113c3ee","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:userId/course-learning-activity","host":["http://localhost/universitysite"],"path":["sdk","v1.0","users",":userId","course-learning-activity"],"variable":[{"key":"userId","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Tue, 13 Oct 2020 20:38:52 GMT"},{"key":"Content-Length","value":"21705"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"courseID\": 7998,\n \"course\": \"Firm-18: Firm Policy Review\",\n \"date\": \"2020-09-30T16:26:05.193Z\",\n \"status\": \"Incomplete\"\n },\n {\n \"courseID\": 7998,\n \"course\": \"Firm-18: Firm Policy Review\",\n \"date\": \"2020-09-30T16:25:28.953Z\",\n \"status\": \"Completed Successfully\"\n }\n]"}],"_postman_id":"c5a7b744-fa92-4f66-ae08-0461c6f2c4c8"},{"name":"Get a User's Course Learning Activity (via email)","id":"3370c775-f1e2-4d6f-8cc4-21d251e63661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:email/course-learning-activity","description":"Returns a list of courses a user has interacted with.
\n","urlObject":{"path":["sdk","v1.0","users",":email","course-learning-activity"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"edff3263-f153-4e9e-9b3a-4fff94278c33","type":"any","value":"somebody@somewhere.com","key":"email"}]}},"response":[{"id":"e032fe2d-3835-4ce9-968f-73af624cea2c","name":"Get a User's Course Learning Activity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer 825b7cfe-a33f-4608-b415-942c7113c3ee","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:email/course-learning-activity","host":["http://localhost/universitysite"],"path":["sdk","v1.0","users",":email","course-learning-activity"],"variable":[{"key":"email","value":"kanderson@firm.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Tue, 13 Oct 2020 20:38:52 GMT"},{"key":"Content-Length","value":"21705"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"courseID\": 7998,\n \"course\": \"Firm-18: Firm Policy Review\",\n \"date\": \"2020-09-30T16:26:05.193Z\",\n \"status\": \"Incomplete\"\n },\n {\n \"courseID\": 7998,\n \"course\": \"Firm-18: Firm Policy Review\",\n \"date\": \"2020-09-30T16:25:28.953Z\",\n \"status\": \"Completed Successfully\"\n }\n]"}],"_postman_id":"3370c775-f1e2-4d6f-8cc4-21d251e63661"},{"name":"Get a User's Plan (via userId)","id":"b0d5c7cc-a5a3-4cae-aabc-34e673049ad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:userId/plans/:planId","description":"Returns a plans assigned to a user along with the completion status for each plan, its courses, and its credits.
\nImportant Notes: This endpoint provides information about a specific plan assigned to a given user and its completion status. Since completion status frequently changes, for example after completing a course in a plan, it is critical for the completion status to be always up to date. We don't recommend using this API to crawl the plan completion status for plan, instead, when a user of your app is presented with their plan and completion status use this API in realtime.
\n","urlObject":{"path":["sdk","v1.0","users",":userId","plans",":planId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"f4293b24-a302-4d2c-82cf-cc164384796b","type":"any","value":"3","key":"userId"},{"id":"527b5cd0-b6e7-47e4-a2e4-3cd1f7cfe6ae","type":"any","value":"54","key":"planId"}]}},"response":[{"id":"89af3f8c-1d37-4c9f-a620-8f97c20311ed","name":"Get a User's Plan","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:userId/plans/:planId","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","users",":userId","plans",":planId"],"variable":[{"key":"userId","value":"3"},{"key":"planId","value":"54"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:38:15 GMT"},{"key":"Content-Length","value":"656"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"planProgressID\": 21930,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-07-26T21:27:28.39Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 54,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 8,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 171,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 9,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 172,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n}"}],"_postman_id":"b0d5c7cc-a5a3-4cae-aabc-34e673049ad8"},{"name":"Get a User's Plan (via email)","id":"9fd2c9cc-e53f-4980-9ffb-0d4381d7ce29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:email/plans/:planId","description":"Returns a plans assigned to a user along with the completion status for each plan, its courses, and its credits.
\nImportant Notes: This endpoint provides information about a specific plan assigned to a given user and its completion status. Since completion status frequently changes, for example after completing a course in a plan, it is critical for the completion status to be always up to date. We don't recommend using this API to crawl the plan completion status for plan, instead, when a user of your app is presented with their plan and completion status use this API in realtime.
\n","urlObject":{"path":["sdk","v1.0","users",":email","plans",":planId"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"82d6dbbb-41f1-47e4-94e9-26e4b46487b4","type":"any","value":"somebody@somewhere.com","key":"email"},{"id":"4b409124-f73d-4b3e-96ae-11777fd9d1e1","type":"any","value":"54","key":"planId"}]}},"response":[{"id":"0d3bfc4f-1945-4915-a253-f4297b0e6687","name":"Get a User's Plan","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:email/plans/:planId","protocol":"http","host":["localhost"],"path":["universitysite","sdk","v1.0","users",":email","plans",":planId"],"variable":[{"key":"email","value":"kanderson@firm.com"},{"key":"planId","value":"54"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"api-supported-versions","value":"1.0"},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Date","value":"Fri, 29 Nov 2019 17:38:15 GMT"},{"key":"Content-Length","value":"656"}],"cookie":[],"responseTime":null,"body":"{\r\n \"attributes\": {\r\n \"planProgressID\": 21930,\r\n \"email\": \"kanderson@firm.com\",\r\n \"learningPlan\": \"Learning Plan for 2012\",\r\n \"percentComplete\": 0,\r\n \"enrollmentType\": \"Assigned\",\r\n \"dateEnrolled\": \"2012-07-26T21:27:28.39Z\",\r\n \"periodStartDate\": null,\r\n \"periodDeadlineDate\": \"2012-12-31T23:59:59Z\",\r\n \"dateCompleted\": null,\r\n \"periodDesignation\": \"Current Period\",\r\n \"planID\": 54,\r\n \"userID\": 3\r\n },\r\n \"relationships\": {\r\n \"courses\": [\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 8,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 171,\r\n \"userID\": 3\r\n },\r\n {\r\n \"email\": \"kanderson@firm.com\",\r\n \"prefix\": \"eLearning\",\r\n \"number\": 9,\r\n \"isComplete\": 0,\r\n \"planProgressID\": 21930,\r\n \"courseID\": 172,\r\n \"userID\": 3\r\n }\r\n ],\r\n \"credits\": []\r\n }\r\n}"}],"_postman_id":"9fd2c9cc-e53f-4980-9ffb-0d4381d7ce29"},{"name":"Get Latest Additions to a User's Plans (via userId)","id":"db5cd248-5277-48a7-b7fb-36764f3ea7fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:userId/plans/additions","description":"Returns a list of the most recently added courses or events that apply to any of the user's plans.
\nThe list will only include courses that the user has not yet completed. On-demand courses will be included based on when they were added to the plan. Events will be included based on the date that they were created. Only the single most recent addition, across all of the user's plans, will be included for each course.
\n","urlObject":{"path":["sdk","v1.0","users",":userId","plans","additions"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"8acffe6b-73e9-4a97-a7b7-337a861ab446","type":"any","value":"3","key":"userId"}]}},"response":[{"id":"fb37f16e-72f5-4eee-8de8-c3bdee58aa15","name":"Get Latest Additions to a User's Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:userId/plans/additions","host":["http://localhost/universitysite"],"path":["sdk","v1.0","users",":userId","plans","additions"],"variable":[{"key":"userId","value":"3"}]}},"status":"- OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"dateAdded\": \"2020-03-16T13:33:58.633Z\",\n \"courseId\": 26129,\n \"eventId\": 45986,\n \"title\": \"AAA 62: Instructor-led Course\",\n \"learnerUrl\": \"/learner/event?id=45986\",\n \"learnerPlayUrl\": null\n },\n {\n \"dateAdded\": \"2020-03-16T12:34:17.8Z\",\n \"courseId\": 26130,\n \"eventId\": null,\n \"title\": \"On-Demand Course\",\n \"learnerUrl\": \"/learner/course?id=26130\",\n \"learnerPlayUrl\": \"/learner/course?id=26130&play=1\"\n }\n]"}],"_postman_id":"db5cd248-5277-48a7-b7fb-36764f3ea7fe"},{"name":"Get Latest Additions to a User's Plans (via email)","id":"3cba51d9-fcaf-495d-8609-dcaf88509729","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"http://localhost/universitysite/sdk/v1.0/users/:email/plans/additions","description":"Returns a list of the most recently added courses or events that apply to any of the user's plans.
\nThe list will only include courses that the user has not yet completed. On-demand courses will be included based on when they were added to the plan. Events will be included based on the date that they were created. Only the single most recent addition, across all of the user's plans, will be included for each course.
\n","urlObject":{"path":["sdk","v1.0","users",":email","plans","additions"],"host":["http://localhost/universitysite"],"query":[],"variable":[{"id":"e14d3424-f4d5-4277-8abf-938015bef937","type":"any","value":"somebody@somewhere.com","key":"email"}]}},"response":[{"id":"f72c37ea-f715-4d59-8766-0be74885ab4f","name":"Get Latest Additions to a User's Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer e58aca93-e640-43ec-a0cc-a68d69baa081","type":"text"}],"url":{"raw":"http://localhost/universitysite/sdk/v1.0/users/:email/plans/additions","host":["http://localhost/universitysite"],"path":["sdk","v1.0","users",":email","plans","additions"],"variable":[{"key":"email","value":"kanderson@firm.com"}]}},"status":"- OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"dateAdded\": \"2020-03-16T13:33:58.633Z\",\n \"courseId\": 26129,\n \"eventId\": 45986,\n \"title\": \"AAA 62: Instructor-led Course\",\n \"learnerUrl\": \"/learner/event?id=45986\",\n \"learnerPlayUrl\": null\n },\n {\n \"dateAdded\": \"2020-03-16T12:34:17.8Z\",\n \"courseId\": 26130,\n \"eventId\": null,\n \"title\": \"On-Demand Course\",\n \"learnerUrl\": \"/learner/course?id=26130\",\n \"learnerPlayUrl\": \"/learner/course?id=26130&play=1\"\n }\n]"}],"_postman_id":"3cba51d9-fcaf-495d-8609-dcaf88509729"}],"id":"6921a0e4-f520-4d3f-a384-93e62523d3b5","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"58ddab11-43f5-445e-9ce8-3f7f9885eab2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8474d413-fd49-48d6-841a-fca408a007a6"}}],"_postman_id":"6921a0e4-f520-4d3f-a384-93e62523d3b5","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f797474b-f445-41b9-b488-7fa9103547ef"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"699765bd-d545-4631-8401-0a5acdbbce3c"}}],"variable":[{"key":"baseUrl","value":"http://localhost/universitysite"}]}