Course Assignments
Assign, start, complete, and view course assignments.
GET /course_assignments/{course_assignmentid}
Fetch detailed information about an assignment.
Route Parameters
- course_assignmentid — Required — integer
-
Identifier for assignment being fetched.
Response
Status: 200 Ok
{ "course_assignmentid": 1, "wikiid": 174, "assignee_userid": null, "assignee_teamid": 1, "assignee_name": "Quality Managers", "assignee_url": "\/Team\/Contributions\/1\/Quality+Managers", "completion_status": [ { "userid": 2, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 452, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "completed", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 453, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 414, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": null, "init_date": 1558459658, "end_date": null, "work_log_entryid": 1768 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 3, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 153, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1544056932, "end_date": 1544056968, "work_log_entryid": 1142 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 208, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1352, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1548266440, "end_date": 1548266447, "work_log_entryid": 1267 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 491, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1562599632, "end_date": null, "work_log_entryid": 1929 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 7, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 82, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006334, "end_date": 1541006349, "work_log_entryid": 985 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 87, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1200, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006501, "end_date": 1541006506, "work_log_entryid": 990 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 86, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": 1054, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006466, "end_date": 1541006488, "work_log_entryid": 989 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "How to Set Up and Use the Roll Form Machine" } ] } ], "user_completion_status": null, "due_within": 2592000, "created_date": 1539302623, "cancelled": 0, "course": { "wikiid": 174, "langid": "en", "namespace": "COURSE", "title": "Machinist - Level 1", "revisionid": 460, "contents_raw": "The introduction course for machinist.", "contents_json": { "type": "doc", "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "The introduction course for machinist." } ] } ] }, "contents_rendered": "<p>The introduction course for machinist.<\/p>", "can_edit": true, "flags": [], "image": null, "documents": [], "publish_date": 1539241200, "created_date": 1539302493, "modified_date": null, "enabled": 1, "stages": [ { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": " How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null } ], "assigneeCount": 18, "assignees": null, "completionPercent": 0, "viewUrl": "\/Courses\/View\/174" } }
GET /course_assignments/individualSummaries
Fetch summary information about all individuals.
Query Parameters
- orderby — Optional — enum
-
What field to order the individual summaries list with. Currently only supports "name".
- direction — Optional — enum
-
Which direction to sort the list in. Must be "ASC" or "DESC". Defaults to "ASC".
- query — Optional — string
-
A search query string used to find specific individuals. Matches any individual whose name contains the query.
- page — Optional — integer
-
Which page of results to look at. Each page includes 30 results. Defaults to 1.
Response
Status: 200 Ok
{ "individualSummaries": [ { "userid": 3, "name": "Brian Sallee", "image": "https:\/\/dyzth6bemm87w.cloudfront.net\/igi\/hansaw\/ivnKCTQiLcUUvGZn.thumbnail?Expires=1564177930&Signature=KIdo1~M3mubdfWJ39uDqX6rL6yd4F-NxPZ09~dq2x0K7HL-mvTKlk52~ETGPRHRsqxLyOI33iYOwp5xBaKKKhWBQaqWDfzFyX6LLB~PwmOODHaoRYjvBl22zapVJDEWJ3QNAc-qlwi~bJSPw0pZpI~OqPX2tId4yI5f-BTkRW-U_&Key-Pair-Id=APKAJZLVNL246ATUNVDQ", "courseCount": 8, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/3" }, { "userid": 2, "name": "Carl Roberts", "image": "https:\/\/dyzth6bemm87w.cloudfront.net\/igi\/hansaw\/Fg1NYsgJrkl1MPsJ.thumbnail?Expires=1564177930&Signature=Cl8DqLhE2WCr81QL4wyoWG9XIYCQkeQbnKy38Vv9DMyj6qxnnr9ENUaXm78w0ZxPw32wUWXpY56keF63jWOKCp478qIngNrP-NJTcYbfvOXNgHM850kgs6aPJ4C3Og92mFMGB-akLxUpQtELNsucagLVuMHdL6DvTWaS32r-hMk_&Key-Pair-Id=APKAJZLVNL246ATUNVDQ", "courseCount": 12, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/2" } ], "hasMore": false }
GET /course_assignments/individualSummaries/{userid}
Fetch summary details about an individual. This includes course assignment details.
Route Parameters
- userid — Required — integer
-
Identifier for the user.
Response
Status: 200 Okay
{ "courses": [ { "course_assignmentid": 1, "title": "Machinist - Level 1", "description": "The introduction course for machinist.", "completions": 2, "completionPercent": 66, "total": 3, "dueDate": 1541894493, "completionStatus": "expired", "assignmentUrl": "\/Courses\/1", "wikiid": 174 }, { "course_assignmentid": 6, "title": "LT 3X70 Assembly - Station 1 Operator Training", "description": "Training for operators at station 1 on the LT 3X70 assembly line.", "completions": 0, "completionPercent": 0, "total": 7, "dueDate": 1557858436, "completionStatus": "expired", "assignmentUrl": "\/Courses\/6", "wikiid": 176 }, { "course_assignmentid": 7, "title": "Quality Training", "description": "Training for all quality personnel.", "completions": 2, "completionPercent": 50, "total": 4, "dueDate": 1542826654, "completionStatus": "started", "assignmentUrl": "\/Courses\/7", "wikiid": 181 }, { "course_assignmentid": 8, "title": "Quality Training", "description": "Training for all quality personnel.", "completions": 2, "completionPercent": 50, "total": 4, "dueDate": 1542826654, "completionStatus": "started", "assignmentUrl": "\/Courses\/8", "wikiid": 181 }, { "course_assignmentid": 9, "title": "Lock Out Tag Out Training - Maintenance Dept.", "description": "Required LOTO training for all maintenance employees.", "completions": 0, "completionPercent": 0, "total": 1, "dueDate": 1542562709, "completionStatus": "pending", "assignmentUrl": "\/Courses\/9", "wikiid": 180 }, { "course_assignmentid": 15, "title": "Machinist - Level 2", "description": "Improve your technical skills set in order to achieve the intermediate level for Machinist", "completions": 0, "completionPercent": 0, "total": 3, "dueDate": 1541943213, "completionStatus": "expired", "assignmentUrl": "\/Courses\/15", "wikiid": 175 }, { "course_assignmentid": 16, "title": "Safety Training - Level 1", "description": "Required safety training for all employees working in the factory.", "completions": 0, "completionPercent": 0, "total": 1, "dueDate": 1542130573, "completionStatus": "pending", "assignmentUrl": "\/Courses\/16", "wikiid": 179 }, { "course_assignmentid": 30, "title": "HAAS VM6 5 Axis - Preventative Maintenance", "description": "This is a collection of preventative maintenance tasks that need to be completed routinely on the HAAS VM6 5 Axis. Each guide listed in this collection is a task and we've set them to recur at regular intervals.", "completions": 0, "completionPercent": 0, "total": 3, "dueDate": null, "completionStatus": "pending", "assignmentUrl": "\/Courses\/30", "wikiid": 202 } ] }
GET /course_assignments/teamSummaries
Fetch summary information about all teams.
Query Parameters
- orderby — Optional — enum
-
What field to order the team summaries list with. Currently only supports "name".
- direction — Optional — enum
-
Which direction to sort the list in. Must be "ASC" or "DESC". Defaults to "ASC".
- query — Optional — string
-
A search query string used to find specific teams. Matches any team whose name contains the query.
- page — Optional — integer
-
Which page of results to look at. Each page includes 30 results. Defaults to 1.
- pageSize — Optional — integer
-
The maximum number of results to include in the response.
Response
Status: 200 Ok
{ "teamSummaries": [ { "teamid": 11, "image": "https:\/\/d1ulmmr4d4i8j4.cloudfront.net\/static\/images\/avatars\/Team\/generic\/team-avatar-02.thumbnail", "name": "Approval Team", "memberCount": 1, "courseCount": 0, "assignedCoursesUrl": "\/Courses\/Assignments\/Team\/11" }, { "teamid": 9, "image": "https:\/\/d1ulmmr4d4i8j4.cloudfront.net\/static\/images\/avatars\/Team\/generic\/team-avatar-06.thumbnail", "name": "Assembly FL 2S20 - Line 1", "memberCount": 6, "courseCount": 1, "assignedCoursesUrl": "\/Courses\/Assignments\/Team\/9" } ], "hasMore": false }
GET /course_assignments/teamSummaries/{teamid}
Fetch summary details about a team. This includes team member and assignment details
Route Parameters
- teamid — Required — integer
-
Identifier for the team.
Response
Status: 200 Okay
{ "members": [ { "userid": 2, "name": "Carl Roberts", "image": "https:\/\/dyzth6bemm87w.cloudfront.net\/igi\/hansaw\/Fg1NYsgJrkl1MPsJ.thumbnail?Expires=1564177473&Signature=QfbTWyhW9b4Z5pchBIKyFZH8IoPyAm7STd69zmf2APJUIhm7044Zwy5Ma-O5QMEtNbZC6pm1mNRCwD9VWjG3y4IuYceUsf5L-tDT2F1TWu22RolQ2SREJZqMm5TvsIwL9qhV0yygK9LEXRN6X9kRgyVgcGNXg2NoyzxCMf3bpzw_&Key-Pair-Id=APKAJZLVNL246ATUNVDQ", "completions": { "28": 1 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/2" }, { "userid": 7, "name": "Roger Smith", "image": "https:\/\/dyzth6bemm87w.cloudfront.net\/igi\/hansaw\/UcPLgJYu3YGdcNW6.thumbnail?Expires=1564177473&Signature=sVedMb8NuwxYLOwvqGuv09aQNlg~utvRf43d87UKLL3AmavkuUuDTyzgYoFKQtRqnAelEg8Ei-6R3An1SmOxyNwXDX3kpRmtfPaHmfvpA2m15H7WWeMssihzwUQWvHt9q6R-9eMYTY9GxycC1c0Iyexkh~bNDdGYgFLUIoMxqB4_&Key-Pair-Id=APKAJZLVNL246ATUNVDQ", "completions": { "28": 3 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/7" }, { "userid": 10, "name": "Kim Payne", "image": "https:\/\/d1ulmmr4d4i8j4.cloudfront.net\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-02.thumbnail", "completions": { "28": 0 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/10" }, { "userid": 12, "name": "Ericka Tims", "image": "https:\/\/d1ulmmr4d4i8j4.cloudfront.net\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-06.thumbnail", "completions": { "28": 0 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/12" }, { "userid": 18, "name": "Sarah Phillips", "image": "https:\/\/dyzth6bemm87w.cloudfront.net\/igi\/hansaw\/gPR1LXuFdT2vmJQt.thumbnail?Expires=1564177473&Signature=YT9CU8639GV6dkkihoqLxnbqYIZuUrbDQmWRGec3ZSeX71c9fW6jy99kxpkXy0ToDMuDgck2XcpchENpfiIryapoHwDnxwzgAsOu2o4lTpR4bVl45j1zHTgAPoX-ZvRFyKZ2oDf9AgWNy-0bsHvxvc1pTj3g5H7zzfSFTWHiwrY_&Key-Pair-Id=APKAJZLVNL246ATUNVDQ", "completions": { "28": 0 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/18" }, { "userid": 19, "name": "Crystal Simmersonly", "image": "https:\/\/d1ulmmr4d4i8j4.cloudfront.net\/static\/images\/avatars\/User\/Dozuki\/single-avatar-2-02.thumbnail", "completions": { "28": 0 }, "assignedCoursesUrl": "\/Courses\/Assignments\/User\/19" } ], "courses": [ { "course_assignmentid": 28, "completions": 4, "completionPercent": 9, "total": 42, "title": "LT 3X70 Assembly - Station 1 Operator Training", "stageCount": 7, "wikiid": 176 } ] }
GET /course_assignments/completion/course/{wikiid}
Get the overall completion for a course. The value returned is a percentage between 0 and 100.
Route Parameters
- wikiid — Required — integer
-
Identifier for course.
Response
Status: 200 Okay
{ "totalCompletion": 50 }
GET /course_assignments/completion/team/{teamid}
Get the overall completion for a team. The value returned is a percentage between 0 and 100.
Route Parameters
- teamid — Required — integer
-
Identifier for the team.
Response
Status: 200 Okay
{ "totalCompletion": 50 }
GET /course_assignments/completion/user/{userid}
Get the overall completion for a user. The value returned is a percentage between 0 and 100.
Route Parameters
- userid — Required — integer
-
Identifier for the user.
Response
Status: 200 Okay
{ "totalCompletion": 50 }
GET /course_assignments/completion/team/{$teamid}/user/{userid}
Get the overall completion for a user on a team's assignments. The value returned is a percentage between 0 and 100.
Route Parameters
- teamid — Required — integer
-
Identifier for the team.
- userid — Required — integer
-
Identifier for the user.
Response
Status: 200 Okay
{ "totalCompletion": 50 }
POST /course_assignments/completion/courses
Get the overall completion for multiple courses. Completion is calculated from all assignments to each course. This returns completion percents keyed by wikiid.
Request Body
- wikiids — Required — array of integers
-
Identifiers for each course.
Response
Status: 200 Okay
{ "completionPercents": { "23": 85, "45": 70 } }
POST /course_assignments/completion/teams
Get the overall completion for multiple teams. Completion is calculated from all assignments to each team. This returns completion percents keyed by teamid.
Request Body
- teamids — Required — array of integers
-
Identifiers for each team.
Response
Status: 200 Okay
{ "completionPercents": { "23": 85, "45": 70 } }
POST /course_assignments/completion/users
Get the overall completion for multiple users. Completion is calculated from all assignments to each user as well as assignments to any teams the user is a part of. This returns completion percents keyed by userid.
Request Body
- userids — Required — array of integers
-
Identifiers for each user.
Response
Status: 200 Okay
{ "completionPercents": { "23": 85, "45": 70 } }
POST /course_assignments
Assign a course to a user or team.
Request Body
- wikiid — Required — integer
-
Identifier for course being assigned.
- assignee_userid — Optional — integer
-
Identifier for assignee user. Required for user assignment. Cannot be used alongside assignee_teamid.
- assignee_teamid — Optional — integer
-
Identifier for assignee team. Required for team assignment. Cannot be used alongside assignee_userid.
- due_within — Optional — integer
-
Duration in seconds until assignment's initial due date.
Response
Status: 200 Ok
{ "course_assignmentid": 1, "wikiid": 174, "assignee_userid": null, "assignee_teamid": 1, "assignee_name": "Quality Managers", "assignee_url": "\/Team\/Contributions\/1\/Quality+Managers", "completion_status": [ { "userid": 2, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 452, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "completed", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 453, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 414, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": null, "init_date": 1558459658, "end_date": null, "work_log_entryid": 1768 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 3, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 153, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1544056932, "end_date": 1544056968, "work_log_entryid": 1142 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 208, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1352, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1548266440, "end_date": 1548266447, "work_log_entryid": 1267 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 491, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1562599632, "end_date": null, "work_log_entryid": 1929 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 7, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 82, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006334, "end_date": 1541006349, "work_log_entryid": 985 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 87, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1200, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006501, "end_date": 1541006506, "work_log_entryid": 990 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 86, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": 1054, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006466, "end_date": 1541006488, "work_log_entryid": 989 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "How to Set Up and Use the Roll Form Machine" } ] } ], "user_completion_status": null, "due_within": 2592000, "created_date": 1539302623, "cancelled": 0, "course": { "wikiid": 174, "langid": "en", "namespace": "COURSE", "title": "Machinist - Level 1", "revisionid": 460, "contents_raw": "The introduction course for machinist.", "contents_json": { "type": "doc", "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "The introduction course for machinist." } ] } ] }, "contents_rendered": "<p>The introduction course for machinist.<\/p>", "can_edit": true, "flags": [], "image": null, "documents": [], "publish_date": 1539241200, "created_date": 1539302493, "modified_date": null, "enabled": 1, "stages": [ { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": " How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null } ], "assigneeCount": 18, "assignees": null, "completionPercent": 0, "viewUrl": "\/Courses\/View\/174" } }
PATCH /course_assignments/start/{doctype}/{docid}
Start completion on a course stage's document. Will return a 403 error if the user has completed the document.
Route Parameters
- doctype — Required — string
-
Type of document for completion. Either "guide" or "wiki".
- docid — Required — integer
-
The identifier for the stage guide/wiki.
Request Body
- work_log_entryid — Optional — integer
-
Identifier for corresponding work log entry if one exists.
Response
Status: 204 No Content
PATCH /course_assignments/complete/{doctype}/{docid}
Finish completion on a course stage's document.
Route Parameters
- doctype — Required — string
-
Type of document for completion. Either "guide" or "wiki".
- docid — Required — integer
-
The identifier for the stage guide/wiki.
Request Body
- manager_override — Optional — boolean
-
Flag used to force completion for another user. Requires admin privilege.
- assignee_userid — Optional — integer
-
User for which to complete the specified course. Must be specified if manager_override is true.
Response
Status: 204 No Content
PATCH /course_assignments/invalidate/{doctype}/{docid}/{userid}
Invalidate completion on a course stage's document. Requires admin privilege.
Route Parameters
- doctype — Required — string
-
Type of document for completion. Either "guide" or "wiki".
- docid — Required — integer
-
The identifier for the stage guide/wiki.
- userid — Required — integer
-
The identifier for the user whose completion is being invalidated.
Response
Status: 204 No Content
PATCH /course_assignments/User/completeAll/{assignee_userid}
Force completion for a user on multiple documents. Requires admin privilege.
Route Parameters
- assignee_userid — Required — integer
-
Identifier for user for which to force completions.
Request Body
- documents — Required — array of objects
-
List of documents on which to force completions.
- docid— Required integer. The identifier for the stage guide/wiki.
- doctype— Required enum. Type of document for stage. Either "guide" or "wiki". Currently "guide" is the only supported doctype.
Response
Status: 204 No Content
PATCH /course_assignments/Team/completeAll/{assignee_teamid}
Force completion for a team on multiple documents. Requires admin privilege.
Route Parameters
- assignee_teamid — Required — integer
-
Identifier for team for which to force completions.
Request Body
- documents — Required — array of objects
-
List of documents on which to force completions.
- docid— Required integer. The identifier for the stage guide/wiki.
- doctype— Required enum. Type of document for stage. Either "guide" or "wiki". Currently "guide" is the only supported doctype.
Response
Status: 204 No Content
PATCH /course_assignments/User/invalidateAll/{assignee_userid}
Force invalidate multiple documents for a user. Requires admin privilege.
Route Parameters
- assignee_userid — Required — integer
-
Identifier for user for which to force invalidation.
Request Body
- documents — Required — array of objects
-
List of documents on which to force invalidation.
- docid— Required integer. The identifier for the stage guide/wiki.
- doctype— Required enum. Type of document for stage. Either "guide" or "wiki". Currently "guide" is the only supported doctype.
Response
Status: 204 No Content
PATCH /course_assignments/Team/invalidateAll/{assignee_teamid}
Force invalidate multiple documents for a team. Requires admin privilege.
Route Parameters
- assignee_teamid — Required — integer
-
Identifier for team for which to force invalidation.
Request Body
- documents — Required — array of objects
-
List of documents on which to force invalidation.
- docid— Required integer. The identifier for the stage guide/wiki.
- doctype— Required enum. Type of document for stage. Either "guide" or "wiki". Currently "guide" is the only supported doctype.
Response
Status: 204 No Content
DELETE /course_assignments/{course_assignmentid}
Cancel a course assignment.
Route Parameters
- course_assignmentid — Required — integer
-
Identifier for assignment being cancelled.
Response
Status: 200 Ok
{ "course_assignmentid": 1, "wikiid": 174, "assignee_userid": null, "assignee_teamid": 1, "assignee_name": "Quality Managers", "assignee_url": "\/Team\/Contributions\/1\/Quality+Managers", "completion_status": [ { "userid": 2, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 452, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "completed", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 453, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": 49, "init_date": 1560184816, "end_date": 1560184816, "work_log_entryid": null }, "manager_override_userid": 49, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 414, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 2, "manager_override_userid": null, "init_date": 1558459658, "end_date": null, "work_log_entryid": 1768 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 3, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 153, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1544056932, "end_date": 1544056968, "work_log_entryid": 1142 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 208, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1352, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1548266440, "end_date": 1548266447, "work_log_entryid": 1267 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 491, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": null, "assignee_userid": 3, "manager_override_userid": null, "init_date": 1562599632, "end_date": null, "work_log_entryid": 1929 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "started", "title": "How to Set Up and Use the Roll Form Machine" } ] }, { "userid": 7, "stages": [ { "course_stageid": 72, "due_date": 1573430623, "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "last_completion": { "course_assignment_stage_completionid": 82, "doctype": "guide", "docid": 2, "course_stage_doc_revisionid": 1202, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006334, "end_date": 1541006349, "work_log_entryid": 985 }, "manager_override_userid": null, "stage": { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, "status": "expired", "title": "How to Calibrate WIPS" }, { "course_stageid": 73, "due_date": 1541894623, "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "last_completion": { "course_assignment_stage_completionid": 87, "doctype": "guide", "docid": 35, "course_stage_doc_revisionid": 1200, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006501, "end_date": 1541006506, "work_log_entryid": 990 }, "manager_override_userid": null, "stage": { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "CNC Machine Operation" }, { "course_stageid": 74, "due_date": 1541894623, "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "last_completion": { "course_assignment_stage_completionid": 86, "doctype": "guide", "docid": 37, "course_stage_doc_revisionid": 1054, "assignee_userid": 7, "manager_override_userid": null, "init_date": 1541006466, "end_date": 1541006488, "work_log_entryid": 989 }, "manager_override_userid": null, "stage": { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": "How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null }, "status": "completed", "title": "How to Set Up and Use the Roll Form Machine" } ] } ], "user_completion_status": null, "due_within": 2592000, "created_date": 1539302623, "cancelled": 0, "course": { "wikiid": 174, "langid": "en", "namespace": "COURSE", "title": "Machinist - Level 1", "revisionid": 460, "contents_raw": "The introduction course for machinist.", "contents_json": { "type": "doc", "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "The introduction course for machinist." } ] } ] }, "contents_rendered": "<p>The introduction course for machinist.<\/p>", "can_edit": true, "flags": [], "image": null, "documents": [], "publish_date": 1539241200, "created_date": 1539302493, "modified_date": null, "enabled": 1, "stages": [ { "course_stageid": 72, "docid": 2, "doctype": "guide", "doc_url": "\/Guide\/How+to+Calibrate+WIPS\/2", "orderby": 0, "strictness": "major", "title": "How to Calibrate WIPS", "frequency_quantity": 6, "frequency_unit": "month", "completion": null }, { "course_stageid": 73, "docid": 35, "doctype": "guide", "doc_url": "\/Guide\/CNC+Machine+Operation\/35", "orderby": 1, "strictness": "minor", "title": "CNC Machine Operation", "frequency_quantity": null, "frequency_unit": null, "completion": null }, { "course_stageid": 74, "docid": 37, "doctype": "guide", "doc_url": "\/Guide\/How+to+Set+Up+and+Use+the+Roll+Form+Machine\/37", "orderby": 2, "strictness": null, "title": " How to Set Up and Use the Roll Form Machine", "frequency_quantity": null, "frequency_unit": null, "completion": null } ], "assigneeCount": 18, "assignees": null, "completionPercent": 0, "viewUrl": "\/Courses\/View\/174" } }
GET /course_assignments/courseAssignmentDetails/{course_assignmentid}
Retrieve course assignment data for the specified assignment and currently logged in user. This includes the course author information, and course assignment details with data for each stage. The course assignment can only be viewed if it's assigned to the user that is requesting to view it
Route Parameters
- course_assignmentid — Required — integer
-
Identifier for the course assignment.
Response
Status: 200 Ok
{ "authorInfo": { "userid": 1, "username": "Admin", "url": "https:\/\/siteurl\/User\/3\/Admin" }, "courseAssignment": { "course_assignmentid": 382, "wikiid": 265, "assignee_userid": 160, "assignee_teamid": null, "assignee_name": "User", "assignee_url": "\/User\/160\/User", "completion_status": null, "user_completion_status": [ { "course_stageid": 732, "due_date": 1670351169, "doc_url": "\/Guide\/Forklift+Safety\/401", "last_completion": { "course_assignment_stage_completionid": 4364, "doctype": "guide", "docid": 401, "course_stage_doc_revisionid": null, "assignee_userid": 160, "manager_override_userid": null, "init_date": 1670448822, "end_date": null, "work_log_entryid": null }, "manager_override_userid": null, "stage": { "course_stageid": 732, "docid": 401, "doctype": "guide", "doc_url": "\/Guide\/Forklift+Safety\/401", "orderby": 0, "strictness": null, "title": "Forklift Safety", "frequency_quantity": null, "frequency_unit": null, "completion": null, "guideSummaryInfo": { "title": "Forklift Safety", "isHidden": false, "stepCount": 51, "workLogEnabled": 0, "requiresSignoff": false, "standardImage": "https:\/\/siteurl\/igi\/sitename\/LI6WkTndWEuaqnJe.standard", "guideViewUrl": "\/Guide\/Forklift+Safety\/401?trainingVersion=1", "dataCaptureUrl": "https:\/\/siteurl\/Guide\/data-capture\/401?trainingVersion=1", "upcomingRelease": false, "viewUserEntryPdfUrl": null, "releaseTitle": "v2.0", "version": "2.0" } }, "status": "started", "title": "Forklift Safety" } ], "due_within": 86400, "created_date": 1670264769, "cancelled": 0, "course": { "wikiid": 265, "langid": "en", "namespace": "COURSE", "title": "Forklift Training - New Drivers", "revisionid": 1127, "contents_raw": "Basic training for new users", "contents_json": { "type": "doc", "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "Basic training for new users" } ] } ] }, "contents_rendered": "<p>Basic training for new users<\/p>", "can_edit": true, "flags": [], "image": null, "documents": [], "publish_date": null, "created_date": 1568312447, "modified_date": null, "enabled": 1, "assigneeCount": 9, "viewUrl": "\/Courses\/View\/265", "stages": [ { "course_stageid": 732, "docid": 401, "doctype": "guide", "doc_url": "\/Guide\/Forklift+Safety\/401", "orderby": 0, "strictness": null, "title": "Forklift Safety", "frequency_quantity": null, "frequency_unit": null, "completion": null, "guideSummaryInfo": { "title": "Forklift Safety", "isHidden": false, "stepCount": 51, "workLogEnabled": 0, "requiresSignoff": false, "standardImage": "https:\/\/siteurl\/igi\/sitename\/LI6WkTndWEuaqnJe.standard", "guideViewUrl": "\/Guide\/Forklift+Safety\/401?trainingVersion=1", "dataCaptureUrl": "https:\/\/siteurl\/Guide\/data-capture\/401?trainingVersion=1", "upcomingRelease": false, "viewUserEntryPdfUrl": null, "releaseTitle": "v2.0", "version": "2.0" } } ] } } }