{"info":{"_postman_id":"b9c99bc3-dc1f-47e7-8ed3-a600c34024d5","name":"Vocareum API v2","description":"

The Vocareum API enables you to manage all aspects of your Vocareum courses. It offers endpoints to help you with courses, assignments, enrollment, and grading.

Request Format

Built on RESTful principles, the Vocareum API uses HTTP methods and verbs. Requests should be made using JSON, and JSON is returned by all responses.

Authentication

The Vocareum API requires an application-specific token in every request to verify the user. The token is passed in the HTTP Authorization header:

Authorization: Token {{vocareum-authentication-token}}

Please request token(s) from Vocareum at support@vocareum.com.

Error Codes

Vocareum APIs use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error caused by the information provided (i.e., a required parameter was omitted, a method was not found, etc.), and codes in the 5xx range indicate an error with Vocareum’s servers (these are rare).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Status Text	Description
200	OK	The request has succeeded. The meaning of a success varies depending on the HTTP method:GET: The resource has been fetched and is transmitted in the message body.POST: The resource describing the result of the action is transmitted in the message body
202	Accepted	The request has been recieved and accepted for processing.
400	Bad Request	This response means that server could not understand the request due to invalid syntax. Possibly API call method or URL path is incorrect.
400	Missing Token	This response means token was not included as part of request.
400	Invalid Token	This response means that an invalid token was presented.
400	Token Expired	This response means that token is no longer valid for the request.
400	Course id not specified	This response means that course id was not included as part of request.
400	Invalid course	This response means that no course could be found with the course id.
403	Access Forbidden	Client does not have access rights to the content so server is refusing to give proper response.
404	Not Found	Server cannot find the requested resource.
429	Too Many Requests	The user has sent too many requests in a given amount of time (“rate limiting”).
500	Internal Server Error	There was an error in one of Vocareum's servers while trying to complete the request. Please contact support@vocareum.com.

Rate limit

Vocareum's REST API currently has a rate limit of 800 requests per minute.

Currently it is not configurable but that can change in the future, please contact support@vocareum.com for more information.

Base URL

The Vocareum API is served over HTTPS. All URLs referenced in the documentation have the following base:

https://api.vocareum.com/api/v2/

Pagination

For GET API calls that return multiple records (courses, assignment, users, parts), we paginate the results and return up to 10 results per page to make sure that responses are easier to handle.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Request Format","slug":"request-format"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"},{"content":"Base URL","slug":"base-url"},{"content":"Pagination","slug":"pagination"}],"owner":"6736336","collectionId":"b9c99bc3-dc1f-47e7-8ed3-a600c34024d5","publishedId":"S11Exg4b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-03-26T04:35:50.000Z"},"item":[{"name":"Requests","item":[{"name":"Courses","event":[{"listen":"test","script":{"id":"bbdcdb3b-a077-4409-a060-9ea601421288","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"c1854e38-2f2a-4c6b-8979-e73423619dc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"page\": \"1\"\n}"},"url":"https://api.vocareum.com/api/v2/courses","description":"

Request list of courses.

Body is a json object to include the following optional parameters:

page - indicate which page of records to retrieve (default=0)
name - search string

\n","urlObject":{"protocol":"https","path":["api","v2","courses"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"9d21c413-f7dc-49c3-b0da-a1fd4fc49b57","name":"Courses","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 04:40:02 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b7bce93cafb92ca-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"courses\": [\n {\n \"id\": \"4091\",\n \"name\": \"Sample Course\",\n \"start_date\": \"Mar-14-2019 12:00:00 am PDT\",\n \"end_date\": \"Dec-31-2019 12:00:00 am PST\",\n \"access_end_date\": \"Jan-30-2020 12:00:00 am PST\",\n \"start_date_utc\": \"2019-03-14T07:00:00\",\n \"end_date_utc\": \"2019-12-31T08:00:00\",\n \"access_end_date_utc\": \"2020-01-30T08:00:00\",\n \"uselti\": true,\n \"timezone\": \"America\\/Los_Angeles\",\n \"parent_id\": \"\",\n \"cloud_enabled\": true,\n \"awsregion\": \"us-west-2\",\n \"show_all_submissions\": true,\n \"noworkarea\": false,\n \"lti_credentials\": [\n {\n \"consumer_key\": \"vc_2_0_5c8b1c096ce28key5c8b1xxxx\",\n \"secret\": \"639d2f02220xxxx\"\n }\n ]\n }\n ]\n}"},{"id":"f2f0a047-6f62-4945-bdd9-50bf5d553a11","name":"Courses - Search","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"test\"\n}"},"url":"https://api.vocareum.com/api/v2/courses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Sep 2019 18:49:24 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"511224a84bb8962f-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"courses\": [\n {\n \"id\": \"4101\",\n \"name\": \"Test Classroom\",\n \"start_date\": \"Mar-15-2019 12:00:00 am PDT\",\n \"end_date\": \"Dec-31-2019 12:00:00 am PST\",\n \"parent_id\": \"\"\n },\n {\n \"id\": \"5410\",\n \"name\": \"API TEST MASTER\",\n \"start_date\": \"Jun-14-2019 12:00:00 am PDT\",\n \"end_date\": \"Oct-31-2019 12:00:00 am PDT\",\n \"parent_id\": \"\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"c1854e38-2f2a-4c6b-8979-e73423619dc4"},{"name":"Courses - Clone","event":[{"listen":"test","script":{"id":"bbdcdb3b-a077-4409-a060-9ea601421288","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"10777ea3-59a1-49d7-bb36-25be0d71bb45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"method\": \"copy\",\n \"name\": \"MyCourse Copy\",\n \"source\": \"{source-courseid}\",\n \"orgid\": \"{target-orgid}\",\n \"start_date_utc\": \"2018-06-27\",\n \"end_date_utc\": \"2018-12-31\",\n \"timezone\": \"{timezone_string}\",\n \"inherit_publish\": \"1\",\n \"teacher_emails\": \n \"teacher1@myemail.com, teacher2@myemail.edu\",\n \"awsregion\": \"us-east-1\",\n \"lti_anonymous\": false\n}"},"url":"https://api.vocareum.com/api/v2/courses","description":"

Creates a duplicate copy of an existing course.

Body is a json object to include the following parameters:

method - copy | reference (required)
name - string name for the new course (required)
source - course-id of the source course to copy (required)
start_date_utc - UTC-encoded date (required)
end_date_utc - UTC-encoded date (required)
inherit_publish - inherit publish status of assignments from source course (boolean) (default = 1 (true))
orgid - target organization for the new course
teacher_emails - string containing comma-separated list of teacher email addresses
awsregion - target region for AWS resources
lti_anonymous - toggles a course's lti anonymous setting [true = on, false = off] (boolean)
timezone - {{timezone_string}} Supported timezones at https://labs.vocareum.com/main/main.php?m=timezones

Returns \"transactionid\" to which may be queried to retrieve request status.

NOTE: when the copy method is by \"reference\", content of the cloned course will be a direct link to the source course and be read-only.

\n","urlObject":{"protocol":"https","path":["api","v2","courses"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"97790285-5339-4eb7-b107-26512abb6baa","name":"Courses - Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"reference\",\n \"name\": \"MyCourse Copy\",\n \"orgid\": \"{target-org}\",\n \"source\": \"{source-courseid}\",\n \"start_date_utc\": \"2018-06-27\",\n \"end_date_utc\": \"2018-12-31\",\n \"timezone\": \"America/Los_Angeles\",\n \"teacher_emails\": \"{teacher-email1}, {teacher-email2}\",\n \"awsregion\": \"us-west-2\",\n \"lti_anonymous\": false\n}"},"url":"https://api.vocareum.com/api/v2/courses"},"status":"Accepted","code":202,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Fri, 28 Jun 2019 05:14:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4edd2d395981d0f4-SJC"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Started\",\"transactionid\":\"21\",\"objid\":\"5681\"}"}],"_postman_id":"10777ea3-59a1-49d7-bb36-25be0d71bb45"},{"name":"Course","id":"e5949f83-5ae4-453d-afb6-7590d1362331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}","description":"

Request details for a specified course.

Update setting(s) for a course.

All parameters are optional. Body is a json object to include the following parameters:

name - new name for course (optional)
\n
orgid - target organization for the new course (optional)
\n
awsregion - target region for AWS resources
\n
teacher_emails - string containing comma-separated list of teacher email addresses (optional)
\n
teacher_editable - controls whether course assignments are editable by instructors (boolean) (optional)
\n
uselti - boolean
\n
timezone - string (Supported timezones at https://labs.vocareum.com/main/main.php?m=timezones)
\n
start_date_utc - string (UTC format YYYY-MM-DDThh:mm:ss e.g. 2020-05-30T07:00:00)
\n
end_date_utc - string
\n
access_end_date_utc - string
\n
cloud_enabled - boolean
\n
show_all_submissions - boolean
\n
noworkarea - boolean
\n
lti_anonymous - toggles a course's lti anonymous setting [true = on, false = off] (boolean)
\n
enable_grading - boolean
\n
feedback - boolean
\n
update_children - array of strings for which options to update for a course's children (optional)
\n
- array values can be \"rubrics\", \"new assignments\", and \"lab configuration\"
\n

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"07a76844-5fb6-4271-af73-452ca0565fd7","name":"Course - Settings","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"new course name\",\r\n \"orgid\": \"{target-org}\",\r\n \"teacher_emails\": \"{teacher-email1}, {teacher-email2}\",\r\n \"teacher_editable\": \"true\",\r\n \"cloud_enabled\": true,\r\n \"awsregion\": \"us-west-2\",\r\n \"show_all_submissions\": true,\r\n \"noworkarea\": false,\r\n \"lti_anonymous\": false\r\n}","options":{"raw":{"language":"text"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jul 2020 22:34:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"04151c8b7c000004b82ba40200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b68638bfc5604b8-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"2325\",\n \"objid\": \"4091\"\n}"},{"id":"1319e738-b60c-4ffc-a7cf-968bcf5f2dbe","name":"Course - Settings","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"new course name\",\r\n \"orgid\": \"{target-org}\",\r\n \"teacher_emails\": \"{teacher-email1}, {teacher-email2}\",\r\n \"teacher_editable\": \"true\",\r\n \"cloud_enabled\": true,\r\n \"awsregion\": \"us-west-2\",\r\n \"show_all_submissions\": true,\r\n \"noworkarea\": false,\r\n \"lti_anonymous\": false\r\n}","options":{"raw":{"language":"text"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jul 2020 22:34:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"04151c8b7c000004b82ba40200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b68638bfc5604b8-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"2325\",\n \"objid\": \"4091\"\n}"}],"_postman_id":"e2651624-c7f9-475b-86b8-fce10440ff15"},{"name":"Course - Assignment Ordering","id":"847d716b-2273-411f-9a94-4e2d2f68b478","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"assignments_order\" :\n [[\"1\", \"46178\"], [\"2\", \"46181\"]]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}","description":"

Request details for a specified course.

Request details for all assignments in a course.

Body is a json object to include the following optional parameters:

page - indicate which page of records to retrieve (default=0)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"1231dfad-2da4-46f8-9216-7e91dbc1f30f","name":"Assignments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Mar 2019 23:52:31 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bf5c208fddf6c94-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"assignments\": [\n {\n \"id\": \"46178\",\n \"courseid\": \"4091\",\n \"name\": \"My First Assignment\",\n \"deleted\": \"0\",\n \"published\": \"1\",\n \"nosubmit\": false,\n \"num_parts\": \"3\",\n \"part_ids\": [\n 123456,\n 123457,\n 123458\n ],\n \"gradespublished\": false,\n \"auto_submit\": false,\n \"grading_on_submit\": true,\n \"noworkarea\": false,\n \"masterid\": \"\",\n \"create_method\": \"\",\n \"groupid\": \"0\",\n \"groupdisplayorder\": \"1\",\n \"lti_on\": \"1\",\n \"lti_url\": \"{{lti_url_value}}\"\n },\n {\n \"id\": \"46181\",\n \"courseid\": \"4091\",\n \"name\": \"Assignment 2\",\n \"deleted\": \"0\",\n \"published\": \"1\",\n \"nosubmit\": false,\n \"num_parts\": \"1\",\n \"part_ids\": [\n 123459\n ],\n \"gradespublished\": true,\n \"auto_submit\": false,\n \"grading_on_submit\": true,\n \"noworkarea\": false,\n \"masterid\": \"111111\",\n \"create_method\": \"Clone by Copy\",\n \"groupid\": \"0\",\n \"groupdisplayorder\": \"2\",\n \"lti_on\": \"1\",\n \"lti_url\": \"{{lti_url_value}}\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"e0aa4771-4656-495d-9707-8329cbb6d853"},{"name":"Assignment","id":"d86bd2f2-d1e6-46b4-8c20-a870f2c373e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}","description":"

Request details for specified assignment in a course.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"78c95691-f220-4e97-921d-4837efe9e5ce","name":"Assignment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Mar 2019 23:54:18 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bf5c4a6ba366c94-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"assignments\": [\n {\n \"id\": \"46178\",\n \"courseid\": \"4091\",\n \"name\": \"My First Assignment\",\n \"deleted\": \"0\",\n \"published\": \"1\",\n \"nosubmit\": false,\n \"num_parts\": \"2\",\n \"part_ids\": [\n 121212,\n 121213\n ],\n \"gradespublished\": true,\n \"auto_submit\": false,\n \"grading_on_submit\": true,\n \"noworkarea\": false,\n \"groupid\": \"1\",\n \"groupdisplayorder\": \"1\",\n \"lti_on\": \"1\",\n \"lti_url\": \"{{lti_url_value}}\"\n }\n ]\n}"}],"_postman_id":"d86bd2f2-d1e6-46b4-8c20-a870f2c373e3"},{"name":"Assignments - Create","id":"e3fde0c7-4d81-4baa-9a8b-696050697285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"create\",\n \"name\": \"created assignment name\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments","description":"

Creates an assignment for a course.

Body is a json object to include the following parameters:

method - create (required)
name - name for the new assignment (required)

Returns \"transactionid\" to which may be queried to retrieve request status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"0506a6ae-e576-413c-8cd0-ea629d852b55","name":"Assignments - Create","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"create\",\n \"name\": \"created assignment name\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jun 2019 04:51:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4edd0b891aea6d6a-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"18\",\n \"objid\": \"\"\n}"}],"_postman_id":"e3fde0c7-4d81-4baa-9a8b-696050697285"},{"name":"Assignments - Copy","id":"dd296141-4f9f-4a67-9303-dee2f9e3bbbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"copy\",\n \"source\": \"{source-assignmentId}\", \n \"name\": \"assignment copy\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments","description":"

Copy an assignment into a course.

Body is a json object to include the following parameters:

method - 'copy' or 'reference' (required)
source - assignment id for the originating assignment (required)
name - name for the new assignment (optional)

Returns \"transactionid\" to which may be queried to retrieve request status.

NOTE: the source assignment may be from any course to which you have administrative access.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"c29ec8e5-fda8-4efe-9ff6-4db0822b1683","name":"Assignments - Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"copy\",\n \"source\": \"{source-assignmentId}\", \n \"name\": \"assignment copy\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jun 2019 04:51:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4edd0b891aea6d6a-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"18\",\n \"objid\": \"\"\n}"}],"_postman_id":"dd296141-4f9f-4a67-9303-dee2f9e3bbbe"},{"name":"Assignment - Settings","id":"96b91880-8d22-450f-95bc-ab5af6d93cce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"new assignment name\",\r\n \"description\": \"assignment description goes here\",\r\n \"nosubmit\": false,\r\n \"publish\": true,\r\n \"publish_grades\": true,\r\n \"auto_submit\": false,\r\n \"grading_on_submit\": true,\r\n \"noworkarea\": false,\r\n \"exam_mode\":\"timed\",\r\n \"exam_duration\": 30,\r\n \"num_attempts\": 2,\r\n \"show_end_exam_button\": true,\r\n \"copy_startercode\": true,\r\n \"uncompressupload\": true,\r\n \"lti_on\": false,\r\n \"send_webhook\": false,\r\n \"grading_visibility\":\"assigned\",\r\n \"anonymous_grading\":true,\r\n \"live_code_comments\":false\r\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}","description":"

Update parameter setting(s) for a given assignment.

All parameters are optional. Body is a json object to include the following parameters:

name - string
description - string
nosubmit - boolean
publish - boolean
publish_grades - string
auto_submit - boolean
grading_on_submit - boolean
noworkarea - boolean
exam_mode - [\"timed\", \"scheduled\", or \"timed_scheduled\"]
exam_duration - integer
num_attempts - integer
show_end_exam_button - boolean
copy_startercode - boolean
uncompressupload - boolean
lti_on - boolean
anonymous_grading - boolean
grading_visibility - [\"all\" or \"assigned\"]
send_webhook - boolean
live_code_comments - boolean

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"6eed86b6-1d69-4e4d-ae66-40ec30b970f6","name":"Assignment - Settings","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"new assignment name\",\r\n \"description\": \"assignment description goes here\",\r\n \"nosubmit\": false,\r\n \"grading_on_submit\": true,\r\n \"exam_mode\":\"timed\",\r\n \"exam_duration\": 30,\r\n \"num_attempts\": 2,\r\n \"show_end_exam_button\": true,\r\n \"copy_startercode\": true,\r\n \"uncompressupload\": true,\r\n \"lti_on\": false,\r\n \"send_webhook\": false,\r\n \"grading_visibility\":\"assigned\",\r\n \"anonymous_grading\":true\r\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jul 2020 22:41:26 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"04152306ef0000e79c010ca200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b686deb1a4fe79c-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"2326\",\n \"objid\": \"46178\"\n}"}],"_postman_id":"96b91880-8d22-450f-95bc-ab5af6d93cce"},{"name":"Assignments","id":"05943ef6-f597-49ff-985d-ae7ea40353ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}","description":"

Deletes the specified assignment.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"2105602a-3f09-4882-990b-b76fbc528efd","name":"Assignments","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:43:34 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b804a596c176d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Assignment successfully deleted\"\n}"}],"_postman_id":"05943ef6-f597-49ff-985d-ae7ea40353ec"},{"name":"Parts","id":"d8aa268b-6659-4cb7-8739-3c95ec8f5e62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"page\":\"{{page-number}}\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts","description":"

Request list of parts for specified assignment in a course.

Body is a json object to include the following optional parameters:

page - indicate which page of records to retrieve (default=0)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"a9c53406-1f00-4aa5-a8ea-535e28a9c735","name":"Parts","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:42:06 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b80482fff356d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"parts\": [\n {\n \"id\": \"46179\",\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"name\": \"Part1\",\n \"seqnum\": \"0\",\n \"deleted\": \"0\",\n \"part_url\": \"https://labs.vocareum.com/main/main.php?m=editor&nav=1&asnid=46178&stepid=46179\",\n \"cloud_labs\": false,\n \"instant_aws_access\": false,\n \"session_length\": \"0\",\n \"monthly_dollar\": \"0\",\n \"monthly_time\": \"0\",\n \"total_time\": \"0\",\n \"total_dollar\": \"0\"\n },\n {\n \"id\": \"46180\",\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"name\": \"Part2\",\n \"seqnum\": \"1\",\n \"deleted\": \"0\",\n \"part_url\": \"https://labs.vocareum.com/main/main.php?m=editor&nav=1&asnid=46178&stepid=46180\",\n \"cloud_labs\": false,\n \"instant_aws_access\": false,\n \"session_length\": \"0\",\n \"monthly_dollar\": \"0\",\n \"monthly_time\": \"0\",\n \"total_time\": \"0\",\n \"total_dollar\": \"0\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"d8aa268b-6659-4cb7-8739-3c95ec8f5e62"},{"name":"Part","id":"4fa3f4e3-008a-4c76-9d27-b208603e1a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}","description":"

Request details for a part in specified assignment in a course.

Retrieve details for a student in a given part.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","part_details","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"dfde6ab5-6192-4aa5-a960-b747c66667b5","name":"Part - User Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/part_details/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Aug 2019 21:25:27 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"505dc2fe2fad1ed5-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"part_details\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sso_url\": \"https://signin.vocareum.com/main/main.php?m=sso&ssotoken=B6syxweJ8SmZZ5pTQeYdPQ0NeRINBBJkpqT8ApFMWrATJzob%2Bij%2FN1MJFQ6vQG9d1%2Fv2MTvUalI6jZpFzp3sXmeHYGSNjiX1xrI%2BbZQO&key=cf0133f460b5961d2cb8f523f9515de3\"\n }\n ]\n}"}],"_postman_id":"51b2ca0d-8957-4671-be6d-22b108009e7e"},{"name":"Part - User Details","id":"c546a314-3c3b-4b8b-8409-e223db512965","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"custom_env\": {\n \"VOC_ANTHROPIC_TEST_VAR\": \"voc-anthropic-test-dummy322432432\",\n \"VOC_OPENAI_TEST_VAR\": \"voc-openai-test-key-dummy432423423\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/part_details/{{userId}}","description":"

Set some details for a student in a given part. e.g. one can set the environment variables for them which will be available when they are in their labs or containers by using custom_env in the JSON data.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","part_details","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"bdb8941a-5726-4740-89fa-b466926855d2","name":"Part - User Details","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"custom_env\": {\n \"VOC_ANTHROPIC_TEST_VAR\": \"voc-anthropic-test-dummy322432432\",\n \"VOC_OPENAI_TEST_VAR\": \"voc-openai-test-key-dummy432423423\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/part_details/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 13 Aug 2019 21:25:27 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"505dc2fe2fad1ed5-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"part_details\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sso_url\": \"https://signin.vocareum.com/main/main.php?m=sso&ssotoken=B6syxweJ8SmZZ5pTQeYdPQ0NeRINBBJkpqT8ApFMWrATJzob%2Bij%2FN1MJFQ6vQG9d1%2Fv2MTvUalI6jZpFzp3sXmeHYGSNjiX1xrI%2BbZQO&key=cf0133f460b5961d2cb8f523f9515de3\"\n }\n ]\n}"}],"_postman_id":"c546a314-3c3b-4b8b-8409-e223db512965"},{"name":"Part - Rubrics","id":"399ea32b-a1e3-4540-a090-2b7e10538f99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"page\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics","description":"

Retrieve details for the rubrics for a given part.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","rubrics","{{rubricId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"55844b78-2553-45be-86f7-772b7125915f","name":"Part - Rubric","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics/{{rubricId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jul 2020 04:29:48 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"03fca22958000096175f1eb200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b4139555b729617-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"parent\": {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\"\n },\n \"rubrics\": [\n {\n \"id\": \"65279\",\n \"name\": \"score1\",\n \"seqnum\": \"1\",\n \"maxscore\": \"5\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ]\n}"}],"_postman_id":"2362735a-9208-4220-95f9-78528b80f368"},{"name":"Part - Create","id":"626cb3d2-5c5c-4804-a32b-e8a1c1c9aa41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"create\",\n \"name\": \"part create\",\n \"labtype\": \"Vocareum Elite\",\n \"lab_interface\": {\n \"panels\": [\"Source\", \"Console\", \"File Browser\", \"Nav Bar\"],\n \"controls\":[\"Reset\", \"Start Button\", \"Stop Button\"],\n \"information\":[\"Details Button\"]\n }\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/","description":"

Create a new assignment part for an assignment.

Body is a json object to include the following parameters:

method - create (required)
\n
name - name for the new part (required)
\n
labtype - lab type of the newly created part (required)
\n
lab_interface - lab interface options to enable (required)
\n
- \"Console\" needs to be enabled for JupyterLab and VS Code
  \n
  - \"lab_interface\": {\"launch_behavior\": [], \"grades\": [], \"information\": [], \"panels\": [\"Console\"], \"controls\": [\"Reset\"]}
  \n
\n
container_image - name of custom image (optional)
\n

Returns \"transactionid\" to which may be queried to retrieve request status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts",""],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"68300852-86fe-495d-aa3c-9ca217ff2d0b","name":"Part - Create","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"create\",\n \"name\": \"part create\",\n \"labtype\": \"Vocareum Elite\",\n \"lab_interface\": {\n \"panels\": [\"Source\", \"Console\", \"File Browser\", \"Nav Bar\"],\n \"controls\":[\"Reset\", \"Start Button\", \"Stop Button\"],\n \"information\":[\"Details Button\"]\n }\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:43:34 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b804a596c176d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"18\",\n \"objid\": \"\"\n}"}],"_postman_id":"626cb3d2-5c5c-4804-a32b-e8a1c1c9aa41"},{"name":"Part - Copy","id":"e3d18399-fc1e-4d15-906c-39c75475581a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"copy\",\n \"source\": \"{source-partId}\",\n \"name\": \"part copy\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/","description":"

Copies an assignment part for an assignment.

Body is a json object to include the following parameters:

method - copy (required)
source - part id of the originating part(required)
name - name for the new part (optional)

Returns \"transactionid\" to which may be queried to retrieve request status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts",""],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"848c7b8e-3051-4496-bfab-f97bf87178a3","name":"Part - Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"method\": \"copy\",\n \"source\": \"{source-partId}\",\n \"name\": \"part copy\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:43:34 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b804a596c176d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"18\",\n \"objid\": \"\"\n}"}],"_postman_id":"e3d18399-fc1e-4d15-906c-39c75475581a"},{"name":"Part - Rubric - Add","id":"1d641460-f2fc-4125-a126-40e27086d603","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"name\": \"Test16\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"name\": \"Test17\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics","description":"

Add grading rubric for a given part.

Body is a json object to include the following parameters:

name - unique rubric name (must not match previous rubric names) (required)
maxscore - maximum points available for this rubric
exclude - is this rubric used for calculating total score (0 = false, 1 = true)
auto - is this an autograded rubric (0 = false, 1 = true)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","rubrics"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"b4c3123d-1b9b-44ca-837b-b6c8c31591ef","name":"Part - Rubric - Add","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"name\": \"Test16\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"name\": \"Test17\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jul 2020 22:57:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"040098290800006cf84080c200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b478fbb49bc6cf8-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"messages\": \"New rubrics added to the part\",\n \"parent\": {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\"\n },\n \"rubrics\": [\n {\n \"id\": \"232999\",\n \"name\": \"Test16\",\n \"seqnum\": \"\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"id\": \"233000\",\n \"name\": \"Test17\",\n \"seqnum\": \"\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"1d641460-f2fc-4125-a126-40e27086d603"},{"name":"Part - Rubric - Update","id":"d6bcd979-6ec4-465a-b4f3-aa1f5e61c21c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"id\": \"232999\",\n \"name\": \"Test16\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"id\": \"233000\",\n \"name\": \"Test17\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics","description":"

Update a pre-existing rubric for a given part.

Body is a json object to include the following parameters:

id - rubric id that refers to the rubirc to update (required)
name - unique rubric name (must not match previous rubric names) (optional)
maxscore - maximum points available for this rubric (optional)
exclude - is this rubric used for calculating total score (0 = false, 1 = true) (optional)
auto - is this an autograded rubric (0 = false, 1 = true) (optional)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","rubrics"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"ea58d5e5-b6d7-402e-9201-22966428f9bf","name":"Part - Rubric - Update","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"id\": \"232999\",\n \"name\": \"Test16\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"id\": \"233000\",\n \"name\": \"Test17\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jul 2020 22:57:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"040098290800006cf84080c200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b478fbb49bc6cf8-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"messages\": \"rubrics updated successfully\",\n \"parent\": {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\"\n },\n \"rubrics\": [\n {\n \"id\": \"232999\",\n \"name\": \"Test16\",\n \"seqnum\": \"\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"id\": \"233000\",\n \"name\": \"Test17\",\n \"seqnum\": \"\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"d6bcd979-6ec4-465a-b4f3-aa1f5e61c21c"},{"name":"Part - Rubric - Delete","id":"18c19335-a721-4354-91ec-ef4311b59c97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"id\": \"232999\"\n },\n {\n \"id\": \"233000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics","description":"

Delete a pre-existing rubric for a given part.

Body is a json object to include the following parameters:

id - rubric id that refers to the rubirc to delete (required)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","rubrics"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"cb4bfb34-a301-4607-bdb7-ab2b891a8ed9","name":"Part - Rubric - Delete","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"raw","raw":"{\n \"rubrics\": [\n {\n \"id\": \"232999\"\n },\n {\n \"id\": \"232999\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/rubrics"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jul 2020 22:57:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"040098290800006cf84080c200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b478fbb49bc6cf8-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"messages\": \"rubrics deleted successfully\",\n \"parent\": {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\"\n },\n \"rubrics\": [\n {\n \"id\": \"232999\",\n \"name\": \"Test16\",\n \"seqnum\": \"\",\n \"maxscore\": \"16\",\n \"exclude\": \"0\",\n \"auto\": \"0\"\n },\n {\n \"id\": \"233000\",\n \"name\": \"Test17\",\n \"seqnum\": \"\",\n \"maxscore\": \"17\",\n \"exclude\": \"0\",\n \"auto\": \"1\"\n }\n ],\n \"total_records\": 2\n}"}],"_postman_id":"18c19335-a721-4354-91ec-ef4311b59c97"},{"name":"Part - Update","id":"ad6f53c3-6845-422a-b79e-aec06c3de023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Part-1\",\n \"content\": [\n {\n \"target\": \"docs\",\n \"url\": \"{zipcontent-URL}\",\n \"reset\": 0\n }\n ],\n \"update\": 1, \n \"monthly_dollar\": \"3.00\", \n \"session_length\": \"60\",\n \"total_dollar\": \"10.00\",\n \"monthly_time\": \"60\",\n \"total_time\": \"240\",\n \"endlab\":\"terminate\",\n \"late_penalty_percent\": \"10\",\n \"late_penalty_percent_rule\": \"max score\",\n \"deadlinedate\": \"Aug 30 2021 23:59:59 America/Los_Angeles\",\n \"lab_interface\": {\n \"panels\": [\"Console\", \"Nav Bar\"],\n \"controls\":[\"Start Button\", \"Stop Button\"],\n \"information\":[\"Timer\", \"Budget\", \"Details Button\"],\n \"launch_behavior\":[\"New Tab\"],\n \"grades\":[\"Hide Scores\"]\n }\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}","description":"

Update a part using specified settings.

Body is a json object to include the following parameters:

name - string name for the part
\n
update - make content live
\n
content - array consisting of the following:
\n
- target - target directory (required)
  \n
  - lib | asnlib | docs | scripts | startercode
    \n
  - course | data | docs | scripts | private | startercode
    \n
  \n
- url - source URL for zip content
  \n
  - presigned_url can also be used for content stored in AWS S3 buckets
  \n
- zipcontent - base64 encoded zipcontent
  \n
- reset - 0 = write files | 1 = clear directory, then write files
  \n
\n
cloud_labs - boolean
\n
instant_aws_access - boolean
\n
monthly_dollar - float
\n
total_dollar - float
\n
monthly_time - integer (minutes)
\n
total_time - integer (minutes)
\n
session_length - integer (minutes)
\n
late_penalty_percent - integer
\n
late_penalty_percent_rule - options are \"max score\" or \"student score\"
\n
deadlinedate - part submission/deadline/due date.
\n
endlab - behavior on endlab - string (stop or terminate)
\n
labtype - string name of the lab type
\n
container_image - name of the container image (optional)
\n
- labtype must be specified if setting container_image
\n
number_of_submissions - number of submissions allowed
\n
lab_interface - list of lab interface options to enable
\n
- \"Console\" needs to be enabled for JupyterLab and VS Code
  \n
  - \"lab_interface\": {\"launch_behavior\": [], \"grades\": [], \"information\": [], \"panels\": [\"Console\"], \"controls\": [\"Reset\"]}
  \n
\n
databricks_maxusers - integer (optional)
\n
tags - JSON object (optional)
\n
databricks_cloud_type - string (optional)
\n
- AWS
  \n
- Azure
  \n
\n
azure_db_region - string (optional)
\n
- required if databricks_cloud_type is \"Azure\"
  \n
- https://learn.microsoft.com/en-us/azure/databricks/resources/supported-regions
  \n
\n

Returns \"transactionid\" to which may be queried to retrieve request status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"a86eb3d4-5e77-45b2-9b70-19b02ddf8c37","name":"Part - Update - URL","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Part-1\",\n \"content\": [\n {\n \"target\": \"docs\",\n \"url\": \"{{url}}\",\n \"reset\": 0\n }\n ],\n \"update\": 1\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 May 2019 05:21:44 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4da41bcbaf7b9fa0-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Queued\",\n \"queueid\": \"4\"\n}"},{"id":"f1142938-86a3-4e9e-bcc3-c38423934990","name":"Part - Update - Zipcontent","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Part-1\",\n \"content\": [\n {\n \"target\": \"docs\",\n \"zipcontent\": \"UEsDBBQACAAIAKlOUk4AAAAAAAAAAAAAAAALABAAUkVBRE1FLmh0bWxVWAwAvm3jXN7Galz1ARQAs8kwtONSAAIwEeTq6OLrquDmH6TgEeLro1CWmVrOZaMPVAMAUEsHCMEOSGUkAAAAKAAAAFBLAwQKAAAAAAAsurROAAAAAAAAAAAAAAAACQAQAF9fTUFDT1NYL1VYDADDbeNcw23jXPUBFABQSwMEFAAIAAgAqU5STgAAAAAAAAAAAAAAABYAEABfX01BQ09TWC8uX1JFQURNRS5odG1sVVgMAL5t41zexmpc9QEUAGNgFWNnYGJg8E1MVvAPVohQgAKQGAMnEBsB8SIgBvGvMBAFHENCgqBMkI4ZQGyDpoQRIS6anJ+rl1hQkJOqV1iaWJSYV5KZl8pQqG9gYGFobZqcamxmYWBg7ZxRlJ+bau1iYGBg7GzirGvsau6qa2JhYarrZOboqutsaGBgZO7samRgbMgAAFBLBwiFo6QqhwAAANQAAABQSwECFQMUAAgACACpTlJOwQ5IZSQAAAAoAAAACwAMAAAAAAAAAABA+IEAAAAAUkVBRE1FLmh0bWxVWAgAvm3jXN7GalxQSwECFQMKAAAAAAAsurROAAAAAAAAAAAAAAAACQAMAAAAAAAAAABA/UFtAAAAX19NQUNPU1gvVVgIAMNt41zDbeNcUEsBAhUDFAAIAAgAqU5SToWjpCqHAAAA1AAAABYADAAAAAAAAAAAQLCBpAAAAF9fTUFDT1NYLy5fUkVBRE1FLmh0bWxVWAgAvm3jXN7GalxQSwUGAAAAAAMAAwDYAAAAfwEAAAAA\",\n \"reset\": 1\n }\n ],\n \"update\": 1\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 May 2019 05:21:44 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4da41bcbaf7b9fa0-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Queued\",\n \"queueid\": \"3\"\n}"}],"_postman_id":"ad6f53c3-6845-422a-b79e-aec06c3de023"},{"name":"Part - Files","id":"af3e68a2-d19d-40e9-b381-59da7b1f54e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/files?filename=asnlib/public/test.txt","description":"

Retrieve URL for files in a given Vocareum assignment-part.

Filename path to start with one of the following if you are using the Elite architecture, i.e. the lab types Vocareum Standard, Basic, Vocareum Elite, Jupyter Elite.

asnlib
\n
docs
\n
scripts
\n
startercode
\n
lib
\n

If you are using the new course flow with container architecture e.g. using labtypes Vocareum Notebook, Databricks, VSCode, JupyterLab - the filename path should start with the following :-

docs
\n
scripts
\n
startercode
\n
private
\n
course
\n
data
\n

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","files"],"host":["api","vocareum","com"],"query":[{"key":"filename","value":"asnlib/public/test.txt"}],"variable":[]}},"response":[{"id":"96257b7d-f37f-4fea-b9c2-9c78f9b87892","name":"Part - Files","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/files?filename=asnlib/public/test.txt","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","files"],"query":[{"key":"filename","value":"asnlib/public/test.txt"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Sep 2019 23:24:17 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"510b79efaf696cbc-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"files\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"filename\": \"asnlib/public/test.txt\",\n \"download_url\": \"https://vocareum-us-west-2-1.s3.us-west-2.amazonaws.com/course4091/content/asn46178_1/asn46179_1/asnlib.0/public/test.txt?response-content-disposition=attachment%3B%20filename%3Dtest.txt&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJJWBMKAR3SJXL5OQ%2F20190903%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20190903T232417Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3540&X-Amz-Signature=2c20e09c9d599261ac53a96f6d4f7a7cdc4e211e218875f5869b290f9c45a316\"\n }\n ]\n}"}],"_postman_id":"af3e68a2-d19d-40e9-b381-59da7b1f54e7"},{"name":"Part - Files (list)","id":"4df5a406-86b4-464a-8937-dc0e6cee9ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/assignments/{{assignmentid}}/parts/{{partid}}/files?dir=/work&list=true&exclude[]=gmt.history&exclude[]=sessions","description":"

List the files specified in the 'dir' parameter.

Query parameters:

dir - the directory in which to list the files
\n
- examples:
  \n
  - /work
    \n
  - /voc/course
    \n
  \n
\n
list - boolean
\n
- false or unspecified will provide a URL to download the files in 'dir'
\n
exclude - item to hide from results (optional)
\n
- bracket notation is required
\n
includeHidden - boolean (optional)
\n
- true will show items whose names start with \".\"
\n

Soon to come:

page - indicate which page of records to retrieve (default=0) (optional)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","assignments","{{assignmentid}}","parts","{{partid}}","files"],"host":["api","vocareum","com"],"query":[{"key":"dir","value":"/work"},{"key":"list","value":"true"},{"key":"exclude[]","value":"gmt.history"},{"key":"exclude[]","value":"sessions"}],"variable":[]}},"response":[{"id":"2cd75d3e-dae7-43ee-933a-aa671dbf58d8","name":"Part - Files (list)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseid}}/assignments/{{assignmentid}}/parts/{{partid}}/files?dir=/work&list=true&exclude[]=gmt.history&exclude[]=sessions","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseid}}","assignments","{{assignmentid}}","parts","{{partid}}","files"],"query":[{"key":"dir","value":"/work"},{"key":"list","value":"true"},{"key":"exclude[]","value":"gmt.history"},{"key":"exclude[]","value":"sessions"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"courseid\": \"9\",\n \"assignmentid\": \"9\",\n \"partid\": \"9\",\n \"directory\": \"/work\",\n \"files\": [\n \"Untitled.ipynb\",\n \"Untitled1.ipynb\",\n \"test.ipynb\",\n \"vocareum_code.ipynb\"\n ]\n}"}],"_postman_id":"4df5a406-86b4-464a-8937-dc0e6cee9ce7"},{"name":"Part - Files (download)","id":"5f8d1d7e-f9e2-4eb8-a9ab-24ad8ffca06c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/assignments/{{assignmentid}}/parts/{{partid}}/files?dir=/work&exclude[]=gmt.history&exclude[]=sessions","description":"

Retrieve URL for files in the specified 'dir'.

The difference between this and the 'filename' version of this API is that this endpoint allows you to download a directory (multiple files at once) and to download items from /work.

Returns 'transactionid', which is used to get the URL. Make the call to this endpoint again, but with 'transactionid' as the query param.

Query parameters:

dir - the directory in which to download the files
\n
- examples:
  \n
  - /work
    \n
  - /voc/course
    \n
  \n
\n
list - boolean (optional)
\n
- false or unspecified will provide a URL to download the files in 'dir'
\n
exclude - item to hide from results (optional)
\n
- bracket notation is required
\n
includeHidden - boolean (optional)
\n
- true will download items whose names start with \".\"
\n

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","assignments","{{assignmentid}}","parts","{{partid}}","files"],"host":["api","vocareum","com"],"query":[{"key":"dir","value":"/work"},{"key":"exclude[]","value":"gmt.history"},{"key":"exclude[]","value":"sessions"}],"variable":[]}},"response":[{"id":"3dfb9379-8ba0-4df2-9411-a10e10eb3b1b","name":"Part - Files (download)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseid}}/assignments/{{assignmentid}}/parts/{{partid}}/files?dir=/work&exclude[]=gmt.history&exclude[]=sessions","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseid}}","assignments","{{assignmentid}}","parts","{{partid}}","files"],"query":[{"key":"dir","value":"/work"},{"key":"exclude[]","value":"gmt.history"},{"key":"exclude[]","value":"sessions"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Started\",\n \"transactionid\": \"9\",\n \"objid\": \"10\"\n}"}],"_postman_id":"5f8d1d7e-f9e2-4eb8-a9ab-24ad8ffca06c"},{"name":"Part - Release","id":"97fed33a-5c44-46e6-9132-e238d0dc2474","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"jupyter\",\n \"zipfile\": \"{zipcontent}\",\n \"extract_rubrics\": 1,\n \"delete_unused_rubrics\": 1,\n \"resource_link\": 1,\n \"generate_grading_script\": 1,\n \"traceback\": 1,\n \"html_feedback\": 1,\n \"update\": 1\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/release","description":"

Body is a JSON object which includes the following parameters:

type - jupyter | quiz
zipfile - base64 encoded zip file of notebook(s) or documentation to release

For Jupyter release, you may use the following additional parameters:

extract_rubrics - 0 | 1 (default) - extract the rubric items from the notebook and add them to the part settings
delete_unused_rubrics - 0 | 1 (default) - deletes items that are not in the given notebook; ignored if there has been at least one submission for this part
resource_link - 0 | 1 (default) - create the resource link in startercode
generate_grading_script - 0 | 1 (default) - generate the grading script, (overwrite if one exists)
traceback - 0 | 1 (default) - in the report, show python traceback for auto-graded cells which have errors
html_feedback - 0 (default) | 1 - create an html report of the executed notebook
update - 0 (default) | 1 - update the part (i.e., release the code to students )
extensions - array of extensions to enable by default
- string to use is the extension's require path
- e.g., extensions: [\"toc2/main\"]
\n

For quiz (MCQ) release, you may use the following parameters:

multi_tab - 0 | 1 (default) - present each question in it's own tab, rather than a flat, one-page quiz
show_hints - 0 | 1 (default) - hints will be shown on the student's HTML copy of their submission
use_url - 0 (default) | 1 - use a URL as the source of zipped content for the zipfile parameter

Returns \"transactionid\" which may then be queried to retrieve the request's status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","release"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97fed33a-5c44-46e6-9132-e238d0dc2474"},{"name":"Part","id":"dccb76fb-5e18-4bee-a1d3-ae11dba8236b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}","description":"

Deletes the specified part.

Request details for all resources associated with a given part.

Returns:

courseid
\n
assignmentid
\n
partid
\n
sessionstart - time at which the last session started
\n
sessionend - time at which the last session ends or ended
\n
expected_termination_time - time at which the part and resources will be terminated
\n
totaltime - total accumulated time in the part (in seconds)
\n
resource-specific items - e.g., for cloud resource, will return:
\n
status - active, inactive, initializing, terminating
\n
vendor - cloud vendor, e.g., aws, azure
\n
aws_data:
\n
- console launch URL
  \n
- account_id
  \n
- aws_access_key_id
  \n
- aws_secret_access_key
  \n
- aws_session_token
  \n
- ssh_key
  \n
- totalspend (in USD)
  \n
\n
azure_data:
\n
- azure_username
  \n
- azure_password
  \n
- resource_group
  \n
- subscription_id
  \n
- totalspend
  \n
- allowedspend
  \n
\n
gcp_data:
\n
- email
  \n
- password
  \n
- employee_id
  \n
- project_id
  \n
- totalspend
  \n
\n
genai_data
\n
- used_budget
  \n
- total_budget
  \n
- remaining_budget
  \n
- userkey
  \n
- apitype
  \n
\n
databricks:
\n
- workspaceid
  \n
- groupid
  \n
- groupname
  \n
- useremail
  \n
- userid
  \n
- sso_url
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","resources","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"031bba84-be2e-4484-b39d-b679c465ebe4","name":"Resources - Example1 (AWS)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:43:34 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b804a596c176d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T10:45:48-0700\",\n \"sessionend\": \"2019-04-01T10:55:49-0700\",\n \"expected_termination_time\": \"2019-04-09T10:55:49-0700\",\n \"totaltime\": \"4277\",\n \"cloud\": [\n {\n \"status\": \"inactive\",\n \"vendor\": \"aws\",\n \"aws_data\": {\n \"url\": \"\",\n \"ssh_key\": \"\",\n \"account_id\": \"941158363787\",\n \"aws_access_key_id\": \"\",\n \"aws_secret_access_key\": \"\",\n \"aws_session_token\": \"\",\n \"readonly_aws_access_key_id\": \"\",\n \"readonly_aws_secret_access_key\": \"\",\n \"readonly_aws_session_token\": \"\",\n \"readonly_expiration\": \"\",\n \"totalspend\": \"5.0E-6\"\n }\n },\n {\n \"status\": \"Ok\",\n \"vendor\": \"azure\",\n \"azure_data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"vocareum_user\": \"\",\n \"part_id\": \"\",\n \"object_id\": \"\",\n \"principal_name\": \"student_234hjasdf2@vocareumvocareum.onmicrosoft.com\",\n \"password\": \"\",\n \"res_group\": \"\",\n \"duration\": \"\",\n \"currency\": \"\",\n \"allowedspend\": \"10\",\n \"totalspend\": \"0.000\",\n \"subscription_id\": \"\",\n \"is_active\": \"\",\n \"end_time\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"session_expiration_time\": \"\"\n }\n }\n ]\n }\n ]\n}"},{"id":"2af661a2-43e0-4cef-9c33-98ef172dec39","name":"Resources - Example2 (AWS)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 22 Mar 2019 19:17:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-transform,public,max-age=300,s-maxage=900"},{"key":"Status","value":"400"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bba8227998a6c76-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T11:05:17-0700\",\n \"sessionend\": \"2019-04-01T12:05:17-0700\",\n \"expected_termination_time\": \"2019-04-09T12:05:17-0700\",\n \"totaltime\": \"4291\",\n \"cloud\": [\n {\n \"status\": \"active\",\n \"vendor\": \"aws\",\n \"aws_data\": {\n \"url\": \"https://console.aws.amazon.com/xyz&tokenstring\",\n \"ssh_key\": \"{{ssh_key}}\",\n \"account_id\": \"{{aws_account_id}}\",\n \"aws_access_key_id\": \"{{accesskey}}\",\n \"aws_secret_access_key\": \"{{secretkey}}\",\n \"aws_session_token\": \"{{sessiontoken}}\",\n \"readonly_aws_access_key_id\": \"{{accesskey}}\",\n \"readonly_aws_secret_access_key\": \"{{secretkey}}\",\n \"readonly_aws_session_token\": \"{{sessiontoken}}\",\n \"readonly_expiration\": \"{{utc-encoded date-time}}\",\n \"totalspend\": \"5.0E-6\"\n }\n },\n {\n \"status\": \"Ok\",\n \"vendor\": \"azure\",\n \"azure_data\": {\n \"id\": \"1\",\n \"name\": \"student_234hjasdf2\",\n \"vocareum_user\": \"1254378\",\n \"part_id\": \"43123\",\n \"object_id\": \"\",\n \"principal_name\": \"{{azure_account_email}}\",\n \"password\": \"{{azure_account_password}}\",\n \"res_group\": \"{{resource_group_id}}\",\n \"duration\": \"60\",\n \"currency\": \"usd\",\n \"allowedspend\": \"10\",\n \"totalspend\": \"0.000\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"is_active\": \"1\",\n \"end_time\": \"2021-12-15 04:21:34\",\n \"created_at\": \"2021-12-15 03:21:34\",\n \"updated_at\": \"2021-12-15 03:21:34\",\n \"session_expiration_time\": \"1639542094\"\n }\n }\n ]\n }\n ]\n}"},{"id":"e515da5c-47e4-4638-905e-72d26f47105d","name":"Resources - Example3 (Azure)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:43:34 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b804a596c176d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T10:45:48-0700\",\n \"sessionend\": \"2019-04-01T10:55:49-0700\",\n \"expected_termination_time\": \"2019-04-09T10:55:49-0700\",\n \"totaltime\": \"4277\",\n \"cloud\": [\n {\n \"status\": \"inactive\",\n \"vendor\": \"azure\",\n \"azure_data\": {\n \"message\": \"No session is running\"\n }\n }\n ]\n }\n ]\n}"},{"id":"12126c98-b340-42cc-aeee-0a74272cc8f6","name":"Resources - Example4 (Azure)","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 22 Mar 2019 19:17:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-transform,public,max-age=300,s-maxage=900"},{"key":"Status","value":"400"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bba8227998a6c76-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T11:05:17-0700\",\n \"sessionend\": \"2019-04-01T12:05:17-0700\",\n \"expected_termination_time\": \"2019-04-09T12:05:17-0700\",\n \"totaltime\": \"4291\",\n \"cloud\": [\n {\n \"status\": \"active\",\n \"vendor\": \"azure\",\n \"azure_data\": {\n \"azure_username\": \"student_234hjasdf2@vocareumvocareum.onmicrosoft.com\",\n \"azure_password\": \"3laakdsfuase!@89adsfjkh\",\n \"resource_group\": \"Regroup_eijo2345jg\",\n \"duratisubscription_id\": \"eal321f3-fei3-ske1-483s-d03ev8af1f4\",\n \"totalspend\": \"0.000\",\n \"allowedspend\": \"10\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"c2d06f74-644a-4729-bcd2-bd68d9822b4e"},{"name":"Resources - Start","id":"186a7312-f49b-49ff-8aa5-39ed7b638927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userId}}","description":"

Start all of student's resources in a given part. If a resource is already started, then the session time will be extended.

If \"cloud\" resource, cloud formation template (if any) will be launched and temporary credentials issued.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Status Text
200	OK
400	The user is not enrolled as a student in the course.
400	The assignment is not published.
400	Can not start the part (configured as a team project).
400	Can not start the part (configured to generate starter code).
400	No configured resource.
400	Unsupported resource.
400	Missing user information, it should not happen if the course and user id is correct
400	Missing course information, it should not happen if the course and user id is correct
400	Failed operation, when unable to start/terminate the resource

","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","resources","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"6fd7e1e5-5c38-42a3-a636-017726b333b5","name":"Resources - Actions (AWS)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"formdata","formdata":[{"key":"action","value":"","description":"\"start\" (default), \"end\" ","type":"text"}]},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Mar 2019 21:04:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-transform,public,max-age=300,s-maxage=900"},{"key":"Status","value":"400"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bd3d6c98b412804-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T11:05:17-0700\",\n \"sessionend\": \"2019-04-01T12:05:17-0700\",\n \"expected_termination_time\": \"2019-04-09T12:05:17-0700\",\n \"totaltime\": \"4291\",\n \"cloud\": [\n {\n \"status\": \"active\",\n \"vendor\": \"aws\",\n \"aws_data\": {\n \"url\": \"https://console.aws.amazon.com/xyz&tokenstring\",\n \"ssh_key\": \"{{ssh_key}}\",\n \"account_id\": \"{{aws_account_id}}\",\n \"aws_access_key_id\": \"{{accesskey}}\",\n \"aws_secret_access_key\": \"{{secretkey}}\",\n \"aws_session_token\": \"{{sessiontoken}}\",\n \"readonly_aws_access_key_id\": \"{{accesskey}}\",\n \"readonly_aws_secret_access_key\": \"{{secretkey}}\",\n \"readonly_aws_session_token\": \"{{sessiontoken}}\",\n \"readonly_expiration\": \"{{utc-encoded date-time}}\",\n \"totalspend\": \"5.0E-6\"\n }\n }\n ]\n }\n ]\n}"},{"id":"62f2398f-8062-443d-b433-3b03dcb8fdc7","name":"Resources - Actions (Azure)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"formdata","formdata":[{"key":"action","value":"","description":"\"start\" (default), \"end\" ","type":"text"}]},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Mar 2019 21:04:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-transform,public,max-age=300,s-maxage=900"},{"key":"Status","value":"400"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bd3d6c98b412804-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"resources\": [\n {\n \"courseid\": \"4091\",\n \"assignmentid\": \"46178\",\n \"partid\": \"46179\",\n \"userid\": \"23889\",\n \"sessionstart\": \"2019-04-01T11:05:17-0700\",\n \"sessionend\": \"2019-04-01T12:05:17-0700\",\n \"expected_termination_time\": \"2019-04-09T12:05:17-0700\",\n \"totaltime\": \"4291\",\n \"cloud\": [\n {\n \"status\": \"active\",\n \"vendor\": \"azure\",\n \"azure_data\": {\n \"azure_username\": \"student_234hjasdf2@vocareumvocareum.onmicrosoft.com\",\n \"azure_password\": \"3laakdsfuase!@89adsfjkh\",\n \"resource_group\": \"Regroup_eijo2345jg\",\n \"duratisubscription_id\": \"eal321f3-fei3-ske1-483s-d03ev8af1f4\",\n \"consumed_budget\": \"0.000\",\n \"allocated_budget\": \"10\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"186a7312-f49b-49ff-8aa5-39ed7b638927"},{"name":"Resources - Update","id":"1493a3a5-355a-4f7b-8d82-e370edc58fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"state\": \"active\" | \"inactive\",\n \"budget\":\"{budget-as-float}\",\n \"apitype\":\"{apitype-as-int}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/resources/{{userId}}","description":"

Update cloud budget and status for a user account.

Body is a json object to include one or both of the following parameters:

state; and/or
budget

For assignments with generative AI budgeting enabled, an additional parameter is required specifying which type of generative AI key you are trying to update:

apitype (openai = 0, azure = 1, llama2 = 2, custom = 3)

Ends a session and terminate specified resource for a given user + part.

Body is a json object to include the following parameter:

action - \"end\" or \"terminate\" (default is \"terminate\")

NOTE: \"end\" behavior is dependent on the Course-level setting \"End Lab Behavior\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Status Text
200	OK
400	The user is not enrolled as a student in the course.
400	The assignment is not published.
400	Can not start the part (configured as a team project).
400	Can not start the part (configured to generate starter code).
400	No configured resource.
400	Unsupported resource.
400	Missing user information, it should not happen if the course and user id is correct
400	Missing course information, it should not happen if the course and user id is correct
400	Failed operation, when unable to start/terminate the resource
400	The parameter action must be end or terminate

Sets a student's grades for a given part.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","grades","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"39a05c4e-9243-4ee6-9eb4-7fcbf73e9122","name":"Grades","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"grades\":{\n \"comment\":\"This is an overall comment\"\n \"criterias\":{\n \"Test 1\":{\n \"score\":\"3\",\n \"comment\":\"This is a comment on Test 1\"\n },\n \"Test 2\":{\n \"score\":\"3\",\n \"comment\":\"This is a comment on Test 2\"\n }\n }, \n }\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/grades/{{userId}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"18dca4a7-1368-48c5-b51d-d4ab1700ca32"},{"name":"Grades","id":"68b62ef3-97ed-40f6-a5c1-e12e8e2e4957","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/grades/{{userId}}?includeCodeComments=1","description":"

Gets a student's grades for a given part.

Params:

includeCodeComments - boolean

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","grades","{{userId}}"],"host":["api","vocareum","com"],"query":[{"key":"includeCodeComments","value":"1"}],"variable":[]}},"response":[{"id":"0ef229b5-e794-4dff-99db-80c150059688","name":"Grades","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/grades/{{userId}}?includeCodeComments=1","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","grades","{{userId}}"],"query":[{"key":"includeCodeComments","value":"1"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"grades\":{\"overall_score\":\"10\",\"overall_comment\":\"Fantastic\",\"criterias\":{\"Test 1\":{\"score\":\"5\",\"comment\":\"comment 1\"},\"Test 2\":{\"score\":\"5\",\"comment\":\"Comment 2\"}},\"codeComments\":{\"\\/test.py\":[{\"linenum\":\"4\",\"comment\":\"this is a test code comment\"},{\"linenum\":\"3\",\"comment\":\"This a also a test comment\"}],\"\\/input.txt\":[{\"linenum\":\"1\",\"comment\":\"cool input\"}]}}}"}],"_postman_id":"68b62ef3-97ed-40f6-a5c1-e12e8e2e4957"},{"name":"Users","id":"b096fd7d-5cf2-4d1f-a000-d6c1e007b67e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"role\": \"{{user-role}}\", \n\t\"include_dropped\": \"{{user-status}}\", \n\t\"organization_terms_agreed\": \"{{org-terms-agreed}}\",\n\t\"page\":\"{{page-number}}\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users","description":"

List of students for specified course

Body is a json object to include the following optional parameters:

role - list by user's role: \"teacher\", \"student\" (default), \"grader\"
include_dropped - \"true\" or \"false\"
organization_terms_agreed - \"true\" or \"false\"
page - indicate which page of records to retrieve (default=0)

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","users"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"fa523b56-54d9-4de4-a6c4-106aaa178126","name":"Users - List","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users?role=student&include_dropped=true","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseId}}","users"],"query":[{"key":"role","value":"student","description":"\"student\" [default] or \"teacher\""},{"key":"include_dropped","value":"true","description":"\"true\" or \"false\""},{"key":"organization_terms_agreed","value":"true","description":"\"true\" or \"false\"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Sep 2019 19:16:42 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"515c75021dfb965a-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"users\": [\n {\n \"id\": \"50720\",\n \"courseid\": \"7370\",\n \"role\": \"student\",\n \"name\": \"David Student\",\n \"email\": \"david+s1@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"dropped\": false,\n \"organization_terms_agreed\": true,\n \"organization_terms_agreed_date_utc\": \"2019-09-10T04:38:10\"\n },\n {\n \"id\": \"54688\",\n \"courseid\": \"7370\",\n \"role\": \"student\",\n \"name\": \"David Student6\",\n \"email\": \"david+s6@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"dropped\": false,\n \"organization_terms_agreed\": true,\n \"organization_terms_agreed_date_utc\": \"2019-09-10T05:32:16\"\n },\n {\n \"id\": \"418442\",\n \"courseid\": \"7370\",\n \"role\": \"student\",\n \"name\": \"david+s7@vocareum.com\",\n \"email\": \"david+s7@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"dropped\": true,\n \"organization_terms_agreed\": false,\n \"organization_terms_agreed_date_utc\": \"\"\n }\n ],\n \"total_records\": 3\n}"}],"_postman_id":"b096fd7d-5cf2-4d1f-a000-d6c1e007b67e"},{"name":"Users - Enroll","id":"905040f2-2e5f-4cfe-a5ce-e93e75ffad7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"{user-email}\",\n \"name\": \"{user-name}\",\n \"client_key\": \"{client_key}\",\n \"client_userid\": \"{client_userid}\",\n \"role\": \"student (default) | teacher\",\n \"section_name\": \"{section_name}\",\n \"external_id\": \"{external_id}\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users","description":"

Enroll a student.

Required:

email; or
client_key & client_userid

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Status Text
200	OK
400	Invalid Request - userid must not be specified.
400	Missing parameter: client_key
400	Missing parameter: client_userid
400	Invalid value for parameter: client_key
400	The value for parameter client_key does not match the course or organization key
400	Role must be student, teacher/instructor or grader, It happens when there is role parameter passed not equal to student (default), teacher or grader
400	Could not create user, please contact Vocareum support.

","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","users"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"a3841fd3-199c-4f6e-b89f-90bc22d613cc","name":"Enroll User - Client_UserID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":{"raw":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","courses","{{courseId}}","users"],"query":[{"key":"email","value":"student1@vocareum.com","description":"user email address","disabled":true},{"key":"name","value":"","description":"user name","disabled":true},{"key":"external_id","value":"","description":"external id","type":"text","disabled":true},{"key":"role","value":"","description":"\"student\" [default] or \"teacher\"","type":"text","disabled":true},{"key":"section_name","value":"","description":"section name","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 17:38:53 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b80437c9a456d90-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"users\": [\n {\n \"id\": \"276493\",\n \"courseid\": \"4091\",\n \"role\": \"student\",\n \"name\": \"01011123\",\n \"email\": \"\",\n \"client_key\": \"{{client_userid}}\",\n \"client_userid\": \"01011123\",\n \"dropped\": false\n }\n ]\n}"},{"id":"d8da9379-d4dc-427c-8e0c-e36444daa7ae","name":"Enroll User - Email","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"{user-email}\",\n \"name\": \"{user-name}\",\n \"client_key\": \"{client_key}\",\n \"client_userid\": \"{client_userid}\",\n \"role\": \"student (default) | teacher\",\n \"section_name\": \"{section_name}\",\n \"external_id\": \"{external_id}\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 10 Aug 2019 19:10:22 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"504444fe1bc29334-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"users\": [\n {\n \"id\": \"6954\",\n \"courseid\": \"4091\",\n \"role\": \"student\",\n \"name\": \"student2\",\n \"email\": \"student2@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"dropped\": false\n }\n ]\n}"}],"_postman_id":"905040f2-2e5f-4cfe-a5ce-e93e75ffad7e"},{"name":"Users - Drop","id":"05ff81a6-e020-4a82-9dd7-4b5bdb995768","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users/{{userId}}","description":"

Drop a student from a course

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","users","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"1aa78290-33e2-4296-b73b-9ffd8b8ee659","name":"Drop User","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/users/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Mar 2019 05:51:20 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4b7c37096c6a6c5e-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"users\": [\n {\n \"id\": \"276486\",\n \"courseid\": \"4091\",\n \"role\": \"student\",\n \"name\": \"01011123\",\n \"email\": \"\",\n \"client_key\": \"{{client_key}}\",\n \"client_userid\": \"01011123\",\n \"dropped\": true\n }\n ]\n}"}],"_postman_id":"05ff81a6-e020-4a82-9dd7-4b5bdb995768"},{"name":"Grades","id":"c59c9ea1-8469-4435-be83-0bc9f304bd1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/grades/{{userId}}","description":"

Sets a student's grades for a given part.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","grades","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"e593964b-951e-4daa-8a20-96049a9d29d2","name":"Grades","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"grades\":[[\"Test 1\", \"1\"], [\"Test 2\", \"1\"]]\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/grades/{{userId}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c59c9ea1-8469-4435-be83-0bc9f304bd1c"},{"name":"Submissions","id":"27169c28-3a05-4608-b276-0075b291c640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/submissions/{{userId}}","description":"

Retrieve a student's submission for a given part.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","submissions","{{userId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"22b1645c-5930-4893-b954-21d9b70447e9","name":"Submissions","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/submissions/{{userId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 26 Mar 2019 00:01:18 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4bd4d9645c776c16-SJC"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"dirname\": \"sub_u23889_a46178_p46179_s0\",\n \"zipfilecontent\": \"UEsDBAoAAAAAABRSb04AAAAAAAAAAAAAAAAcABwAc3ViX3UyMzg4OV9hNDYxNzhfcDQ2MTc5X3MwL1VUCQAD992LXM5rmVx1eAsAAQQnRwIABDAAAABQSwMECgAAAAAASKhyToNUv/wGAAAABgAAADgAHABzdWJfdTIzODg5X2E0NjE3OF9wNDYxNzlfczAvLnZvY1N0dWRlbnRHcmFkaW5nUmVwb3J0LnR4dFVUCQADx2mQXPrdi1x1eAsAAQQwAAAABDAAAACCt5q2OhtQSwMEFAAAAAgADVJvTsw4zrqgAQAAgAIAACoAHABzdWJfdTIzODg5X2E0NjE3OF9wNDYxNzlfczAvLnZvY3N1Ym1pdC50eHRVVAkAA+rdi1z03YtcdXgLAAEEMAAAAAQwAAAAbZFha6MwHMa/SsirDUrOaNXasRdedW3ZvBS1Ww8EyWzssqWmRFvYjX73i3HHOrgXQvLL8yTP//EDPpJZmMbrBE7hRwE7vmcFnBYwoQpgF9gWDgC2ptib2h7dg1WUF3BUwFqKLVNGaRtwbJni2wE4k0lgIG2bTzb2sD8wtqdcGBYuf59Iunn/SV6PRxYXRfHjNbHnQZ0l9UN9R3a3t8ZxYqrlstEeHfAkq0o2Nd/praUPBX/+XOnHhk0BLeNrK8UPXXtJOqo6piq5Zf/o+QxHMMvXUfwrHypY5PmqXGdxWoZzDYc25B8uBO0jusgCVwmteNPJ9uUGLJuOCaABIBnY6K5KPC6daxAeDoI9sed73hmb4yPHA1f3izx5GAHB3xiYs+pNXoPZi5K6dS3ybWRple0hbGOQ0Zoq/mU2I6RxQvK4DKMoNcmw9jgYOQFyJ5eCBcn66M1RiC+4Iukwj40t/9t9/byX8miZxrO8/O+pKWhT3pH0KUyjOOpX5lbfQYGDsDtG2HdHoI/mTRAeY/31VeumH2dlR3e66JX+Exie/wJQSwMECgAAAAAACTZvTqG0VCAcAAAAHAAAACEAHABzdWJfdTIzODg5X2E0NjE3OF9wNDYxNzlfczAvZm9vLmNVVAkAAyGti1zq3YtcdXgLAAEEJ0cCAAQwAAAAIyB0aGlzIGlzIGp1c3QgYW4gZW1wdHkgZmlsZVBLAQIeAwoAAAAAABRSb04AAAAAAAAAAAAAAAAcABgAAAAAAAAAEAD4QQAAAABzdWJfdTIzODg5X2E0NjE3OF9wNDYxNzlfczAvVVQFAAP33YtcdXgLAAEEJ0cCAAQwAAAAUEsBAh4DCgAAAAAASKhyToNUv/wGAAAABgAAADgAGAAAAAAAAQAAAKSBVgAAAHN1Yl91MjM4ODlfYTQ2MTc4X3A0NjE3OV9zMC8udm9jU3R1ZGVudEdyYWRpbmdSZXBvcnQudHh0VVQFAAPHaZBcdXgLAAEEMAAAAAQwAAAAUEsBAh4DFAAAAAgADVJvTsw4zrqgAQAAgAIAACoAGAAAAAAAAQAAAKSBzgAAAHN1Yl91MjM4ODlfYTQ2MTc4X3A0NjE3OV9zMC8udm9jc3VibWl0LnR4dFVUBQAD6t2LXHV4CwABBDAAAAAEMAAAAFBLAQIeAwoAAAAAAAk2b06htFQgHAAAABwAAAAhABgAAAAAAAEAAAD4gdICAABzdWJfdTIzODg5X2E0NjE3OF9wNDYxNzlfczAvZm9vLmNVVAUAAyGti1x1eAsAAQQnRwIABDAAAABQSwUGAAAAAAQABAC3AQAASQMAAAAA\"\n}"}],"_postman_id":"27169c28-3a05-4608-b276-0075b291c640"},{"name":"Transaction","id":"6ed73e64-fa15-43bf-972d-cf9b0802fded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.vocareum.com/api/v2/transaction/{{transactionId}}","description":"

Request status for given transaction

\n","urlObject":{"protocol":"https","path":["api","v2","transaction","{{transactionId}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"36d1546a-2448-4414-b47a-c45f8a33ea86","name":"Transaction 1","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.vocareum.com/api/v2/queue/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 May 2019 20:33:29 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4da9535e2c8c5787-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"state\": \"success\",\n \"objid\": \"50707\",\n \"message\": \"Part updated\"\n}"},{"id":"b3395d6b-720e-4a3e-b8f7-11378663e2ea","name":"Transaction 2","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.vocareum.com/api/v2/transaction/{{transactionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Dec 2020 22:17:19 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06cc4774cf000005754faac000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fc0a8347a330575-LAX"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"state\": \"success\",\n \"objid\": \"6377\",\n \"message\": \"Course clone complete\"\n}"}],"_postman_id":"6ed73e64-fa15-43bf-972d-cf9b0802fded"},{"name":"Organization - Remove Users","event":[{"listen":"test","script":{"id":"8d1cdc92-4a77-4690-900b-496cf7e3e726","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"e0bebdd6-5b37-4ee9-bcad-01d296029857","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"page\": \"1\"\n}"},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/users/{{userid}}?role=teacher","description":"

Remove educator from all enrolled courses.

Only role=teacher is currently supported.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","users","{{userid}}"],"host":["api","vocareum","com"],"query":[{"key":"role","value":"teacher"}],"variable":[]}},"response":[],"_postman_id":"e0bebdd6-5b37-4ee9-bcad-01d296029857"},{"name":"S3 Labs","id":"b37dba9d-bb29-49ff-907a-b5c237eabdce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/s3_labs","description":"

Generate temporary security credentials for AWS S3 access. This is available for org admins only.

Provides access to org-level lab analytics: daily report of lab sessions and cloud spend. This feature must be turned on -- email support@vocareum.com.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","s3_labs"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"43e3db55-2a88-497e-8414-5732b7f5b5ab","name":"S3 Labs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/s3_labs"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"s3\":[{\"aws_access_key_id\":\"ASIAQQ2PL2HSLHVWFRVW\",\"aws_secret_access_key\":\"2MRtr7+j1M5wRpjYwbPzMCI480zzCjXQw4JryXE4\",\"aws_session_token\":\"FwoGZXIvYXdzEP\\/\\/\\/\\/\\/\\/\\/\\/\\/\\/\\/wEaDIpHS\\/yHL0U0\\/dRdiCLvAjbXeZH6NCeAfQBPzdYPA6hyzEGWuF8gAaEUWyAnMmUTJv5l0LLS6vWcD1gsh5tk4zBAzUbZlAeMOBiVTgRVI\\/ouZTzWM6MeCmyszsYeHzYuFDVC0OuepNkDyHQXyU+ip4osqXkTXKJZQcyw0bpy4iCHq7lWrAy028dJ8ShSdXUKr1Pm2H751batDiP\\/YwJwxQDnloivd3s3FMdMzE\\/QQB\\/TO4O\\/cdBNpD8Af2ask2dwme9vKJUqkA9VxslaWLo+jjt0eiiUgkDq2Hjdtd4pArfi3tRlSBjY5+9EjoOUMHsUEmNKrhYcqoHg+cvOcwplF\\/kG1SLXCBFbH7f\\/FMJVvXAAcLrihNCue7P98zfNP\\/v7vD8JfJtNDRQcWxZmomSSCh+88jO\\/2oHiOkLLQ0c7Z2Qw6AcgW1\\/0i5fK9NDBByWsqcvZZdfHtWKXTQjoTOCq1gowIk9O06xs7sVpClbFgc62k8xpmO8i0S4S9aJ9TJ4oyaKnhAYyLfa4LanqzSg6SqR\\/sNRLUK1yVA+LmOUQUAUn4F4qKQWvUh8Bnx1MtMPwEYIEtQ==\",\"bucket\":\"vocareum-us-west-2-lab-analytics\",\"path\":\"vocareum-us-west-2-lab-analytics\\/org292\"}],\"message\":\"\"}"}],"_postman_id":"b37dba9d-bb29-49ff-907a-b5c237eabdce"},{"name":"S3","id":"376d71dd-de15-4647-9e81-0e0b679447c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/s3","description":"

Generate temporary security credentials for AWS S3 access to the course content.

Provides access to course-level content.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","s3"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"3ea6ec83-005f-4ee3-b389-3644a043c4d3","name":"S3","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/s3"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"s3\":[{\"aws_access_key_id\":\"ASIAQQ2PL2HSLHVWFRVW\",\"aws_secret_access_key\":\"2MRtr7+j1M5wRpjYwbPzMCI480zzCjXQw4JryXE4\",\"aws_session_token\":\"FwoGZXIvYXdzEP\\/\\/\\/\\/\\/\\/\\/\\/\\/\\/\\/wEaDIpHS\\/yHL0U0\\/dRdiCLvAjbXeZH6NCeAfQBPzdYPA6hyzEGWuF8gAaEUWyAnMmUTJv5l0LLS6vWcD1gsh5tk4zBAzUbZlAeMOBiVTgRVI\\/ouZTzWM6MeCmyszsYeHzYuFDVC0OuepNkDyHQXyU+ip4osqXkTXKJZQcyw0bpy4iCHq7lWrAy028dJ8ShSdXUKr1Pm2H751batDiP\\/YwJwxQDnloivd3s3FMdMzE\\/QQB\\/TO4O\\/cdBNpD8Af2ask2dwme9vKJUqkA9VxslaWLo+jjt0eiiUgkDq2Hjdtd4pArfi3tRlSBjY5+9EjoOUMHsUEmNKrhYcqoHg+cvOcwplF\\/kG1SLXCBFbH7f\\/FMJVvXAAcLrihNCue7P98zfNP\\/v7vD8JfJtNDRQcWxZmomSSCh+88jO\\/2oHiOkLLQ0c7Z2Qw6AcgW1\\/0i5fK9NDBByWsqcvZZdfHtWKXTQjoTOCq1gowIk9O06xs7sVpClbFgc62k8xpmO8i0S4S9aJ9TJ4oyaKnhAYyLfa4LanqzSg6SqR\\/sNRLUK1yVA+LmOUQUAUn4F4qKQWvUh8Bnx1MtMPwEYIEtQ==\",\"bucket\":\"vocareum-us-west-2-1\",\"path\":\"vocareum-us-west-2-1\\/course1020\"}],\"message\":\"\"}"}],"_postman_id":"376d71dd-de15-4647-9e81-0e0b679447c8"},{"name":"Batch Script","id":"a490317b-1388-459e-ad0e-b168c56e1d5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"script\": \"Z2NjIG1haW4uYwouL2Eub3V0Cg==\",\n \"scope\": \"verification\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/batch_script","description":"

Run a batch script for a part.

Body is a json object to include the following parameters:

scope - verification (required)
script - base64 encoded script (required)

Returns \"id\" which may be queried to retrieve batch script status.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","batch_script"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"6f5fb591-4151-4051-b858-5cd55a8bb19e","name":"Batch Script - Run","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"script\": \"base64-encoded-script\",\n \"scope\": \"verification\"\n}"},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/batch_script"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jun 2019 04:51:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4edd0b891aea6d6a-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"None\", \n \"status\": \"success\", \n \"id\": 2\n}"}],"_postman_id":"a490317b-1388-459e-ad0e-b168c56e1d5d"},{"name":"Batch Script","id":"4974802a-2b44-40a0-ae7c-57b2a897e8a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/batch_script/{{id}}","description":"

Get the status of a batch script for a given \"id\".

Returns the state, exit status code and base 64 encoded output for the batch script.

The following is the list of the states for a batch script :-

Queued
Picked
Running
Completed
Killed
Server not found
Error
Cancelled

The first 3 states are the initial states when there will be a further processing and remaining ones are the terminal states.

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseId}}","assignments","{{assignmentId}}","parts","{{partId}}","batch_script","{{id}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"8f2f567e-216f-4230-8755-3a4c07ae3736","name":"Batch Script - Run","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.vocareum.com/api/v2/courses/{{courseId}}/assignments/{{assignmentId}}/parts/{{partId}}/batch_script/{{id}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jun 2019 04:51:21 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Content-Length","value":"72"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/5.6.37"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Status","value":"202"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"4edd0b891aea6d6a-SJC"}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"state\":\"COMPLETED\",\n \"exitstatus\":\"0\",\n \"output\":\"SGVsbG8gd29ybGQh\"\n}"}],"_postman_id":"4974802a-2b44-40a0-ae7c-57b2a897e8a0"},{"name":"ORG LTI Client Information","id":"e7ede8f7-ba0f-4683-830a-fa50f3853486","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/lti_clients","description":"

Gets all the sub-org LTI client information of the specified organization

Params:

orgid - organization id to fetch the LTI client information for
lti_client_entry_id - id of the lti client entry to fetch (optional)

Fetches the specified user's LTI information from all courses (within the specified org)

Params:

orgid - organization id associated with the desired LTI user information (required)
\n
userid - id of the user to fetch the LTI information for (required)
\n

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","org_users","{{userid}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"d0b9aab9-fed9-4fd4-9721-30c73757daef","name":"User's LTI Information","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/org_users/{{userid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"userInfo\": [\n {\n \"id\": \"12345\",\n \"courseid\": \"5678\",\n \"role\": \"student\",\n \"name\": \"Example Student\",\n \"email\": \"exampleStudent@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"lti_user_id\": null, // student has not accessed the course ()associated with the courseid) via LTI\n \"dropped\": 0,\n \"organization_terms_agreed\": \"\",\n \"organization_terms_agreed_date_utc\": \"\"\n },\n {\n \"id\": \"23456\",\n \"courseid\": \"78906\",\n \"role\": \"student\",\n \"name\": \"Example Student 2\",\n \"email\": \"exampleStudent2@vocareum.com\",\n \"client_key\": \"\",\n \"client_userid\": \"\",\n \"lti_user_id\":\"8c599ec5-75bf-4a69-b8f8-5a36079fc4bf\"\n \"dropped\": 0,\n \"organization_terms_agreed\": \"\",\n \"organization_terms_agreed_date_utc\": \"\"\n }\n ],\n \"totalRecords\": 2\n}"}],"_postman_id":"0ac8d944-d310-4d67-b7c4-15e1843423e8"},{"name":"Course LTI Client Information","id":"a8ddfc54-c6f8-4de5-b939-16c12cff82c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients","description":"

Get LTI Client Information related being used by the specified course

Params:

courseid - id of the course to fetch the LTI client information for

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","lti_clients"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"ece43726-ce15-4ad0-ab3c-e8227dfceba1","name":"Course LTI Client Information","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"data\":[{\"id\":\"158\",\"name\":\"Example LTI Information\",\"issuer\":\"https:\\/\\/canvas.instructure.com\",\"client_id\":\"67130000000000000\",\"key_set_url\":\"https:\\/\\/canvas.instructure.com\\/api\\/lti\\/security\\/jwks\",\"oidc_authentication_url\":\"https:\\/\\/vocareum.instructure.com\\/api\\/lti\\/authorize_redirect\",\"oauth_token_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"oauth_server_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"accessible_courses\":[\"12345\",\"23456\",\"34567\"],\"deployment_ids\":[\"101:e07440afe69e14a77fdee11agd9b1fffd1b73c1c\"]}]}"}],"_postman_id":"a8ddfc54-c6f8-4de5-b939-16c12cff82c7"},{"name":"Create/Update LTI Client Information","id":"2ed72ced-2587-4d50-a62d-473a1a9730a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/lti_clients","description":"

Creates/Updates LTI Client Information

Params:

orgid - organization id to create/update the LTI client information for
lti_client_entry_id - id of the lti client entry to update (required - when updating LTI client Information)

Body:

name - name to give the LTI client entry
issuer - issuer of the lti client entry
client_id - client id of the LTI client
key_set_url - key set url of the lti client
oidc_authentication_url - authentication url of the lti client
oauth_token_url - oauth token url of the lti client
accessible_courses - array of course ids that the lti client is eligible to access
deployment_ids - array of deployment ids that the lti client uses

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","lti_clients"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"7e016024-17ff-48d5-883d-4841dd8299d3","name":"Create new LTI Client Entry","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"name\":\"Example LTI Client\",\n \"issuer\":\"https://canvas.instructure.com\",\n \"client_id\":\"\",\n \"key_set_url\": \"https://canvas.instructure.com/api/lti/security/jwks\",\n \"oidc_authentication_url\": \"https://vocareum.instructure.com/api/lti/authorize_redirect\",\n \"oauth_token_url\": \"https://vocareum.instructure.com/login/oauth2/token\",\n \"accessible_courses\": [12345, 56789],\n \"deployment_ids\": [\"\", \"\", ...], \n}"},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/lti_clients"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Successfully added new client ()\",\"data\":{\"id\":132,\"name\":\"Example LTI Client\",\"issuer\":\"https:\\/\\/canvas.instructure.com\",\"client_id\":\"\",\"key_set_url\":\"https:\\/\\/canvas.instructure.com\\/api\\/lti\\/security\\/jwks\",\"oidc_authentication_url\":\"https:\\/\\/vocareum.instructure.com\\/api\\/lti\\/authorize_redirect\",\"oauth_token_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"oauth_server_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"accessible_courses\":[\"12345\", \"56789\"],\"deployment_ids\":[\"\", \"\"]}}"},{"id":"cd605870-5732-4081-9052-3239212b6dc3","name":"Update pre-existing LTI Client Entry","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated Example LTI Client Name\",\n \"deployment_ids\": [\"\", \"\", ...], \n}"},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/lti_clients/{{lti_client_entry_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Successfully updated client '132'\",\"data\":{\"id\":\"132\",\"name\":\"updated Example LTI Client Name\",\"issuer\":\"https:\\/\\/canvas.instructure.com\",\"client_id\":\"\",\"key_set_url\":\"https:\\/\\/canvas.instructure.com\\/api\\/lti\\/security\\/jwks\",\"oidc_authentication_url\":\"https:\\/\\/vocareum.instructure.com\\/api\\/lti\\/authorize_redirect\",\"oauth_token_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"oauth_server_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"accessible_courses\":[\"12345\", \"56789\"],\"deployment_ids\":[\"\", \"\",\"\", \"\"]}}"}],"_postman_id":"2ed72ced-2587-4d50-a62d-473a1a9730a2"},{"name":"Add Course as an Accessible Course to the LTI Client","id":"72f6f09b-e57b-48b0-b2df-6ae5f430c26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients/{{lti_client_entry_id}}","description":"

Adds the specified courseid to the list of accessible courses by the specified lti client

Params:

courseid - id of the course to add as an accessible course by the the LTI client
lti_client_entry_id - id of the lti client that the course is to be added as an accessible course to

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","lti_clients","{{lti_client_entry_id}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"5ec334c3-edd5-49f3-9891-0810073817b2","name":"Add Course as an Accessible Course to the LTI Client","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients/{{lti_client_entry_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Successfully added 67890 as an accessible course\",\"data\":{\"id\":\"132\",\"name\":\"updated Example LTI Client Name\",\"issuer\":\"https:\\/\\/canvas.instructure.com\",\"client_id\":\"\",\"key_set_url\":\"https:\\/\\/canvas.instructure.com\\/api\\/lti\\/security\\/jwks\",\"oidc_authentication_url\":\"https:\\/\\/vocareum.instructure.com\\/api\\/lti\\/authorize_redirect\",\"oauth_token_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"oauth_server_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"accessible_courses\":[\"12345\", \"56789\", \"67890\"],\"deployment_ids\":[\"\", \"\",\"\", \"\"]}}"}],"_postman_id":"72f6f09b-e57b-48b0-b2df-6ae5f430c26f"},{"name":"Remove Course as an Accessible Course to the LTI Client","id":"d60fab70-5fbb-46d3-8476-0879cdb2cd81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients/{{lti_client_entry_id}}","description":"

Remove the specified courseid to the list of accessible courses by the specified lti client

Params:

courseid - id of the course to remove as an accessible course by the the LTI client
lti_client_entry_id - id of the lti client that the course is to be removed as an accessible course to

\n","urlObject":{"protocol":"https","path":["api","v2","courses","{{courseid}}","lti_clients","{{lti_client_entry_id}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"dfc4c2f2-dd7e-46b0-bbdc-cf434955ebc7","name":"Remove Course as an Accessible Course to the LTI Client","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{mytoken}}"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":"https://api.vocareum.com/api/v2/courses/{{courseid}}/lti_clients/{{lti_client_entry_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Successfully removed 67890 as an accessible course\",\"data\":{\"id\":\"132\",\"name\":\"updated Example LTI Client Name\",\"issuer\":\"https:\\/\\/canvas.instructure.com\",\"client_id\":\"\",\"key_set_url\":\"https:\\/\\/canvas.instructure.com\\/api\\/lti\\/security\\/jwks\",\"oidc_authentication_url\":\"https:\\/\\/vocareum.instructure.com\\/api\\/lti\\/authorize_redirect\",\"oauth_token_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"oauth_server_url\":\"https:\\/\\/vocareum.instructure.com\\/login\\/oauth2\\/token\",\"accessible_courses\":[\"12345\", \"56789\"],\"deployment_ids\":[\"\", \"\",\"\", \"\"]}}"}],"_postman_id":"d60fab70-5fbb-46d3-8476-0879cdb2cd81"},{"name":"Custom Roles","id":"d25fe0a5-6f8a-443e-b6d9-cf88dd0beea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles","description":"

Gets org-level custom roles for an org

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_roles"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"44ce0d30-eb09-4eec-bb32-b2b5dc1b193b","name":"Custom Roles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"custom_roles\":[{\"id\":\"1\",\"orgid\":\"1\",\"name\":\"course role\",\"type\":\"org\",\"permissions\":\"{\\\"course\\\":[\\\"clone\\\",\\\"teacheraccess\\\"],\\\"resourcedashboard\\\":[],\\\"tickets\\\":[],\\\"labbudget\\\":[],\\\"activitylog\\\":[],\\\"fleets\\\":[]}\"}],\"total_records\":\"1\"}"}],"_postman_id":"d25fe0a5-6f8a-443e-b6d9-cf88dd0beea2"},{"name":"Custom Roles","id":"b9f7e49b-8de2-45f3-9766-acd4de5b04a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Support\",\r\n \"permissions\": {\r\n \"course\": [\"clone\"],\r\n \"labbudget\": [\"time\", \"cost\"]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles","description":"

Creates an org-level custom role

Body:

name - name to give the custom role
\n
permissions - key-value JSON where the key is the domain and the value is a list of permissions for that domain
\n

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_roles"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"ebe9dcc9-1f98-411c-b23e-b56930c5a173","name":"Custom Roles","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Support\",\r\n \"permissions\": {\r\n \"course\": [\"clone\"],\r\n \"labbudget\": [\"time\", \"cost\"]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"custom_roles\":[{\"id\":1,\"orgid\":\"1\",\"name\":\"Support\",\"type\":\"org\",\"permissions\":\"{\\\"course\\\":[\\\"clone\\\"],\\\"labbudget\\\":[\\\"time\\\",\\\"cost\\\"]}\"}]}"}],"_postman_id":"b9f7e49b-8de2-45f3-9766-acd4de5b04a3"},{"name":"Custom Roles","id":"e7d951eb-a709-4057-97ea-75f9158cd3e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Lab Time Role\",\r\n \"permissions\": {\r\n \"labbudget\": [\"time\"]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles/{{custom_role_id}}","description":"

Updates a custom role

Body:

name - name to give the custom role (optional)
\n
permissions - key-value JSON where the key is the domain and the value is a list of permissions for that domain
\n

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_roles","{{custom_role_id}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"a612d654-d758-42f2-9382-ba1daf7b2004","name":"Custom Roles","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Lab Time Role\",\r\n \"permissions\": {\r\n \"labbudget\": [\"time\"]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles/{{custom_role_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"custom_roles\":[{\"id\":\"1\",\"orgid\":\"1\",\"name\":\"Lab Time Role\",\"type\":\"org\",\"permissions\":\"{\\\"labbudget\\\":[\\\"time\\\"]}\"}]}"}],"_postman_id":"e7d951eb-a709-4057-97ea-75f9158cd3e5"},{"name":"Custom Roles","id":"7497c0c8-9769-4ad7-ae3a-4b496e671cc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles/{{custom_role_id}}","description":"

Deletes a custom role

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_roles","{{custom_role_id}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"02e21dcf-593c-4b02-94ec-a89d3a859701","name":"Custom Roles","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_roles/{{custom_role_id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\"}"}],"_postman_id":"7497c0c8-9769-4ad7-ae3a-4b496e671cc6"},{"name":"Custom Role Users","id":"2312b2f3-cd32-432b-afdc-4bf1e0d41ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users?email={{email}}","description":"

Gets the custom roles that a user is added to

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_role_users"],"host":["api","vocareum","com"],"query":[{"key":"email","value":"{{email}}"}],"variable":[]}},"response":[{"id":"c13a848e-cd22-4e3c-9971-0742c3191640","name":"Custom Role Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":{"raw":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users?email={{email}}","protocol":"https","host":["api","vocareum","com"],"path":["api","v2","orgs","{{orgid}}","custom_role_users"],"query":[{"key":"email","value":"{{email}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"custom_roles\":[{\"id\":\"1\",\"name\":\"Support\"}]}"}],"_postman_id":"2312b2f3-cd32-432b-afdc-4bf1e0d41ee0"},{"name":"Custom Role Users","id":"d1e25558-5bc9-4c8a-9ffe-260ada0f5fc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"crid\": 1,\r\n \"email\": \"test@test.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users","description":"

Adds a user to a custom role

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_role_users"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"84114afd-394a-42dc-b14c-3a62fa99d127","name":"Custom Role Users","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"crid\": 1,\r\n \"email\": \"test@test.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\"}"}],"_postman_id":"d1e25558-5bc9-4c8a-9ffe-260ada0f5fc2"},{"name":"Custom Role Users","id":"89388946-9dd2-40c6-ac87-1a0073791354","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"crid\": 1,\r\n \"email\": \"test@test.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users","description":"

Removes a user from a custom role

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","custom_role_users"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"aececf68-42e6-4b9d-bcb1-09fb2382cd9e","name":"Custom Role Users","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"crid\": 1,\r\n \"email\": \"test@test.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/custom_role_users"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\"status\":\"success\"}"}],"_postman_id":"89388946-9dd2-40c6-ac87-1a0073791354"},{"name":"Assistants","id":"25dbf906-8134-4c51-b2b9-17ec72ec56cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants","description":"

Retrieves basic information of all assistants the user has author privileges for.

Retrieves detailed information about a specific assistant.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","assistants","{{assistantid}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"b2b2902d-8651-430c-8055-1a3aa337e389","name":"Assistants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants/{{assistantid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"assistant\": [\n {\n \"id\": \"1\",\n \"name\": \"My Assistant\",\n \"api_key\": \"End user's key\",\n \"published\": 1,\n \"indexing\": 0,\n \"authors\": [\n \"example@vocareum.com\"\n ],\n \"courses\": [\n \"1\"\n ]\n }\n ]\n}"}],"_postman_id":"afd67840-bddd-43db-a3a5-942334fe492f"},{"name":"Assistants","id":"f6eadbdb-ec61-4d8f-9bb8-679aecc7ac34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"My Assistant\",\r\n \"key_name\": \"\",\r\n \"description\": \"\",\r\n \"context\": \"\",\r\n \"restrict_sources\": \"1\",\r\n \"link_sources\": \"1\",\r\n \"zipfile\": \"{zipfile}\",\r\n\t\"build\": \"0\",\r\n \"publish\": \"1\",\r\n \"share\": {\r\n \"authors\": [],\r\n \"users\": [],\r\n \"courses\": [],\r\n \"org\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants","description":"

Creates a new assistant with the specified options. Documents can be added to the assistant's knowledge base by providing a base64 encoded zip file.

The only required field is the assistant's name.

Body:

name [required] - name to give assistant
\n
key_name - name of the Vocareum GenAI key to charge for assistant use; if not specified the end user's key will be used
\n
description - description to give assistant
\n
context - system prompt context of assistant
\n
restrict_sources - 0 | 1 (default) - if enabled, assistant will only consult its knowledge base when generating responses
\n
link_sources - 0 | 1 (default) - if enabled, assistant will provide links to referenced sources when replying
\n
memory_enabled - 0 | 1 (default) - if enabled, assistant will have context of the last three user prompts when generating responses
\n
zipfile - base64 encoded zip file of documents to upload
\n
build - 0 (default) | 1 - build assistant
\n
publish - 0 | 1 (default) - publish assistant
\n
share - JSON of who to give assistant access
\n
- authors - array of user IDs; authors can edit, share, and delete the assistant
  \n
- users - array of user IDs; users can interact with the assistant
  \n
- courses - array of course IDs
  \n
- org - 0 (default) | 1 - if enabled, the assistant will be shared across the entire organization
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","assistants"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"1b5d414b-df92-48bd-b5e0-065ce12a95f4","name":"Assistants","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"My Assistant\",\r\n \"key_name\": \"\",\r\n \"description\": \"\",\r\n \"context\": \"\",\r\n \"restrict_sources\": \"1\",\r\n \"link_sources\": \"1\",\r\n \"zipfile\": \"{zipfile}\",\r\n\t\"build\": \"0\",\r\n \"publish\": \"1\",\r\n \"share\": {\r\n \"authors\": [],\r\n \"users\": [],\r\n \"courses\": [],\r\n \"org\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"assistantid\": 1\n}"}],"_postman_id":"f6eadbdb-ec61-4d8f-9bb8-679aecc7ac34"},{"name":"Assistants","id":"edc15225-d77b-42e7-9e82-ee112e3376fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"My Assistant\",\r\n \"key_name\": \"\",\r\n \"description\": \"\",\r\n \"context\": \"\",\r\n \"restrict_sources\": \"1\",\r\n \"link_sources\": \"1\",\r\n \"zipfile\": \"{zipfile}\",\r\n \"replace_files\": \"0\",\r\n\t\"build\": \"0\",\r\n \"publish\": \"1\",\r\n \"share\": {\r\n \"authors\": [],\r\n \"users\": [],\r\n \"courses\": [],\r\n \"org\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants/{{assistantid}}","description":"

Modifies an existing assistant with the specified options. Documents can be added to the assistant's knowledge base by providing a base64 encoded zip file.

All fields are optional.

Body:

name - name to give assistant
\n
key_name - name of the Vocareum GenAI key to charge for assistant use; if not specified the end user's key will be used
\n
description - description to give assistant
\n
context - system prompt context of assistant
\n
restrict_sources - 0 | 1 (default) - if enabled, assistant will only consult its knowledge base when generating responses
\n
link_sources - 0 | 1 (default) - if enabled, assistant will provide links to referenced sources when replying
\n
memory_enabled - 0 | 1 (default) - if enabled, assistant will have context of the last three user prompts when generating responses
\n
zipfile - base64 encoded zip file of documents to upload
\n
replace_files - 0 (default) | 1 - if enabled, all of the assistant's existing files will be deleted before upload
\n
build - 0 (default) | 1 - build assistant
\n
publish - 0 | 1 (default) - publish assistant
\n
share - JSON of who to give assistant access
\n
- authors - array of user IDs; authors can edit, share, and delete the assistant
  \n
- users - array of user IDs; users can interact with the assistant
  \n
- courses - array of course IDs
  \n
- org - 0 (default) | 1 - if enabled, the assistant will be shared across the entire organization
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","assistants","{{assistantid}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"ba3c98bf-c043-44ab-920e-71259391850f","name":"Assistants","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"name\": \"My Assistant\",\r\n \"key_name\": \"\",\r\n \"description\": \"\",\r\n \"context\": \"\",\r\n \"restrict_sources\": \"1\",\r\n \"link_sources\": \"1\",\r\n \"zipfile\": \"{zipfile}\",\r\n\t\"build\": \"0\",\r\n \"publish\": \"1\",\r\n \"share\": {\r\n \"authors\": [],\r\n \"users\": [],\r\n \"courses\": [],\r\n \"org\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/assistants/{{assistantid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"assistantid\": 1\n}"}],"_postman_id":"edc15225-d77b-42e7-9e82-ee112e3376fb"},{"name":"AWS Usage","id":"af93249d-3cee-405b-b97d-60a4a11d2fb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/aws_usage","description":"

This endpoint is to get AWS usage data. This endpoint returns information regarding the status of accounts for an organization and the cost associated with the organization.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","aws_usage"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"27378544-93c1-4113-bc40-065015013beb","name":"AWS Usage","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/aws_usage"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"usageData\": {\n \"unusedcount\": \"4000\",\n \"usedcount\": \"1000\",\n \"closedcount\": \"0\",\n \"discardedcount\": \"0\",\n \"fraudcount\": \"0\",\n \"totalcount\": \"5000\",\n \"payercount\": 1,\n \"totalcost\": 99.00\n }\n}"}],"_postman_id":"af93249d-3cee-405b-b97d-60a4a11d2fb5"},{"name":"Containers","id":"32324391-7b9b-42e6-bbdb-99a7f2b1d15e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/containers","description":"

Retrieves a list of all container images available to the user's organization.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","containers"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"a0117eb5-3ce9-4725-99f2-8e681e6f6532","name":"Containers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/containers"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"containers\": [\n {\n \"id\": \"1\",\n \"name\": \"My Lab\",\n \"lab_type\": \"JupyterLab\",\n \"owner\": \"user@vocareum.com\",\n \"host\": \"jupyter\",\n \"repo\": \"custom\",\n \"tag\": \"image_1_My_32_Lab\",\n \"access\": [\n {\n \"name\": \"jupyterlab\",\n \"type\": \"http\",\n \"port\": \"8888\",\n \"urlparams\": \"/lab\",\n \"routing\": \"path\"\n },\n {\n \"name\": \"jupyter\",\n \"type\": \"http\",\n \"port\": \"8888\",\n \"urlparams\": \"/tree\",\n \"routing\": \"path\"\n },\n {\n \"name\": \"vscode\",\n \"type\": \"http\",\n \"port\": \"8081\"\n },\n {\n \"name\": \"ttyd\",\n \"type\": \"http\",\n \"port\": \"8082\",\n \"routing\": \"path\"\n },\n {\n \"name\": \"jupyter_kernel\",\n \"type\": \"http\",\n \"port\": \"8083\",\n \"routing\": \"path\",\n \"version\": 1\n }\n ]\n }\n ],\n \"total_records\": 1\n}"}],"_postman_id":"32324391-7b9b-42e6-bbdb-99a7f2b1d15e"},{"name":"Containers","id":"d23fe265-fd6e-4d11-925d-d88b0ae33ac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{mytoken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"courseid\": 1,\r\n \"name\": \"My Lab\",\r\n \"host\": \"jupyter\",\r\n \"repo\": \"my/jupyter/repo\",\r\n \"tag\": \"latest\",\r\n \"access\": [\r\n {\r\n \"name\": \"jupyterlab\",\r\n \"type\": \"http\",\r\n \"port\": \"8888\",\r\n \"urlparams\": \"/lab\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/containers","description":"

Creates a new container image entry with the specified configuration.

Body:

name [required] - name to give container image
\n
courseid [optional] - ID of course to assign image to (only for legacy course-based image users)
\n
host [required] - name of application
\n
repo [required] - name of the docker repo hosting image
\n
tag [required] - image version tag
\n
access [required] - JSON of application ports
\n
- name [required] - name of process
  \n
- type [required] - connection protocol, usually http
  \n
- port [required] - port of process
  \n
- urlparams [optional] - path to process
  \n
\n

Deletes a container image entry.

\n","urlObject":{"protocol":"https","path":["api","v2","orgs","{{orgid}}","containers","{{containerid}}"],"host":["api","vocareum","com"],"query":[],"variable":[]}},"response":[{"id":"529faca5-2db2-400c-a7a8-666977fe2aa1","name":"Containers","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{mytoken}}","type":"text"}],"url":"https://api.vocareum.com/api/v2/orgs/{{orgid}}/containers/{{containerid}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Container image deleted\"\n}"}],"_postman_id":"fae459ab-6a9e-43df-ba14-e7987ae26101"}],"id":"b272a531-793d-4668-b2bf-94e6218d940b","_postman_id":"b272a531-793d-4668-b2bf-94e6218d940b","description":""},{"name":"Pending / Testing","item":[],"id":"02a682c7-8f5b-4ecb-876b-5530835a3faf","event":[{"listen":"prerequest","script":{"id":"63b88372-a71a-4e42-8ed3-8d01de7b46b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"52a2df0b-6aad-4374-bbac-bd9b8497cd00","type":"text/javascript","exec":[""]}}],"_postman_id":"02a682c7-8f5b-4ecb-876b-5530835a3faf","description":""}],"event":[{"listen":"prerequest","script":{"id":"bf62e676-e460-4657-9b92-c1df87ed39ef","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77753680-51c5-4f01-bc08-ed8023f875b1","type":"text/javascript","exec":[""]}}]}