{"info":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","description":"

Overview

\n

The Acorn LMS's API is organised around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

\n

To start using the API, you will first need to setup your credentials. Acorn will provide you with a Base URL, Tenancy ID, Username and Initial Refresh Token. These can be used to access all API endpoints. To start this process, please contact Acorn Support.

\n

Rate Limiting

\n

To protect our API from abuse and ensure fair usage, we enforce a rate limit of 60 requests per minute per API key. If an API key exceeds that limit, the server returns an HTTP 429 (Too Many Requests) response. If you have a use case that requires a higher rate limit please contact Acorn Support.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19721786","collectionId":"152319ea-3c92-4649-84f4-a34536dd881f","publishedId":"VUqymCej","public":true,"customColor":{"top-bar":"FBFBFB","right-sidebar":"212121","highlight":"743BFC"},"publishDate":"2024-11-08T00:19:55.000Z"},"item":[{"name":"REST APIs V1.1","item":[{"name":"Refresh API Key","item":[{"name":"Refresh API Key","event":[{"listen":"test","script":{"id":"9b070f69-8748-4cc3-b68f-50f5aa110baa","exec":["var jsonData = JSON.parse(responseBody); ","pm.environment.set(\"api_key\", jsonData[\"api_key\"]); ","pm.environment.set(\"refresh_token\", jsonData[\"refresh_token\"]);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8a13e9c2-f28f-47a5-957b-e81e8955fda6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{refresh_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/apikeys?username={{username}}","urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","apikeys"],"host":["{{base_url}}"],"query":[{"key":"username","value":"{{username}}"}],"variable":[]}},"response":[{"id":"772a13c2-705b-4d41-931e-688bf60223cf","name":"Success Example (200 OK)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/apikeys?username={{username}}","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","apikeys"],"query":[{"key":"username","value":"{{username}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"api_key\": \"WlR1RG1oZDBhV2VrcVBhclRWYjY0dGtmc0VHNUtrTzFGMmZFQ2VlbA==\",\n \"expires_in\": 86400,\n \"refresh_token\": \"aGR3YnZ5VElSaG51b1NzcjJwYmhQQUNmUW1xRDQ4N3BZSngzR2NEaQ==\"\n}"},{"id":"d879466d-e7bc-4d7c-90d8-8ec2094e3193","name":"Unauthorized Example (401 Unauthorized)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/apikeys?username={{username}}","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","apikeys"],"query":[{"key":"username","value":"{{username}}"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"Unauthorized."}],"_postman_id":"8a13e9c2-f28f-47a5-957b-e81e8955fda6"}],"id":"f52de94b-185c-442e-94e0-67bf326cf3d1","description":"

To authenticate your requests to the API you must have an API Key. An API key can be generated by making a request using the Base URL, Tenancy ID, Username and Initial Refresh Token provided by Acorn.

\n

Important

\n

The API Key and Refresh Token should be stored in a secure location once received. Each API Key is only valid for 24 hours. The most recent Refresh Token can be used to request a new API Key and Refresh Token anytime. Requesting a new API Key and Refresh Token will cause the previous API Key and Refresh Token to become invalid.

\n

Requests to all API endpoints will not be authenticated if a user-agent is not specified in the request headers. To ensure that your requests are authenticated, please include a user-agent in the request headers. If a user-agent is not provided, the API will return a 403 Forbidden error.

\n","_postman_id":"f52de94b-185c-442e-94e0-67bf326cf3d1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Activity Completions","item":[{"name":"Activity Completions","id":"c2d5d528-3cce-48f6-af60-aab43ec36194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/activitycompletions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","activitycompletions"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""},{"disabled":true,"description":{"content":"

Integer - optional, if included the endpoint will only return results with the specified activityid.

\n","type":"text/plain"},"key":"activityId","value":""},{"disabled":true,"description":{"content":"

integer - required, if included the endpoint will only return results with the specified contentid. Optional if userId is provided.

\n","type":"text/plain"},"key":"contentId","value":""},{"disabled":true,"description":{"content":"

integer - required, if included the endpoint will only return results with the specified userid. Optional if contentId is provided.

\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"

String - string optional, filter the results by contenttype

\n

Available Values:

\n

course, live learning, resource, video, program, partnered content

\n","type":"text/plain"},"key":"contentType","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true the completions of suspended users will be included

\n","type":"text/plain"},"key":"showSuspended","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true activity completion records will include all custom user fields

\n","type":"text/plain"},"key":"userFields","value":"true"}],"variable":[]}},"response":[{"id":"e480a430-cdcd-4039-ad8a-e4e9d286cb4a","name":"Activity Completions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/activitycompletions?requestid=4378&userId=4990&contentType=Course&userFields=true","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","activitycompletions"],"query":[{"key":"requestid","value":"4378"},{"key":"activityId","value":"","description":"Integer - optional, if included the endpoint will only return results with the specified activityid.","type":"text","disabled":true},{"key":"contentId","value":"","description":"integer - optional, if included the endpoint will only return results with the specified contentid.","disabled":true},{"key":"userId","value":"4990","description":"integer - optional, if included the endpoint will only return results with the specified userid."},{"key":"contentType","value":"Course","description":"String - string optional, filter the results by contenttype\n\nAvailable Values:\n\ncourse\nlive learning\nresource\nvideo\nprogram\npartnered content"},{"key":"showSuspended","value":"true","description":"boolean - optional, if true the completions of suspended users will be included","disabled":true},{"key":"userFields","value":"true","description":"boolean - optional, if true activity completion records will include all custom user fields"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"requestid\": 4378,\n \"data\": [\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"activityid\": 2168,\n \"activityname\": \"Common Practices for Computer Systems\",\n \"activitytimecompleted\": \"2022-08-24T06:58:50+00:00\",\n \"activitycompletionstatus\": \"Completed\",\n \"contentid\": 854,\n \"contenttype\": \"Course\",\n \"contentname\": \"Introduction to Computer Systems\",\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"activityid\": 2170,\n \"activityname\": \"Origin of the First Computer\",\n \"activitytimecompleted\": \"2022-08-24T06:58:59+00:00\",\n \"activitycompletionstatus\": \"Completed\",\n \"contentid\": 854,\n \"contenttype\": \"Course\",\n \"contentname\": \"Introduction to Computer Systems\",\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"activityid\": 2171,\n \"activityname\": \"Reporting Faulty Systems\",\n \"activitytimecompleted\": \"2022-08-24T06:59:13+00:00\",\n \"activitycompletionstatus\": \"Completed\",\n \"contentid\": 854,\n \"contenttype\": \"Course\",\n \"contentname\": \"Introduction to Computer Systems\",\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"activityid\": 2855,\n \"activityname\": \"Assignment\",\n \"activitytimecompleted\": \"2023-04-18T05:15:13+00:00\",\n \"activitycompletionstatus\": \"Completed\",\n \"contentid\": 713,\n \"contenttype\": \"Course\",\n \"contentname\": \"Equal Employment Opportunity\",\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"activityid\": 2075,\n \"activityname\": \"Building Resilience Module\",\n \"activitytimecompleted\": \"2022-08-24T01:30:57+00:00\",\n \"activitycompletionstatus\": \"Completed\",\n \"contentid\": 711,\n \"contenttype\": \"Course\",\n \"contentname\": \"Building Resilience\",\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n }\n ]\n}"},{"id":"98165af8-de3a-4c18-976c-dd234beaf276","name":"Processing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/activitycompletions?userFields=true","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","activitycompletions"],"query":[{"key":"requestid","value":"","disabled":true},{"key":"activityId","value":"","description":"Integer - optional, if included the endpoint will only return results with the specified activityid.","type":"text","disabled":true},{"key":"contentId","value":"","description":"integer - optional, if included the endpoint will only return results with the specified contentid.","disabled":true},{"key":"userId","value":"","description":"integer - optional, if included the endpoint will only return results with the specified userid.","type":"text","disabled":true},{"key":"contentType","value":"","description":"String - string optional, filter the results by contenttype\n\nAvailable Values:\n\ncourse\nlive learning\nresource\nvideo\nprogram\npartnered content","type":"text","disabled":true},{"key":"showSuspended","value":"true","description":"boolean - optional, if true the completions of suspended users will be included","disabled":true},{"key":"userFields","value":"true","description":"boolean - optional, if true activity completion records will include all custom user fields"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 28 Mar 2023 22:48:14 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, no-cache, private"},{"key":"Pragma","value":"no-cache"},{"key":"X-Instance","value":"https://staging.acornlms.com"},{"key":"X-Instance-name","value":"Acorn LMS Staging"},{"key":"Set-Cookie","value":"MoodleSession=cituibl3pa5sllnejd3g6bc678; path=/; secure; HttpOnly"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dc7f2062b70b5b710c1b09d21b43f900.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P2"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"sM3ESajIRASKU9bMg6aYXiIjmgILjSLV_4HdQc76yK6TLclTIIU_Uw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Processing\",\n \"requestid\": 4171\n}"},{"id":"b6693285-47f1-4024-81bf-dc8091b0c0c9","name":"Failed Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/activitycompletions?requestid=4171","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","activitycompletions"],"query":[{"key":"requestid","value":"4171"},{"key":"activityId","value":"","description":"Integer - optional, if included the endpoint will only return results with the specified activityid.","type":"text","disabled":true},{"key":"contentId","value":"","description":"integer - optional, if included the endpoint will only return results with the specified contentid.","disabled":true},{"key":"userId","value":"","description":"integer - optional, if included the endpoint will only return results with the specified userid.","type":"text","disabled":true},{"key":"contentType","value":"","description":"String - string optional, filter the results by contenttype\n\nAvailable Values:\n\ncourse\nlive learning\nresource\nvideo\nprogram\npartnered content","type":"text","disabled":true},{"key":"showSuspended","value":"true","description":"boolean - optional, if true the completions of suspended users will be included","disabled":true},{"key":"userFields","value":"true","description":"boolean - optional, if true activity completion records will include all custom user fields","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Failed\",\n \"requestid\": 4171,\n \"errors\": {\n \"exception\": \"Either a userId or contentId filter must be provided.\"\n }\n}"}],"_postman_id":"c2d5d528-3cce-48f6-af60-aab43ec36194"}],"id":"e1d87913-e855-4b56-b179-265d1b17d48c","description":"

Activity Completions include all current and archived activity completions within the LMS. Each completion record includes details about the user, the completed activity, and the piece of content that contains the activity.

\n","_postman_id":"e1d87913-e855-4b56-b179-265d1b17d48c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Attendance","item":[{"name":"Attendance","id":"3f32aa79-f64c-4254-a94c-52fb94cd4b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/attendance","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","attendance"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true the completions of suspended users will be included

\n","type":"text/plain"},"key":"showSuspended","value":"true"},{"disabled":true,"description":{"content":"

optional, if included the endpoint will only return results with the specified contentid.

\n","type":"text/plain"},"key":"contentId","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true activity completion records will include all custom user fields

\n","type":"text/plain"},"key":"userFields","value":"true"},{"disabled":true,"description":{"content":"

optional, if true attendance records will include all custom content fields

\n","type":"text/plain"},"key":"contentFields","value":"true"},{"disabled":true,"description":{"content":"

optional, if true attendance records will include all custom session fields

\n","type":"text/plain"},"key":"sessionFields","value":"true"}],"variable":[]}},"response":[{"id":"269748ea-ebd6-4675-a3ff-1f115fd220af","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/attendance?requestid=4380&userFields=true&contentFields=true&sessionFields=true","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","attendance"],"query":[{"key":"requestid","value":"4380"},{"key":"showSuspended","value":"true","description":"boolean - optional, if true the completions of suspended users will be included","disabled":true},{"key":"contentId","value":"","description":"optional, if included the endpoint will only return results with the specified contentid.","type":"text","disabled":true},{"key":"userFields","value":"true","description":"boolean - optional, if true activity completion records will include all custom user fields"},{"key":"contentFields","value":"true","description":"optional, if true attendance records will include all custom content fields"},{"key":"sessionFields","value":"true","description":"optional, if true attendance records will include all custom session fields"},{"key":"customFields","value":"true","description":"optional, if true user account records will include all custom fields","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"requestid\": 4380,\n \"data\": [\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"contentid\": 361,\n \"sessionid\": 1026,\n \"contenttype\": \"Live Learning\",\n \"contentname\": \"Project Management Masterclass\",\n \"eventname\": \"PM Masterclass\",\n \"sessiontype\": \"Face to Face\",\n \"sessionstarttime\": \"2023-03-01T13:00:00+00:00\",\n \"sessionendtime\": \"2023-03-01T14:00:00+00:00\",\n \"attendancestatus\": \"Registered\",\n \"note\": \"\",\n \"userdata\": {\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n \"contentdata\": {\n \"Recommended_Levels\": \"Level 4, Level 5\"\n },\n \"sessiondata\": {\n \"Session Provider\": \"Pursuit Technology - Project Management Division\"\n }\n },\n {\n \"userid\": 4869,\n \"username\": \"collen.abbate@example.com\",\n \"contentid\": 286,\n \"sessionid\": 992,\n \"contenttype\": \"Live Learning\",\n \"contentname\": \"Leadership Workshop\",\n \"eventname\": \"Leadership Workshop\",\n \"sessiontype\": \"Face to Face\",\n \"sessionstarttime\": \"2022-12-26T20:00:00+00:00\",\n \"sessionendtime\": \"2022-12-26T21:00:00+00:00\",\n \"attendancestatus\": \"Registered\",\n \"note\": \"\",\n \"userdata\": {\n \"Department\": \"Marketing\",\n \"EducationField\": \"Technical Degree\",\n \"EmployeeNumber\": \"463\",\n \"JobLevel\": \"1\",\n \"JobRole\": \"Laboratory Technician\",\n \"Supervisor\": \"\"\n },\n \"contentdata\": {\n \"Recommended_Levels\": \"Level 5, Level 6, Level 7\"\n },\n \"sessiondata\": {\n \"Session Provider\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"3f32aa79-f64c-4254-a94c-52fb94cd4b74"}],"id":"c2ac7ba4-a24c-4a32-8443-77aa42f04c43","description":"

Attendance includes all current attendance records within the LMS. The current attendance status is included in each attendance record along with details about the user, the relevant session, and the piece of content that contains the session.

\n

The possible Attendance Statuses include:

\n\n","_postman_id":"c2ac7ba4-a24c-4a32-8443-77aa42f04c43","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Content","item":[{"name":"Content","id":"29d04c9f-d010-4056-84e4-bcdaa2e9b82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/content","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","content"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""},{"disabled":true,"description":{"content":"

optional, if included the endpoint will only return results with the specified contentid.

\n","type":"text/plain"},"key":"contentId","value":""},{"disabled":true,"description":{"content":"

optional, filter the results by content type

\n

Available Values:\ncourse, live learning, resource, video

\n","type":"text/plain"},"key":"contentType","value":""}],"variable":[]}},"response":[{"id":"8cab7974-77e6-40f7-b003-4df1268da7c5","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/content?requestid=4381","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","content"],"query":[{"key":"requestid","value":"4381","description":"integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned"},{"key":"contentId","value":"","description":"optional, if included the endpoint will only return results with the specified contentid.","type":"text","disabled":true},{"key":"contentType","value":"","description":"optional, filter the results by content type\n\nAvailable Values:\ncourse\nlive learning\nresource\nvideo","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\n \"status\": \"Complete\",\n \"requestid\": 4381,\n \"data\": [ \n {\n \"fullname\": \"Project Management Masterclass\",\n \"contentid\": 361,\n \"contenttype\": \"Live Learning\",\n \"description\": \"

I. Introduction to Project Management

\\n

II. Project Planning

\\n
  1. Defining Project Scope: Participants will learn about the importance of defining project scope and how it sets the boundaries for the project.
    2. \\n
  2. Schedule Development: Participants will learn about the various tools and techniques used for developing a project schedule and ensuring that it aligns with project objectives.
    3. \\n
  3. Cost Estimation: Participants will learn about cost estimation techniques, including bottom-up and top-down methods, and how to create an accurate project budget.
    4. \\n
  4. Resource Allocation and Risk Management: Participants will learn about the process of allocating resources, including personnel and materials, to ensure project success. Risk management planning will also be covered, including how to identify and mitigate potential risks.
    5. \\n
  5. Creation of Project Management Plan: Participants will learn about the key components of a project management plan and how to create a comprehensive plan that sets the foundation for project success.
    6. \\n

III. Project Execution

\\n
  1. Team and Task Management: Participants will learn about the importance of team management and how to effectively manage and motivate team members to achieve project objectives. Task management, including how to prioritize tasks and monitor progress, will also be covered.
    2. \\n
  2. Quality, Change, and Stakeholder Management: Participants will learn about quality management and how to ensure that deliverables meet the required standards. Change management, including how to effectively manage and approve changes to the project scope, will also be covered. Stakeholder management, including how to engage stakeholders and address their needs and expectations, will also be covered.
    3. \\n
  3. Status Reporting: Participants will learn about the various tools and techniques used for reporting project progress, including status reports, progress charts, and dashboards.
    4. \\n

IV. Project Monitoring and Control

\\n
  1. Earned Value Management: Participants will learn about earned value management (EVM) and how it can be used to measure project performance and identify areas for improvement.
    2. \\n
  2. Performance Measurement and Progress Tracking: Participants will learn about different performance measurement techniques and how to use them to track project progress and ensure that the project is on track.
    3. \\n
  3. Variance Analysis and Risk Monitoring: Participants will learn about variance analysis and how it can be used to identify and address variances from the project plan. Risk monitoring, including how to identify potential risks and take corrective actions, will also be covered.
    4. \\n
  4. Corrective and Preventive Actions: Participants will learn about corrective and preventive actions and how they can be used to address project issues and prevent them from recurring.
    5. \\n

V. Project Closure

\\n
  1. Evaluation, Final Report, and Lessons Learned: Participants will learn about project evaluation, including how to conduct a post-project review and identify areas for improvement. Final reports, including how to document project results and deliverables, will also be covered. Lessons learned, including how to capture and apply knowledge gained from the project, will also be
    2. \\n
\",\n \"summary\": \"

I. Introduction to Project Management

\\n

II. Project Planning

\\n
  1. Defining Project Scope: Participants will learn about the importance of defining project scope and how it sets the boundaries for the project.
    2. \\n
  2. Schedule Development: Participants will learn about the various tools and techniques used for developing a project schedule and ensuring that it aligns with project objectives.
    3. \\n
  3. Cost Estimation: Participants will learn about cost estimation techniques, including bottom-up and top-down methods, and how to create an accurate project budget.
    4. \\n
  4. Resource Allocation and Risk Management: Participants will learn about the process of allocating resources, including personnel and materials, to ensure project success. Risk management planning will also be covered, including how to identify and mitigate potential risks.
    5. \\n
  5. Creation of Project Management Plan: Participants will learn about the key components of a project management plan and how to create a comprehensive plan that sets the foundation for project success.
    6. \\n

III. Project Execution

\\n
  1. Team and Task Management: Participants will learn about the importance of team management and how to effectively manage and motivate team members to achieve project objectives. Task management, including how to prioritize tasks and monitor progress, will also be covered.
    2. \\n
  2. Quality, Change, and Stakeholder Management: Participants will learn about quality management and how to ensure that deliverables meet the required standards. Change management, including how to effectively manage and approve changes to the project scope, will also be covered. Stakeholder management, including how to engage stakeholders and address their needs and expectations, will also be covered.
    3. \\n
  3. Status Reporting: Participants will learn about the various tools and techniques used for reporting project progress, including status reports, progress charts, and dashboards.
    4. \\n

IV. Project Monitoring and Control

\\n
  1. Earned Value Management: Participants will learn about earned value management (EVM) and how it can be used to measure project performance and identify areas for improvement.
    2. \\n
  2. Performance Measurement and Progress Tracking: Participants will learn about different performance measurement techniques and how to use them to track project progress and ensure that the project is on track.
    3. \\n
  3. Variance Analysis and Risk Monitoring: Participants will learn about variance analysis and how it can be used to identify and address variances from the project plan. Risk monitoring, including how to identify potential risks and take corrective actions, will also be covered.
    4. \\n
  4. Corrective and Preventive Actions: Participants will learn about corrective and preventive actions and how they can be used to address project issues and prevent them from recurring.
    5. \\n

V. Project Closure

\\n
  1. Evaluation, Final Report, and Lessons Learned: Participants will learn about project evaluation, including how to conduct a post-project review and identify areas for improvement. Final reports, including how to document project results and deliverables, will also be covered. Lessons learned, including how to capture and apply knowledge gained from the project, will also be
    2. \\n
\",\n \"totalenrolments\": \"N/A\",\n \"totalcompletions\": 506,\n \"status\": \"Active\",\n \"cost\": 0,\n \"duration\": null,\n \"programs\": [],\n \"category\": null,\n \"tags\": [],\n \"customfields\": [],\n \"timecreated\": \"2023-02-03T01:58:40+00:00\",\n \"timemodified\": \"2023-02-03T01:58:40+00:00\"\n },\n {\n \"fullname\": \"Building Resilience\",\n \"contentid\": 711,\n \"contenttype\": \"Course\",\n \"description\": \"

Purpose 

\\n

This module introduces new & existing employees to the importance of building resilience in the workplace. 

\\n

The module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. 

\\n

Learning outcomes 

\\n

By completing this module participants will be able to: 

\\n\\n

 Topics 

\\n

Topics addressed in this module are: 

\\n\\n

This module should take 20 minutes to complete.

\",\n \"summary\": \"

Purpose 

\\n

This module introduces new & existing employees to the importance of building resilience in the workplace. 

\\n

The module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. 

\\n

Learning outcomes 

\\n

By completing this module participants will be able to: 

\\n\\n

 Topics 

\\n

Topics addressed in this module are: 

\\n\\n

This module should take 20 minutes to complete.

\",\n \"totalenrolments\": 845,\n \"totalcompletions\": 845,\n \"status\": \"Active\",\n \"cost\": 0,\n \"duration\": \"40m \",\n \"programs\": [\n \"Essentials Training\"\n ],\n \"category\": \"General\",\n \"tags\": [\n \"Essentials\"\n ],\n \"customfields\": [\n {\n \"name\": \"Date last updated\",\n \"data\": \"1655042400\"\n },\n {\n \"name\": \"Contributors\",\n \"data\": \"[\\\"Pursuit Technology\\\"]\"\n },\n {\n \"name\": \"Recommended Levels\",\n \"data\": \"[\\\"Level 2\\\",\\\"Level 3\\\",\\\"Level 4\\\"]\"\n }\n ],\n \"timecreated\": \"2022-04-28T00:46:55+00:00\",\n \"timemodified\": \"2022-04-28T00:46:55+00:00\"\n }\n ]\n }"}],"_postman_id":"29d04c9f-d010-4056-84e4-bcdaa2e9b82e"}],"id":"41b42166-0132-4172-8c92-0f6607fedc79","description":"

Returns a brief overview of all learning content that has been created in the LMS.

\n","_postman_id":"41b42166-0132-4172-8c92-0f6607fedc79","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Completions","item":[{"name":"Completions","id":"f5b235cf-a7f1-4531-a89f-3259155bb6a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/completions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","completions"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""},{"disabled":true,"description":{"content":"

string - optional, filter the results by contenttype

\n

Available Values:

\n

course, live learning, resource, video, program, partnered content

\n","type":"text/plain"},"key":"contentType","value":""},{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will only return results with the specified contentid.

\n","type":"text/plain"},"key":"contentId","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true the completions of suspended users will be included

\n","type":"text/plain"},"key":"showSuspended","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true completion records will include enrolled and in progress users

\n","type":"text/plain"},"key":"includeEnrolments","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true completion records will include all custom user fields

\n","type":"text/plain"},"key":"userFields","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true custom course fields for courses will be included

\n","type":"text/plain"},"key":"contentFields","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, use pagination for requests

\n","type":"text/plain"},"key":"paginate","value":"true"},{"disabled":true,"description":{"content":"

integer - optional, the page index for this request

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

integer - optional, if paginate is enabled set how many items are returned per page

\n","type":"text/plain"},"key":"perPage","value":"15"},{"disabled":true,"description":{"content":"

boolean - optional, when paginate is enabled disable polling for responses

\n","type":"text/plain"},"key":"disablePollingWithPagination","value":"true"}],"variable":[]}},"response":[{"id":"8daa19ca-b033-4361-9e84-242934f653e3","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/completions?requestid=4382&userFields=true&contentFields=true","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","completions"],"query":[{"key":"requestid","value":"4382","description":"integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned"},{"key":"contentType","value":null,"description":"string - optional, filter the results by contenttype\n\nAvailable Values:\n\ncourse\nlive learning\nresource\nvideo\nprogram\npartnered content","type":"text","disabled":true},{"key":"contentId","value":null,"description":"integer - optional, if included the endpoint will only return results with the specified contentid.","type":"text","disabled":true},{"key":"showSuspended","value":"true","description":"boolean - optional, if true the completions of suspended users will be included","disabled":true},{"key":"includeEnrolments","value":"true","description":"boolean - optional, if true completion records will include enrolled and in progress users","disabled":true},{"key":"userFields","value":"true","description":"boolean - optional, if true completion records will include all custom user fields"},{"key":"contentFields","value":"true","description":"boolean - optional, if true custom course fields for courses will be included"},{"key":"customFields","value":"true","description":"optional, if true activity completion records will include all custom fields","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"requestid\": 4382,\n \"data\": [\n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"contentid\": 713,\n \"contenttype\": \"Course\",\n \"contentname\": \"Equal Employment Opportunity\",\n \"timeenrolled\": \"2023-04-18T05:09:24+00:00\",\n \"timestarted\": \"2023-04-18T05:09:28+00:00\",\n \"timecompleted\": \"2023-04-18T05:15:13+00:00\",\n \"completionstatus\": \"Completed\",\n \"comment\": \"\",\n \"expiry\": \"\",\n \"userdata\": {\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"EmployeeNumber\": \"584\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n \"contentdata\": {\n \"Date_last_updated\": \"\",\n \"Recommended_Levels\": \"Level 1, Level 2, Level 3\"\n }\n },\n {\n \"userid\": 4510,\n \"username\": \"emmett.cora@example.com\",\n \"contentid\": 253,\n \"contenttype\": \"Live Learning\",\n \"contentname\": \"First Aid Training\",\n \"timeenrolled\": \"\",\n \"timestarted\": \"2022-04-01T00:00:00+00:00\",\n \"timecompleted\": \"2022-04-01T00:00:00+00:00\",\n \"completionstatus\": \"Completed\",\n \"comment\": null,\n \"expiry\": \"\",\n \"userdata\": {\n \"Department\": \"Design\",\n \"EducationField\": \"Other\",\n \"EmployeeNumber\": \"104\",\n \"JobLevel\": \"2\",\n \"JobRole\": \"Sales Representative\",\n \"Supervisor\": \"\"\n },\n \"contentdata\": {\n \"Recommended_Levels\": \"Level 1, Level 2, Level 3\"\n }\n }\n ]\n}\n"}],"_postman_id":"f5b235cf-a7f1-4531-a89f-3259155bb6a5"},{"name":"Completions","id":"00580f8f-8568-49b4-9507-de394529a87c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"contentName\": \"Excel: Starting With the Basics\",\n \"contentId\": \"714\",\n \"contentType\": \"Course\",\n \"username\": \"carmina.ables@example.com\",\n \"dateCompleted\": \"2023-05-10T05:15:23Z\",\n \"comment\": \"Complete from Recognition of Prior Learning\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/completions","description":"

Upload a user completion record into Acorn LMS. This endpoint only supports one completion per request.

\n

The JSON request body contains the following properties:

\n\n

Note

\n

The JSON request must include either the contentName or the contentId. However, it is acceptable to include both.

\n

Tip

\n

The GET Content API endpoint can be used to retrieve valid:

\n\n

The Get User Accounts API endpoint can be used to retrieve a valid username

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1","tenancies","{{tenancy_id}}","completions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f1d363ba-e819-4285-86ca-07cad810a2af","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contentName\": \"Excel: Starting With the Basics\",\n \"contentId\": \"714\",\n \"contentType\": \"Course\",\n \"username\": \"carmina.ables@example.com\",\n \"dateCompleted\": \"2023-05-10T05:15:23Z\",\n \"comment\": \"Complete from Recognition of Prior Learning\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancies/{{tenancy_id}}/completions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"success\": \"Saved active course completion.\"\n }\n}"}],"_postman_id":"00580f8f-8568-49b4-9507-de394529a87c"}],"id":"326202f7-d154-46ea-bbcc-9124a0f90384","description":"

Completions include all current and archived completions within the LMS. Each completion record includes details about the user and the piece of content that was completed.

\n","_postman_id":"326202f7-d154-46ea-bbcc-9124a0f90384","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Course Enrolment","item":[{"name":"Course Enrolment","id":"651b48d5-b907-4f1e-bf0a-9cd398b097f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/enrolments/{{tenancy_id}}?username=&contentId=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_coursemanagement","index.php","api","1","enrolments","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[{"description":{"content":"

string - required, the username of the user whose training history is being retrieved

\n","type":"text/plain"},"key":"username","value":""},{"description":{"content":"

integer - required, the contentId of the course

\n","type":"text/plain"},"key":"contentId","value":""}],"variable":[]}},"response":[{"id":"15042d9e-e8c9-41d6-8ff1-607ed5dbbe66","name":"Successful Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/enrolments/{{tenancy_id}}?username=carmina.ables@example.com&contentId=716","host":["{{base_url}}"],"path":["local","acorn_coursemanagement","index.php","api","1","enrolments","{{tenancy_id}}"],"query":[{"key":"username","value":"carmina.ables@example.com","description":"string - required, the username of the user whose training history is being retrieved"},{"key":"contentId","value":"716","description":"integer - required, the contentId of the course"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"success\": true\n }\n}"}],"_postman_id":"651b48d5-b907-4f1e-bf0a-9cd398b097f6"}],"id":"ee8812c0-2c68-4d43-a3ff-521a47b2cb21","description":"

Course enrolment allows you to enrol an individual user in a course.

\n","_postman_id":"ee8812c0-2c68-4d43-a3ff-521a47b2cb21","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"External Catalogue","item":[{"name":"External Catalogue","id":"c0f9aa38-fe72-468d-a1cb-cdda8414da9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1.1/external_catalogue/{{tenancy_id}}?perPage=16","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_coursemanagement","index.php","api","1.1","external_catalogue","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[{"description":{"content":"

integer - required, specify the number of results per page, 16 is the default. Max 100

\n","type":"text/plain"},"key":"perPage","value":"16"},{"disabled":true,"description":{"content":"

integer - optional, specify the page number for pagination purposes

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

string - optional, the username of the user viewing the catalogue

\n","type":"text/plain"},"key":"username","value":""},{"disabled":true,"description":{"content":"

string - optional, filter the results by fullname

\n","type":"text/plain"},"key":"nameFilter","value":""},{"disabled":true,"description":{"content":"

optional, if included the endpoint will only return results with the specified contentid.

\n","type":"text/plain"},"key":"contentId","value":""},{"disabled":true,"description":{"content":"

string - optional, filter the results by content type

\n

Available Values:

\n

course, live learning, resource, video, program, page, partnered content

\n","type":"text/plain"},"key":"contentType","value":""},{"disabled":true,"description":{"content":"

integer - optional, filter the results by program

\n","type":"text/plain"},"key":"programId","value":""},{"disabled":true,"description":{"content":"

integer - optional, filter the results by category

\n","type":"text/plain"},"key":"categoryId","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true hidden content will be included.

\n","type":"text/plain"},"key":"showHidden","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true deactivated content will be included.

\n","type":"text/plain"},"key":"showDeactivated","value":"true"}],"variable":[]}},"response":[{"id":"7b720746-ca45-4502-bf28-7eaad721fbec","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/external_catalogue/{{tenancy_id}}?username=carmina.ables@example.com&page=1&perPage=2","host":["{{base_url}}"],"path":["local","acorn_coursemanagement","index.php","api","1","external_catalogue","{{tenancy_id}}"],"query":[{"key":"username","value":"carmina.ables@example.com","description":"string - optional, the username of the user viewing the catalogue"},{"key":"nameFilter","value":"","description":"string - optional, filter the results by fullname","disabled":true},{"key":"contentId","value":"","description":"optional, if included the endpoint will only return results with the specified contentid.","disabled":true},{"key":"contentType","value":"","description":"string - optional, filter the results by content type\n\nAvailable Values:\n\ncourse\nlive learning\nresource\nvideo\nprogram\npage\npartnered content","disabled":true},{"key":"programId","value":"","description":"integer - optional, filter the results by program","disabled":true},{"key":"categoryId","value":"","description":"integer - optional, filter the results by category","disabled":true},{"key":"page","value":"1","description":"integer - optional, specify the page number for pagination purposes"},{"key":"perPage","value":"2","description":"integer - optional, specify the number of results per page, 16 is the default. Max 100"},{"key":"showHidden","value":"true","description":"boolean - optional, if true hidden content will be included.","disabled":true},{"key":"showDeactivated","value":"true","description":"boolean - optional, if true deactivated content will be included.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"items\": [\n {\n \"fullname\": \"Building Resilience\",\n \"summary\": \"

Purpose 

\\n

This module introduces new & existing employees to the importance of building resilience in the workplace. 

\\n

The module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. 

\\n

Learning outcomes 

\\n

By completing this module participants will be able to: 

\\n\\n

 Topics 

\\n

Topics addressed in this module are: 

\\n\\n

This module should take 20 minutes to complete.

\",\n \"summarytext\": \"Purpose \\nThis module introduces new & existing employees to the importance of building resilience in the workplace. \\nThe module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. \\nLearning outcomes \\nBy completing this module participants will be able to: \\n\\nDefine resilience and outline why it is important in the workplace \\nIdentify a range of situations within and outside their locus of control \\nRecognise how individual character strengths can help build resilience \\nDemonstrate how the skill of resilience can be applied to “bounce back”. \\n\\n Topics \\nTopics addressed in this module are: \\n\\nDefinition and benefits of resilience \\nInternal locus of control, self-awareness, and self-regulation \\nRecognising and utilizing character strengths \\n“Bouncing back” from unavoidable setbacks and retaining focus. \\n\\nThis module should take 20 minutes to complete.\",\n \"contentid\": 711,\n \"contenttype\": \"Course\",\n \"url\": \"{{base_url}}/view_course/711\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/6863/course/overviewfiles/0/plant%20grow401213.jpeg\",\n \"badge\": \"{{base_url}}/pluginfile.php/6863/badges/badgeimage/57/f1?refresh=6778\",\n \"completionstatus\": \"Not Enrolled\",\n \"programs\": [\n {\n \"id\": 119,\n \"name\": \"Essentials Training\"\n }\n ],\n \"category\": null,\n \"tags\": [\n {\n \"id\": 131,\n \"name\": \"Essentials\"\n }\n ],\n \"customfields\": [\n {\n \"name\": \"Date last updated\",\n \"data\": \"1655042400\"\n },\n {\n \"name\": \"Contributors\",\n \"data\": \"[\\\"Pursuit Technology\\\"]\"\n },\n {\n \"name\": \"Recommended Levels\",\n \"data\": \"[\\\"Level 2\\\",\\\"Level 3\\\",\\\"Level 4\\\"]\"\n }\n ],\n \"cost\": 0,\n \"duration\": \"40m \",\n \"timecreated\": \"2022-04-28T00:46:55+00:00\",\n \"timemodified\": \"2022-04-28T00:46:55+00:00\"\n },\n {\n \"fullname\": \"Business Analysis Masterclass\",\n \"summary\": \"

Business Analysis Master Class Syllabus

\\n

I. Introduction to Business Analysis

\\n

II. Requirements Gathering and Management

\\n

III. Business Process Modeling

\\n\",\n \"summarytext\": \"Business Analysis Master Class Syllabus\\nI. Introduction to Business Analysis\\n\\nA. Overview\\nIn this section, participants will be introduced to the role of business analysis and its significance in driving organizational success.\\n\\n\\nB. Business Analysis Frameworks\\nParticipants will learn about the various frameworks and methodologies used in business analysis, including the Business Analysis Body of Knowledge (BABOK) and the Agile Extension to the BABOK.\\n\\n\\nC. Business Analysis Process\\nParticipants will learn about the business analysis process and how it contributes to the successful delivery of projects.\\n\\n\\nD. Business Analysis Techniques\\nParticipants will learn about the various techniques used in business analysis, including requirements gathering, modeling, and prototyping.\\n\\nII. Requirements Gathering and Management\\n\\nA. Stakeholder Analysis\\nParticipants will learn about stakeholder analysis and how to identify, prioritize, and engage stakeholders in the requirements gathering process.\\n\\n\\nB. Requirements Elicitation\\nParticipants will learn about the various techniques used for requirements elicitation, including interviews, workshops, and surveys.\\n\\n\\nC. Requirements Documentation\\nParticipants will learn about the importance of documenting requirements and how to create clear and concise requirement specifications.\\n\\n\\nD. Requirements Management\\nParticipants will learn about requirements management, including how to maintain and update requirements throughout the project life cycle.\\n\\nIII. Business Process Modeling\\n\\nA. Overview\\nParticipants will learn about the various types of business process models and how they are used to represent the flow of business processes.\\n\\n\\nB. Business Process Modeling Notation (BPMN)\\nParticipants will learn about BPMN, a widely used modeling language, and how to create process models using BPMN.\\n\\n\\nC. Process Simulation\\nParticipants will learn about process simulation and how it can be used to test and validate process models.\\n\\n\",\n \"contentid\": 362,\n \"contenttype\": \"Live Learning\",\n \"url\": \"{{base_url}}/view_facetoface/362\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/1/facetoface_image/facetoface_image_362/0//business3184647.jpeg\",\n \"badge\": \"\",\n \"completionstatus\": \"Not Started\",\n \"programs\": [],\n \"category\": null,\n \"tags\": [],\n \"customfields\": [\n {\n \"name\": \"Additional Information\",\n \"data\": \"hello world\"\n },\n {\n \"name\": \"Recommended Levels\",\n \"data\": \"[\\\"Level 2\\\",\\\"Level 3\\\",\\\"Level 4\\\"]\"\n }\n ],\n \"cost\": 0,\n \"duration\": \"\",\n \"timecreated\": \"2023-02-03T02:09:33+00:00\",\n \"timemodified\": \"2023-02-03T02:09:33+00:00\"\n }\n ],\n \"next_page_url\": \"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/external_catalogue/{{tenancy_id}}?username=carmina.ables%40example.com&perPage=16&page=2\",\n \"previous_page_url\": null,\n \"per_page\": \"2\"\n }\n}"}],"_postman_id":"c0f9aa38-fe72-468d-a1cb-cdda8414da9a"}],"id":"81da138b-42f5-465c-b1f0-cdbf811047c3","description":"

The external catalogue allows you to retrieve content from within the LMS in order to display it on an external website or intranet. This endpoint requires the External Catalogue feature to be enabled in your LMS tenancy. To have this feature enabled, please contact Acorn Support.

\n","_postman_id":"81da138b-42f5-465c-b1f0-cdbf811047c3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"External Course","item":[{"name":"External Course","id":"16a08411-49f1-48ff-8201-890c4e5a54ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/external_catalogue/{{tenancy_id}}/course/{courseId}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_coursemanagement","index.php","api","1","external_catalogue","{{tenancy_id}}","course","{courseId}"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

string - optional, the username of the user viewing the course

\n","type":"text/plain"},"key":"username","value":""}],"variable":[]}},"response":[{"id":"cc4ef43c-da9d-4c52-a44a-ff865c02f624","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_coursemanagement/index.php/api/1/external_catalogue/{{tenancy_id}}/course/{courseId}?contentId=711","host":["{{base_url}}"],"path":["local","acorn_coursemanagement","index.php","api","1","external_catalogue","{{tenancy_id}}","course","{courseId}"],"query":[{"key":"contentId","value":"711","description":"Integer - required, used to retrieve details of a specified course. "},{"key":"username","value":"","description":"string - optional, the username of the user viewing the course","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"fullname\": \"Building Resilience\",\n \"summary\": \"

Purpose 

\\n

This module introduces new & existing employees to the importance of building resilience in the workplace. 

\\n

The module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. 

\\n

Learning outcomes 

\\n

By completing this module participants will be able to: 

\\n\\n

 Topics 

\\n

Topics addressed in this module are: 

\\n\\n

This module should take 20 minutes to complete.

\",\n \"summarytext\": \"Purpose \\nThis module introduces new & existing employees to the importance of building resilience in the workplace. \\nThe module addresses the effects of workplace events on individual stress and goal-achievement, and how building resilience can benefit the individual’s ability to “bounce back” and stay on track. \\nLearning outcomes \\nBy completing this module participants will be able to: \\n\\nDefine resilience and outline why it is important in the workplace \\nIdentify a range of situations within and outside their locus of control \\nRecognise how individual character strengths can help build resilience \\nDemonstrate how the skill of resilience can be applied to “bounce back”. \\n\\n Topics \\nTopics addressed in this module are: \\n\\nDefinition and benefits of resilience \\nInternal locus of control, self-awareness, and self-regulation \\nRecognising and utilizing character strengths \\n“Bouncing back” from unavoidable setbacks and retaining focus. \\n\\nThis module should take 20 minutes to complete.\",\n \"contentid\": 711,\n \"contenttype\": \"Course\",\n \"url\": \"{{base_url}}/view_course/711\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/6863/course/overviewfiles/0/plant%20grow401213.jpeg\",\n \"badge\": \"{{base_url}}/pluginfile.php/6863/badges/badgeimage/57/f1?refresh=795\",\n \"completionstatus\": null,\n \"coursesections\": [\n {\n \"name\": \"Sync Checklist\",\n \"activities\": [\n {\n \"activityid\": 2075,\n \"name\": \"Building Resilience Module\",\n \"description\": \"Start the module here\",\n \"url\": \"{{base_url}}/view_course/711/2075\",\n \"hidden\": true,\n \"type\": \"scorm\",\n \"embedUrl\": \"{{base_url}}/local/acorn_coursemanagement/index.php/scorms/403/view\",\n \"completionstatus\": null\n },\n {\n \"activityid\": 2175,\n \"name\": \"Learning Checklist\",\n \"description\": \"Task Checklist\",\n \"url\": \"{{base_url}}/view_course/711/2175\",\n \"hidden\": false,\n \"type\": \"checklist\",\n \"listItems\": [\n {\n \"text\": \"Complete Task A\"\n },\n {\n \"text\": \"Complete Task B\"\n },\n {\n \"text\": \"Complete Task C\"\n }\n ],\n \"completionstatus\": null\n },\n {\n \"activityid\": 2683,\n \"name\": \"Building Resilience Video\",\n \"description\": \"\",\n \"url\": \"{{base_url}}/view_course/711/2683\",\n \"hidden\": false,\n \"type\": \"video\",\n \"completionstatus\": null\n },\n {\n \"activityid\": 2729,\n \"name\": \"Quiz\",\n \"description\": \"Start the knowledge quiz!\",\n \"url\": \"{{base_url}}/view_course/711/2729\",\n \"hidden\": false,\n \"type\": \"quiz\",\n \"completionstatus\": null\n }\n ]\n },\n {\n \"name\": \"Feedback\",\n \"activities\": [\n {\n \"activityid\": 2788,\n \"name\": \"Feedback form\",\n \"description\": \"give us feedback!\",\n \"url\": \"{{base_url}}/view_course/711/2788\",\n \"hidden\": false,\n \"type\": \"feedback\",\n \"completionstatus\": null\n }\n ]\n }\n ],\n \"completioncriteria\": {\n \"condition\": \"completeAllActivities\",\n \"activityids\": [\n \"2075\",\n \"2175\",\n \"2683\"\n ]\n },\n \"programs\": [\n {\n \"id\": 119,\n \"name\": \"Essentials Training\"\n }\n ],\n \"category\": null,\n \"tags\": [\n {\n \"id\": 131,\n \"name\": \"Essentials\"\n }\n ],\n \"customfields\": [\n {\n \"name\": \"Date last updated\",\n \"data\": \"1655042400\"\n },\n {\n \"name\": \"Contributors\",\n \"data\": \"[\\\"Pursuit Technology\\\"]\"\n },\n {\n \"name\": \"Recommended Levels\",\n \"data\": \"[\\\"Level 2\\\",\\\"Level 3\\\",\\\"Level 4\\\"]\"\n }\n ],\n \"cost\": 0,\n \"duration\": \"40m \",\n \"timecreated\": \"2022-04-28T00:46:55+00:00\",\n \"timemodified\": \"2022-04-28T00:46:55+00:00\"\n }\n}"}],"_postman_id":"16a08411-49f1-48ff-8201-890c4e5a54ae"}],"id":"c7128595-ae93-4fca-a6bb-dd6c952b36f4","description":"

External course allows you to retrieve the content of an individual course from within the LMS. This can be used to display a course on an external website or intranet. This endpoint requires the External Catalogue feature to be enabled in your LMS tenancy. To have this feature enabled, please contact Acorn Support.

\n","_postman_id":"c7128595-ae93-4fca-a6bb-dd6c952b36f4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"External Calendar","item":[{"name":"External Calendar","id":"3e27e603-c9e4-4d2f-a46d-769fd4e8183d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_profile/index.php/api/1/external_calendar/{{tenancy_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_profile","index.php","api","1","external_calendar","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

date (YYYY-MM-DDTHH:MM:SSZ) - optional, ISO 8601 date & time format, only sessions after this date will be shown (2021-12-25T01:30:00Z)

\n","type":"text/plain"},"key":"start","value":""},{"disabled":true,"description":{"content":"

date (YYYY-MM-DDTHH:MM:SSZ) - optional, ISO 8601 date & time format, only sessions before this date will be shown (2021-12-25T01:30:00Z)

\n","type":"text/plain"},"key":"end","value":""},{"disabled":true,"description":{"content":"

Boolean - optional, if true, the cohort-restricted sessions and Live Learnings won't be included

\n","type":"text/plain"},"key":"noCohortRestriction","value":"true"},{"disabled":true,"description":{"content":"

string - optional, filter the results by a single session venue state

\n

Available Values ():

\n

ACT\nNSW\nNT\nQLD\nSA\nTAS\nVIC

\n","type":"text/plain"},"key":"stateFilters","value":""}],"variable":[]}},"response":[{"id":"400b78a5-bc72-49c7-a150-3aeaa5f57662","name":"External Calendar","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_profile/index.php/api/1/external_calendar/{{tenancy_id}}","host":["{{base_url}}"],"path":["local","acorn_profile","index.php","api","1","external_calendar","{{tenancy_id}}"],"query":[{"key":"start","value":"","description":"date (YYYY-MM-DDTHH:MM:SSZ) - optional, ISO 8601 date & time format, only sessions after this date will be shown (2021-12-25T01:30:00Z)","disabled":true},{"key":"end","value":"","description":"date (YYYY-MM-DDTHH:MM:SSZ) - optional, ISO 8601 date & time format, only sessions before this date will be shown (2021-12-25T01:30:00Z)","disabled":true},{"key":"noCohortRestriction","value":"true","description":"Boolean - optional, if true, the cohort-restricted sessions and Live Learnings won't be included","type":"text","disabled":true},{"key":"stateFilters","value":"","description":"string - optional, filter the results by a single session venue state\n\nAvailable Values ():\n\nACT\nNSW\nNT\nQLD\nSA\nTAS\nVIC","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": [\n {\n \"type\": \"sessiondate\",\n \"title\": \"First Aid Training\",\n \"description\": \"

Ipsum et eligendi odio. Dolores eos nihil eligendi quo qui dolorum voluptatum. Est aliquid voluptatem nostrum magnam.

\\n

Architecto perspiciatis quis quo rerum. Minima veritatis incidunt accusantium voluptatem enim optio. Pariatur autem cum incidunt. Perferendis porro id voluptatem aliquid sit quis doloremque.

\\n

HTML Ipsum Presents

\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.

\\n

Header Level 2

\\n
    \\n
  1. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    2. \\n
  2. Aliquam tincidunt mauris eu risus.
    3. \\n
\\n
\\n

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus magna. Cras in mi at felis aliquet congue. Ut a est eget ligula molestie gravida. Curabitur massa. Donec eleifend, libero at sagittis mollis, tellus est malesuada tellus, at luctus turpis elit sit amet quam. Vivamus pretium ornare est.

\\n
\\n

Header Level 3

\\n\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

\",\n \"allday\": false,\n \"cohortRestricted\": false,\n \"start\": \"2023-03-01T04:00:00+00:00\",\n \"end\": \"2023-03-01T05:00:00+00:00\",\n \"location\": \"\",\n \"url\": \"{{base_url}}/view_facetoface/253/event/326/session/849\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/1/facetoface_image/facetoface_image_253/0//first%20aid5125748.jpeg\"\n },\n {\n \"type\": \"sessiondate\",\n \"title\": \"Leadership Workshop\",\n \"description\": \"

Ipsum et eligendi odio. Dolores eos nihil eligendi quo qui dolorum voluptatum. Est aliquid voluptatem nostrum magnam.

\\n

Architecto perspiciatis quis quo rerum. Minima veritatis incidunt accusantium voluptatem enim optio. Pariatur autem cum incidunt. Perferendis porro id voluptatem aliquid sit quis doloremque.

\\n

HTML Ipsum Presents

\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.

\\n

Header Level 2

\\n
    \\n
  1. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    2. \\n
  2. Aliquam tincidunt mauris eu risus.
    3. \\n
\\n
\\n

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus magna. Cras in mi at felis aliquet congue. Ut a est eget ligula molestie gravida. Curabitur massa. Donec eleifend, libero at sagittis mollis, tellus est malesuada tellus, at luctus turpis elit sit amet quam. Vivamus pretium ornare est.

\\n
\\n

Header Level 3

\\n\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

\",\n \"allday\": false,\n \"cohortRestricted\": false,\n \"start\": \"2023-03-01T10:00:00+00:00\",\n \"end\": \"2023-03-01T11:00:00+00:00\",\n \"location\": \"Sherlock's House, 221 B Baker St, London, England, Other\",\n \"url\": \"{{base_url}}/view_facetoface/286/event/359/session/950\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/1/facetoface_image/facetoface_image_286/0//leader1367276.jpeg\"\n },\n {\n \"type\": \"sessiondate\",\n \"title\": \"PM Masterclass\",\n \"description\": \"

I. Introduction to Project Management

\\n

II. Project Planning

\\n
  1. Defining Project Scope: Participants will learn about the importance of defining project scope and how it sets the boundaries for the project.
    2. \\n
  2. Schedule Development: Participants will learn about the various tools and techniques used for developing a project schedule and ensuring that it aligns with project objectives.
    3. \\n
  3. Cost Estimation: Participants will learn about cost estimation techniques, including bottom-up and top-down methods, and how to create an accurate project budget.
    4. \\n
  4. Resource Allocation and Risk Management: Participants will learn about the process of allocating resources, including personnel and materials, to ensure project success. Risk management planning will also be covered, including how to identify and mitigate potential risks.
    5. \\n
  5. Creation of Project Management Plan: Participants will learn about the key components of a project management plan and how to create a comprehensive plan that sets the foundation for project success.
    6. \\n

III. Project Execution

\\n
  1. Team and Task Management: Participants will learn about the importance of team management and how to effectively manage and motivate team members to achieve project objectives. Task management, including how to prioritize tasks and monitor progress, will also be covered.
    2. \\n
  2. Quality, Change, and Stakeholder Management: Participants will learn about quality management and how to ensure that deliverables meet the required standards. Change management, including how to effectively manage and approve changes to the project scope, will also be covered. Stakeholder management, including how to engage stakeholders and address their needs and expectations, will also be covered.
    3. \\n
  3. Status Reporting: Participants will learn about the various tools and techniques used for reporting project progress, including status reports, progress charts, and dashboards.
    4. \\n

IV. Project Monitoring and Control

\\n
  1. Earned Value Management: Participants will learn about earned value management (EVM) and how it can be used to measure project performance and identify areas for improvement.
    2. \\n
  2. Performance Measurement and Progress Tracking: Participants will learn about different performance measurement techniques and how to use them to track project progress and ensure that the project is on track.
    3. \\n
  3. Variance Analysis and Risk Monitoring: Participants will learn about variance analysis and how it can be used to identify and address variances from the project plan. Risk monitoring, including how to identify potential risks and take corrective actions, will also be covered.
    4. \\n
  4. Corrective and Preventive Actions: Participants will learn about corrective and preventive actions and how they can be used to address project issues and prevent them from recurring.
    5. \\n

V. Project Closure

\\n
  1. Evaluation, Final Report, and Lessons Learned: Participants will learn about project evaluation, including how to conduct a post-project review and identify areas for improvement. Final reports, including how to document project results and deliverables, will also be covered. Lessons learned, including how to capture and apply knowledge gained from the project, will also be
    2. \\n
\",\n \"allday\": false,\n \"cohortRestricted\": false,\n \"start\": \"2023-03-01T13:00:00+00:00\",\n \"end\": \"2023-03-01T14:00:00+00:00\",\n \"location\": \"Sherlock's House, 221 B Baker St, London, England, Other\",\n \"url\": \"{{base_url}}/view_facetoface/361/event/445/session/1026\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/1/facetoface_image/facetoface_image_361/0//timeline7376.jpeg\"\n },\n {\n \"type\": \"sessiondate\",\n \"title\": \"First Aid Training\",\n \"description\": \"

Ipsum et eligendi odio. Dolores eos nihil eligendi quo qui dolorum voluptatum. Est aliquid voluptatem nostrum magnam.

\\n

Architecto perspiciatis quis quo rerum. Minima veritatis incidunt accusantium voluptatem enim optio. Pariatur autem cum incidunt. Perferendis porro id voluptatem aliquid sit quis doloremque.

\\n

HTML Ipsum Presents

\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien ullamcorper pharetra. Vestibulum erat wisi, condimentum sed, commodo vitae, ornare sit amet, wisi. Aenean fermentum, elit eget tincidunt condimentum, eros ipsum rutrum orci, sagittis tempus lacus enim ac dui. Donec non enim in turpis pulvinar facilisis. Ut felis.

\\n

Header Level 2

\\n
    \\n
  1. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    2. \\n
  2. Aliquam tincidunt mauris eu risus.
    3. \\n
\\n
\\n

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus magna. Cras in mi at felis aliquet congue. Ut a est eget ligula molestie gravida. Curabitur massa. Donec eleifend, libero at sagittis mollis, tellus est malesuada tellus, at luctus turpis elit sit amet quam. Vivamus pretium ornare est.

\\n
\\n

Header Level 3

\\n\\n

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

\",\n \"allday\": false,\n \"cohortRestricted\": false,\n \"start\": \"2023-03-21T06:00:00+00:00\",\n \"end\": \"2023-03-21T07:00:00+00:00\",\n \"location\": \"\",\n \"url\": \"{{base_url}}/view_facetoface/253/event/326/session/1071\",\n \"imageurl\": \"{{base_url}}/local/acorn_shared/resources/assets/customfile.php/1/facetoface_image/facetoface_image_253/0//first%20aid5125748.jpeg\"\n }\n ]\n}"}],"_postman_id":"3e27e603-c9e4-4d2f-a46d-769fd4e8183d"}],"id":"ff6311d9-cac0-41bc-b308-2dbc0045958c","description":"

The external calendar allows you to retrieve calendar events from within the LMS in order to display them on an external website or intranet. This includes all the details about the calendar event and includes links to access the content directly.

\n","_postman_id":"ff6311d9-cac0-41bc-b308-2dbc0045958c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Onboarding Users","item":[{"name":"Onboarding Users","id":"bc69f86b-007c-47ce-9bc3-e101ac6ac901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/local/acorn_onboarding/index.php/api/1/tenancies/{{tenancy_id}}/onboardingusers?firstName=&lastName=&email=&mobileNumber=&commencementDate=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_onboarding","index.php","api","1","tenancies","{{tenancy_id}}","onboardingusers"],"host":["{{base_url}}"],"query":[{"description":{"content":"

string - required, max length 100 chars

\n","type":"text/plain"},"key":"firstName","value":""},{"description":{"content":"

string - required, max length 100 chars

\n","type":"text/plain"},"key":"lastName","value":""},{"description":{"content":"

string - required, max length 100 chars

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

string - required, all mobile formats accepted

\n","type":"text/plain"},"key":"mobileNumber","value":""},{"description":{"content":"

date (YYYY-MM-DDTHH:MM:SSZ) - required, ISO 8601 date & time format

\n","type":"text/plain"},"key":"commencementDate","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"managerFirstName","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"managerLastName","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"managerEmail","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"branch","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"

string - optional, max length 100 chars

\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"742aee0b-35be-4641-9152-d4257ae4d31c","name":"Successful Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/local/acorn_onboarding/index.php/api/1/tenancies/{{tenancy_id}}/onboardingusers?firstName=Edgar&lastName=Richmond&email=edgar.richmmond@example.com&mobileNumber=04XXXXXXXX&commencementDate=2023-04-27T13:00:00Z","host":["{{base_url}}"],"path":["local","acorn_onboarding","index.php","api","1","tenancies","{{tenancy_id}}","onboardingusers"],"query":[{"key":"firstName","value":"Edgar","description":"string - required, max length 100 chars"},{"key":"lastName","value":"Richmond","description":"string - required, max length 100 chars"},{"key":"email","value":"edgar.richmmond@example.com","description":"string - required, max length 100 chars"},{"key":"mobileNumber","value":"04XXXXXXXX","description":"string - required, all mobile formats accepted"},{"key":"commencementDate","value":"2023-04-27T13:00:00Z","description":"date (YYYY-MM-DDTHH:MM:SSZ) - required, ISO 8601 date & time format"},{"key":"managerFirstName","value":"","description":"string - optional, max length 100 chars","disabled":true},{"key":"managerLastName","value":"","description":"string - optional, max length 100 chars","disabled":true},{"key":"managerEmail","value":"","description":"string - optional, max length 100 chars","disabled":true},{"key":"branch","value":"","description":"string - optional, max length 100 chars","disabled":true},{"key":"location","value":"","description":"string - optional, max length 100 chars","disabled":true},{"key":"status","value":"","description":"string - optional, max length 100 chars","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"success\": true\n }\n}"}],"_postman_id":"bc69f86b-007c-47ce-9bc3-e101ac6ac901"}],"id":"49b4291c-76fd-4743-8f1f-fe23becad830","description":"

Onboarding users are new starters at their place of employment. They require restricted access to the LMS so that they can complete content that is specifically tailored for them.

\n","_postman_id":"49b4291c-76fd-4743-8f1f-fe23becad830","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Training History","item":[{"name":"Training History","id":"85d9acee-db88-4358-a8dc-7d56b32133b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_profile/index.php/api/1/training_history?tenancyId={{tenancy_id}}&username=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_profile","index.php","api","1","training_history"],"host":["{{base_url}}"],"query":[{"description":{"content":"

integer - required, the id of the user's tenancy

\n","type":"text/plain"},"key":"tenancyId","value":"{{tenancy_id}}"},{"description":{"content":"

string - required, the username of the user whose training history is being retrieved

\n","type":"text/plain"},"key":"username","value":""}],"variable":[]}},"response":[{"id":"8192063b-53a4-45a8-9306-08e469719f38","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_profile/index.php/api/1/training_history?tenancyId={{tenancy_id}}&username=carmina.ables@example.com","host":["{{base_url}}"],"path":["local","acorn_profile","index.php","api","1","training_history"],"query":[{"key":"tenancyId","value":"{{tenancy_id}}","description":"integer - required, the id of the user's tenancy"},{"key":"username","value":"carmina.ables@example.com","description":"string - required, the username of the user whose training history is being retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": {\n \"completions\": [\n {\n \"contentid\": 696,\n \"contenttype\": \"Course\",\n \"contentname\": \"Bullying and Harassment\",\n \"timeenrolled\": \"2022-06-23T14:25:38+10:00\",\n \"timestarted\": \"2022-06-23T14:25:45+10:00\",\n \"timecompleted\": \"2022-06-23T14:25:45+10:00\",\n \"completionstatus\": \"Completed\",\n \"certificatelink\": \"{{base_url}}/local/acorn_coursemanagement/index.php/generate_certificate/696/1655958345\"\n },\n {\n \"contentid\": 713,\n \"contenttype\": \"Course\",\n \"contentname\": \"Equal Employment Opportunity\",\n \"timeenrolled\": \"2022-04-28T11:34:55+10:00\",\n \"timestarted\": \"2022-04-28T15:33:46+10:00\",\n \"timecompleted\": \"2022-04-28T15:33:46+10:00\",\n \"completionstatus\": \"Completed\",\n \"certificatelink\": null\n },\n {\n \"contentid\": 361,\n \"contenttype\": \"Live Learning\",\n \"contentname\": \"Project Management Masterclass\",\n \"timeenrolled\": \"\",\n \"timestarted\": \"2021-01-24T01:35:00+11:00\",\n \"timecompleted\": \"2021-01-24T01:35:00+11:00\",\n \"completionstatus\": \"Completed\",\n \"certificatelink\": null\n }\n ],\n \"enrolments\": [\n {\n \"contentid\": 711,\n \"contenttype\": \"Course\",\n \"contentname\": \"Building Resilience\",\n \"timeenrolled\": \"2022-11-24T11:48:30+11:00\",\n \"timestarted\": \"2022-11-24T11:48:31+11:00\",\n \"completionstatus\": \"In Progress\"\n }\n ],\n \"attendance\": [\n {\n \"contentid\": 253,\n \"contenttype\": \"Live Learning\",\n \"contentname\": \"First Aid Training\",\n \"eventname\": \"First Aid Training\",\n \"sessionstarttime\": \"2022-06-01T12:00:00+10:00\",\n \"sessionendtime\": \"2022-06-01T13:00:00+10:00\",\n \"attendancestatus\": \"Attended\",\n \"sessionlink\": \"{{base_url}}/view_facetoface/253/event/326/session/731\"\n }\n ],\n \"externallearnings\": [\n {\n \"id\": 201,\n \"name\": \"Bachelor of Design\",\n \"completionstatus\": \"Degree\",\n \"method\": \"Degree\",\n \"nonagency\": true\n }\n ],\n \"partneredcontentcompletions\": [\n {\n \"contentid\": 34,\n \"contenttype\": \"Go1\",\n \"contentname\": \"...A Client or Co-Worker Doesn’t Follow Through (What to Say When…Tips and Scripts for Tricky Situations at Work)\",\n \"timestarted\": \"2022-08-24T16:33:42+10:00\",\n \"timecompleted\": \"2022-08-24T16:34:01+10:00\",\n \"completionstatus\": \"Completed\"\n }\n ],\n \"badges\": [\n {\n \"id\": 1,\n \"name\": \"Novice Explorer\",\n \"description\": \"You logged in 7 times\",\n \"timecreated\": null,\n \"courseid\": null,\n \"imageurl\": \"{{base_url}}/local/acorn_profile/resources/assets/badges/Badge-star-1.png\"\n },\n {\n \"id\": 4,\n \"name\": \"Novice Scholar\",\n \"description\": \"You completed 5 pieces of content\",\n \"timecreated\": null,\n \"courseid\": null,\n \"imageurl\": \"{{base_url}}/local/acorn_profile/resources/assets/badges/Badge-ribbon-1.png\"\n }\n {\n \"id\": 10,\n \"name\": \"Novice Viewer\",\n \"description\": \"You attended 1 session\",\n \"timecreated\": null,\n \"courseid\": null,\n \"imageurl\": \"{{base_url}}/local/acorn_profile/resources/assets/badges/Badge-space-1.png\"\n },\n {\n \"id\": 10,\n \"name\": \"Novice Viewer\",\n \"description\": \"You attended 1 session\",\n \"timecreated\": null,\n \"courseid\": null,\n \"imageurl\": \"{{base_url}}/local/acorn_profile/resources/assets/badges/Badge-space-1.png\"\n }\n ]\n }\n}"}],"_postman_id":"85d9acee-db88-4358-a8dc-7d56b32133b9"}],"id":"bcc2beac-239d-40d8-801d-b5d443f180e0","description":"

Training history includes all completion, enrolment and attendance history for a single user.

\n","_postman_id":"bcc2beac-239d-40d8-801d-b5d443f180e0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Transactions","item":[{"name":"Transactions","id":"bb08c2a2-b169-495c-9389-5e437434334b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/api/1/transactions/{{tenancy_id}}/?requestid=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","api","1","transactions","{{tenancy_id}}",""],"host":["{{base_url}}"],"query":[{"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""}],"variable":[]}},"response":[{"id":"f0bd8c9e-fe2e-4760-b260-eaec8c978ca0","name":"Transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_administration/index.php/api/1/transactions/{{tenancy_id}}/?requestid=4401","host":["{{base_url}}"],"path":["local","acorn_administration","index.php","api","1","transactions","{{tenancy_id}}",""],"query":[{"key":"requestid","value":"4401","description":"integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"requestid\": 4401,\n \"data\": [\n {\n \"receiptid\": \"LMS0102\",\n \"amount\": 65000,\n \"transactionid\": \"ch_3Mny5FIikKWPHydT1dtCR0qy\",\n \"transactiondate\": \"2023-03-21T05:50:09+00:00\",\n \"status\": \"succeeded\",\n \"user\": {\n \"id\": 12359,\n \"firstname\": \"Aiko\",\n \"lastname\": \"Absher\",\n \"username\": \"aiko.absher@example.com\"\n },\n \"payment_application\": {\n \"contentname\": \"Business Analysis Masterclass\",\n \"contentid\": 1027,\n \"contenttype\": \"Session\"\n }\n },\n {\n \"receiptid\": \"LMS0101\",\n \"amount\": 117250,\n \"transactionid\": \"ch_3Mny1BIPfHYGU3aU0tvvSRPl\",\n \"transactiondate\": \"2023-03-21T05:45:57+00:00\",\n \"status\": \"succeeded\",\n \"user\": {\n \"id\": 4490,\n \"firstname\": \"Carmina\",\n \"lastname\": \"Ables\",\n \"username\": \"theo.lionis+rego02@pursuittechnology.com\"\n },\n \"payment_application\": {\n \"contentname\": \"Introduction to Computer Systems\",\n \"contentid\": 854,\n \"contenttype\": \"Course\"\n }\n },\n {\n \"receiptid\": \"LMS0097\",\n \"amount\": 65000,\n \"transactionid\": \"ch_3MhPDaIPfHYGU3aU1rPbAu0Y\",\n \"transactiondate\": \"2023-03-03T03:23:39+00:00\",\n \"status\": \"refunded\",\n \"user\": {\n \"id\": 4869,\n \"firstname\": \"Collen\",\n \"lastname\": \"Abbate\",\n \"username\": \"collen.abbate@example.com\"\n },\n \"payment_application\": {\n \"contentname\": \"Business Analysis Masterclass\",\n \"contentid\": 1027,\n \"contenttype\": \"Session\"\n }\n }\n ]\n}"}],"_postman_id":"bb08c2a2-b169-495c-9389-5e437434334b"}],"id":"8016721e-7a7d-4600-b3b3-46f336df668f","description":"

Transactions include the details of all purchases within the LMS. The details of the user that made the purchase is included along with the LMS content the transaction is attached to.

\n","_postman_id":"8016721e-7a7d-4600-b3b3-46f336df668f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"User Accounts","item":[{"name":"User Accounts","id":"e350eebb-50d2-4eb9-929f-2e022479785b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","useraccounts"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"

integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

\n","type":"text/plain"},"key":"requestid","value":""},{"disabled":true,"description":{"content":"

boolean - optional, if true suspended user accounts will be included

\n","type":"text/plain"},"key":"showSuspended","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true user account records will include all custom user fields

\n","type":"text/plain"},"key":"userFields","value":"true"},{"disabled":true,"description":{"content":"

boolean - optional, if true user account records will include all custom content fields

\n","type":"text/plain"},"key":"contentFields","value":"true"}],"variable":[]}},"response":[{"id":"b30d2545-31d5-40cb-849e-960ccc62655b","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts?requestid=4402&showSuspended=true&userFields=true","host":["{{base_url}}"],"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","useraccounts"],"query":[{"key":"requestid","value":"4402","description":"integer - optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned"},{"key":"showSuspended","value":"true","description":"boolean - optional, if true suspended user accounts will be included"},{"key":"userFields","value":"true","description":"boolean - optional, if true user account records will include all custom user fields"},{"key":"contentFields","value":"true","description":"boolean - optional, if true user account records will include all custom content fields","type":"text","disabled":true},{"key":"customFields","value":"true","description":"boolean - optional, if true user account records will include all custom fields","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": [ \n {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"email\": \"carmina.ables@example.com\",\n \"firstname\": \"Carmina\",\n \"lastname\": \"Ables\",\n \"timecreated\": \"2022-06-23T03:13:44+00:00\",\n \"lastaccess\": \"2023-04-21T01:41:05+00:00\",\n \"lastupdated\": \"2023-04-21T01:41:05+00:00\",\n \"suspended\": \"No\",\n \"tenancyname\": \"Teddy's Tenancy\",\n \"userdata\": {\n \"Department\": \"Research & Development\",\n \"EducationField\": \"Design\",\n \"JobLevel\": \"4\",\n \"JobRole\": \"Human Resources\",\n \"Supervisor\": \"\"\n },\n \"previousaccounts\": [3002, 3019]\n },\n {\n \"userid\": 4991,\n \"username\": \"theo.lionis@example.com\",\n \"email\": \"theo.lionis@example.com\",\n \"firstname\": \"Theo\",\n \"lastname\": \"Lionis\",\n \"timecreated\": \"2022-06-23T03:13:46+00:00\",\n \"lastaccess\": \"Never\",\n \"lastupdated\": \"2022-07-18T07:00:34+00:00\",\n \"suspended\": \"No\",\n \"tenancyname\": \"Teddy's Tenancy\",\n \"userdata\": {\n \"Department\": \"Hardware\",\n \"EducationField\": \"Technical Degree\",\n \"EmployeeNumber\": \"585\",\n \"JobLevel\": \"3\",\n \"JobRole\": \"Healthcare Representative\",\n \"Supervisor\": \"\"\n },\n \"previousaccounts\": []\n }\n ]\n}"}],"_postman_id":"e350eebb-50d2-4eb9-929f-2e022479785b"},{"name":"User Accounts","id":"cbfd2b7f-2b78-4e19-9a94-177da94218be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"Sherlock\",\n \"lastName\": \"Holmes\",\n \"email\": \"sherlock.holmes@example.com\",\n \"username\": \"sherlock.holmes@example.com\",\n \"suspended\": \"false\",\n \"userData\": {\n \"CustomField1\": \"value\",\n \"CustomField2\": \"value\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts/{{user_id}}","description":"

Update an existing user in Acorn LMS. This endpoint supports only a single user per request.

\n

The URL of the request must contain the userId you wish to update. To find userId, use the GET User Accounts API.

\n

The JSON request body contains the following properties:

\n\n

Note

\n

The userData property can be formatted as follows

\n

json

\n
\"userData\":  {\n    \"CustomField1\": \"value\",\n    \"CustomField2\": \"value\"\n}\n\n
\n

Tip

\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","useraccounts","{{user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"84ce6599-de18-4175-ac10-dd1ce19e4c91","name":"User Accounts","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"Carmina\",\n \"lastName\": \"Ables\",\n \"email\": \"carmina.ables@example.com\",\n \"username\": \"carmina.ables@example.com\",\n \"suspended\": \"false\",\n \"userData\": {\n \"CustomField1\": \"value\",\n \"CustomField2\": \"value\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts/4490"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"User updated\",\n \"data\": {\n \"userid\": 4990,\n \"username\": \"carmina.ables@example.com\",\n \"email\": \"carmina.ables@example.com\",\n \"firstname\": \"Carmina\",\n \"lastname\": \"Smith\",\n \"suspended\": 0,\n \"tenancyname\": \"Teddy's Tenancy\"\n }\n}"}],"_postman_id":"cbfd2b7f-2b78-4e19-9a94-177da94218be"},{"name":"User Accounts","id":"98ed0aae-a59b-4bd6-b8da-4845a8ed4a8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"Sherlock\",\n \"lastName\": \"Holmes\",\n \"email\": \"sherlock.holmes@example.com\",\n \"username\": \"sherlock.holmes@example.com\",\n \"notify\": true,\n \"password\": \"XXXXXXXX\",\n \"confirmPassword\": \"XXXXXXXX\",\n \"userData\":{\n \"CustomField1\": \"Value\",\n \"CustomField2\": \"Value\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts","description":"

Create a new user in Acorn LMS. This endpoint supports only a single user per request.

\n

The JSON request body contains the following properties:

\n\n

Note

\n

The userData property can be formatted as follows.

\n
\"userData\":  {\n    \"CustomField1\": \"value\",\n    \"CustomField2\": \"value\"\n}\n\n
\n

Tip

\n

For uploading multiple users in one request, see User Uploads API endpoint.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1.1","tenancies","{{tenancy_id}}","useraccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"787497b7-6ba9-4dca-8901-407857f76590","name":"User Accounts","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\":\"Sherlock\",\n \"lastName\": \"Holmes\",\n \"email\": \"sherlock.holmes@example.com\",\n \"username\": \"sherlock.holmes@example.com\",\n \"password\": \"XXXXXXX\",\n \"confirmPassword\": \"XXXXXXX\",\n \"userData\":{\n \"EducationField\": \"Criminology\",\n \"JobRole\": \"Detective\",\n \"JobLevel\": 5,\n }\n}"},"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"User created\",\n \"requestid\": 4967,\n \"data\": {\n \"userid\": 14254,\n \"username\": \"sherlock.holmes@example.com\",\n \"email\": \"sherlock.holmes@example.com\",\n \"firstname\": \"Sherlock\",\n \"lastname\": \"Holmes\",\n \"suspended\": 0,\n \"tenancyname\": \"Teddy's Tenancy\"\n }\n}"}],"_postman_id":"98ed0aae-a59b-4bd6-b8da-4845a8ed4a8f"}],"id":"97be9370-58fa-4e1c-b5e8-d706790784a9","description":"

User accounts includes the details of all accounts within the LMS.

\n","_postman_id":"97be9370-58fa-4e1c-b5e8-d706790784a9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"User Uploads","item":[{"name":"User Uploads","id":"3020a72d-9cfb-449d-bc81-3a95aaffdd10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"csvdata\": [\n \"username,email,firstname,lastname,Location\",\n \"testAPI.user@example.com,testAPI.user@example.com,Test,User,Canberra ACT\"\n ],\n \"emailSend\": true,\n \"notificationSend\": true,\n \"automatic\": true \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_usermanagement/index.php/api/1/tenancies/{{tenancy_id}}/useruploads","description":"

Request Body:

\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
ParameterData TypeDetails
requestidintegeroptional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned
csvdataarrayrequired unless requestid is provided
emailSendbooleanSetting this parameter to true will send any new users a welcome email with login instructions. If this email is not sent, then users will need to be provided their password some other way, or use Single Sign On to access the system.
sendNotificationsbooleanSetting this parameter to true will send any new users a welcome email with login instructions. If this email is not sent, users will need to be provided with their password some other way or use Single Sign On to access the system. Additionally, users with a valid international mobile number within the system will be sent an SMS notifying them of their account creation. This is reliant on the SMS Notification feature being turned on within the user's tenancy.
automaticbooleanSetting this parameter to true will cause the LMS to automatically suspend users when the user has not been included in a user upload for over 90 days and
the user has not logged into the LMS for over 90 days.
\n

CSV Data

\n

A CSV format of user data. This is required unless the requestid parameter is provided.

\n\n

There are 2 other optional CSV columns that can be provided, that enable additional functionality.

\n

The suspended field can be used to make existing users suspended, preventing them from logging into the system or appearing in reports. If a row has a suspended value, but the associated user does not yet exist in the system, they will not be created. If this column is included, the user will be suspended if the value is anything other than:

\n\n

The manager_username field allows for a manager/supervisor to be specified for a user. This will give the manager/supervisor access to a dashboard within the LMS, allowing them to run reports, enrol users, and more. All the features within this dashboard are limited to users that the manager/supervisor supervises.

\n
{\n   \"csvdata\": [\n       \"username,email,firstname,lastname,manager_username,suspended\",\n       \"testAPI.user@example.com,testAPI.user@example.com,Test,User,testAPI2.user@example.com,FALSE\"\n    ]\n}\n\n
\n

Additional Custom User Fields can be included as additional columns, which can be named anything. These are useful if you want to report by additional information, or organise cohorts more efficiently. If a column is included in the file that does not match any of the requires and optional fields above and an associated user field does not already exist, a new custom user field of type text will be created.

\n

For example, if you wanted to provide additional 'Location' and 'Date Commenced' user fields, you can do so:

\n
{\n    \"csvdata\": [\n         \"username,email,firstname,lastname,Location,Date Commenced\",\n         \"testAPI.user@example.com,testAPI.user@example.com,Test,User,Canberra ACT,2019-09-26T07:58:30+00\"\n     ]\n}\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_usermanagement","index.php","api","1","tenancies","{{tenancy_id}}","useruploads"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f412881a-c5ec-475d-9b92-0f05c89d8c30","name":"User Uploads","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"csvdata\": [\n \"username,email,firstname,lastname,Location\",\n \"carmina.ables@example.com,carmina.ables@example.com,Carmina,Ables,Canberra ACT\",\n \"theo.lionis@example.com,theo.lionis@example.com,Theo,Lionis,Canberra ACT\",\n \"leonardo.dicaprio@example.com,leonardo.dicaprio@example.com,Leonardo,Dicaprio,Canberra ACT\"\n ],\n \"emailSend\": false,\n \"notificationSend\": false,\n \"automatic\": true \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_usermanagement/index.php/api/1/tenancies/{{tenancy_id}}/useruploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Processing\",\n \"requestid\": 4403\n}"},{"id":"76b5a825-6952-481e-b2e4-8893527c995a","name":"Status Check","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestid\" :4403 \n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_usermanagement/index.php/api/1/tenancies/{{tenancy_id}}/useruploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"requestid\": 4403,\n \"data\": {\n \"success\": true,\n \"totals\": \"3 records successful, 0 records unsuccessful \",\n \"message\": \"\",\n \"users\": [\n {\n \"id\": 4990,\n \"firstName\": \"Carmina\",\n \"lastName\": \"Ables\",\n \"email\": \"carmina.ables@example.com\",\n \"username\": \"carmina.ables@example.com\",\n \"lastAccess\": 1682041265,\n \"tenancyId\": {{tenancy_id}},\n \"suspended\": 0,\n \"secondaryemail\": \"\",\n \"phone1\": \"\",\n \"resetPassword\": false,\n \"password\": \"\",\n \"noCohortCalculation\": true,\n \"updates\": \"\",\n \"newstatus\": \"User Updated\"\n },\n {\n \"id\": 4991,\n \"firstName\": \"Theo\",\n \"lastName\": \"Lionis\",\n \"email\": \"theo.lionis@example.com\",\n \"username\": \"theo.lionis@example.com\",\n \"lastAccess\": 0,\n \"tenancyId\": {{tenancy_id}},\n \"suspended\": 0,\n \"secondaryemail\": \"\",\n \"phone1\": \"\",\n \"resetPassword\": false,\n \"password\": \"\",\n \"noCohortCalculation\": true,\n \"updates\": \"\",\n \"newstatus\": \"User Updated\"\n },\n {\n \"id\": 14240,\n \"firstName\": \"Leonardo\",\n \"lastName\": \"Dicaprio\",\n \"email\": \"leonardo.dicaprio@example.com\",\n \"username\": \"leonardo.dicaprio@example.com\",\n \"lastAccess\": 0,\n \"tenancyId\": {{tenancy_id}},\n \"suspended\": 0,\n \"secondaryemail\": \"\",\n \"phone1\": \"\",\n \"resetPassword\": false,\n \"password\": \"\",\n \"noCohortCalculation\": true,\n \"updates\": \"\",\n \"newstatus\": \"New User\"\n }\n ],\n \"failedRows\": []\n }\n}"}],"_postman_id":"3020a72d-9cfb-449d-bc81-3a95aaffdd10"}],"id":"c5ed9e86-0f9b-4ce9-bdc9-8f3f12a277fc","description":"

Create a large amount of user accounts in the LMS.

\n

You need to provide the data in a comma-separated list format.

\n","_postman_id":"c5ed9e86-0f9b-4ce9-bdc9-8f3f12a277fc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Tenancy Details","item":[{"name":"Tenancy Details","id":"517abdcd-766a-4bca-8efc-23917b771bee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancydetails","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_tenancymanagement","index.php","api","1","tenancydetails"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"59abaa1a-f259-43ea-b1a8-42a3ba1ae9d2","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_tenancymanagement/index.php/api/1/tenancydetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Complete\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Default Tenancy\",\n \"supportcontactname\": \"Pursuit Technology\",\n \"supportcontactemail\": \"support@pursuittechnology.com.au\",\n \"supportcontactlink\": \"https://www.pursuittechnology.com.au\",\n \"usercount\": 14\n },\n {\n \"id\": 58,\n \"name\": \"Teddy's Tenancy\",\n \"supportcontactname\": \"Theo\",\n \"supportcontactemail\": \"theo.lionis@example.com\",\n \"supportcontactlink\": \"https://www.help.acornlms.com\",\n \"usercount\": 7\n }\n ]\n}"}],"_postman_id":"517abdcd-766a-4bca-8efc-23917b771bee"}],"id":"1d99c81e-c848-418c-9682-07dc5db80ad3","description":"

Tenancy details includes the details of all tenancies within the LMS. This endpoint is only accessible using an API key assigned to the tenancy with id 0. This Tenancy Id is valid for all tenancies.

\n","_postman_id":"1d99c81e-c848-418c-9682-07dc5db80ad3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}}],"id":"067de5be-3751-4144-b619-aeeffb10b9e7","_postman_id":"067de5be-3751-4144-b619-aeeffb10b9e7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}},{"name":"Webhook APIs","item":[{"name":"List Available Webhook Events","id":"7078bd2f-a777-4b75-9bf6-870bf3e9dbe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_webhookeventlist/{{tenancy_id}}","description":"

List all the types of available Webhook Events for your instance of Acorn.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_webhookeventlist","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"834231e6-afbb-4fe3-96bf-4d8d317e0dd4","name":"List Available Webhooks","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_webhookeventlist/{{tenancy_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_list\": [\n \"Events\\\\Notifications\\\\Duedate\",\n \"Events\\\\Notifications\\\\Refresher\",\n \"Events\\\\Notifications\\\\Attendance\",\n \"Events\\\\Notifications\\\\Session_changed\",\n \"Events\\\\Notifications\\\\Session_cancelled\",\n \"Events\\\\Notifications\\\\Expressed_interest\",\n \"Events\\\\Notifications\\\\Enrolment\",\n \"Events\\\\Notifications\\\\Account_Merge\",\n \"Events\\\\Notifications\\\\Session_reminder\",\n \"Events\\\\Notifications\\\\Session_registration\",\n \"Events\\\\Notifications\\\\Session_withdrawn\",\n \"Events\\\\Notifications\\\\Session_deny\",\n \"Events\\\\Notifications\\\\Instructor_assignment\",\n \"Events\\\\Notifications\\\\Instructor_unassignment\",\n \"Events\\\\Notifications\\\\*\",\n \"Events\\\\Users\\\\Created\",\n \"Events\\\\Users\\\\Updated\",\n \"Events\\\\Users\\\\Deleted\",\n \"Events\\\\Users\\\\Tenancy_added\",\n \"Events\\\\Users\\\\Tenancy_removed\",\n \"Events\\\\Users\\\\*\",\n \"Events\\\\Courses\\\\Completion_created\",\n \"Events\\\\Courses\\\\Completion_updated\",\n \"Events\\\\Courses\\\\Completion_deleted\",\n \"Events\\\\Courses\\\\Completion_archived\",\n \"Events\\\\Courses\\\\*\",\n \"Events\\\\Quiz\\\\Attempt_completed\",\n \"Events\\\\Quiz\\\\*\",\n \"*\"\n ]\n}"}],"_postman_id":"7078bd2f-a777-4b75-9bf6-870bf3e9dbe2"},{"name":"List Subscribed Webhook Events","id":"c1ef838c-f76b-4105-a26f-527e13e1adcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_subcribedwebhookevents/{{tenancy_id}}","description":"

List all webhooks that your api key has been used to subscribe to.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_subcribedwebhookevents","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b1bcd717-1f87-428e-90d1-892958ab4f51","name":"List Subscriptions","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_subcribedwebhookevents/{{tenancy_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"subscriptions\": [\n \"Events\\\\Notifications\\\\Account_Merge\",\n \"Events\\\\Notifications\\\\Session_deny\",\n \"Events\\\\Users\\\\Created\"\n ]\n}"}],"_postman_id":"c1ef838c-f76b-4105-a26f-527e13e1adcc"},{"name":"List Failed Attempts","id":"2e0f7a3f-f222-4d36-8edf-5de51275eec9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_failedwebhooks/{{tenancy_id}}","description":"

When a webhook is dispatched to your webservice we expect to receive a 200 response. Should an error occur during the dispatch we will attempt to resend the payload another 3 times in ten minute intervals. Should all subsequent attemps fail, we will log the responses received so they can be accessed from this endpoint.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_failedwebhooks","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0c8cb214-841a-4daf-ab76-3816f1dcc4a2","name":"List Failed Attempts","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_failedwebhooks/{{tenancy_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"failed\": [\n {\n \"id\": 7,\n \"payload\": \"{\\\"userid\\\":14185,\\\"content_id\\\":\\\"course839\\\",\\\"notification_type\\\":\\\"enrolment_enrolled\\\",\\\"notification_detail\\\":\\\"{\\\\\\\"notificationtitle\\\\\\\":\\\\\\\"You have been enrolled into a new course\\\\\\\",\\\\\\\"contenttype\\\\\\\":\\\\\\\"course\\\\\\\",\\\\\\\"contentid\\\\\\\":839,\\\\\\\"notificationbody\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"notificationdate\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"url\\\\\\\":\\\\\\\"\\\\\\\\\\\\/view_course\\\\\\\\\\\\/839\\\\\\\",\\\\\\\"dateformat\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"icon\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"webhookpayload\\\\\\\":{\\\\\\\"webhook_event\\\\\\\":\\\\\\\"Enrolment\\\\\\\"}}\\\",\\\"read\\\":0,\\\"senttime\\\":1681428089,\\\"updated_at\\\":\\\"2023-04-14 09:21:29\\\",\\\"created_at\\\":\\\"2023-04-14 09:21:29\\\",\\\"id\\\":130761}\",\n \"event\": \"*\",\n \"response\": null,\n \"failed_at\": \"2023-04-13 23:41:34\"\n },\n {\n \"id\": 8,\n \"payload\": \"{\\\"userid\\\":14185,\\\"content_id\\\":\\\"course839\\\",\\\"notification_type\\\":\\\"overdue\\\",\\\"notification_detail\\\":\\\"{\\\\\\\"notificationtitle\\\\\\\":\\\\\\\"Your completion became overdue\\\\\\\",\\\\\\\"contenttype\\\\\\\":\\\\\\\"course\\\\\\\",\\\\\\\"contentid\\\\\\\":839,\\\\\\\"notificationbody\\\\\\\":\\\\\\\"Due by \\\\\\\",\\\\\\\"notificationdate\\\\\\\":1681600889,\\\\\\\"url\\\\\\\":\\\\\\\"\\\\\\\\\\\\/view_course\\\\\\\\\\\\/839\\\\\\\",\\\\\\\"dateformat\\\\\\\":\\\\\\\"date\\\\\\\",\\\\\\\"icon\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"webhookpayload\\\\\\\":{\\\\\\\"webhook_event\\\\\\\":\\\\\\\"Duedate\\\\\\\"}}\\\",\\\"read\\\":0,\\\"senttime\\\":1681707857,\\\"updated_at\\\":\\\"2023-04-17 15:04:17\\\",\\\"created_at\\\":\\\"2023-04-17 15:04:17\\\",\\\"id\\\":131834}\",\n \"event\": \"*\",\n \"response\": null,\n \"failed_at\": \"2023-04-17 05:24:26\"\n },\n {\n \"id\": 9,\n \"payload\": \"{\\\"userid\\\":12010,\\\"content_id\\\":\\\"course712\\\",\\\"notification_type\\\":\\\"overdue\\\",\\\"notification_detail\\\":\\\"{\\\\\\\"notificationtitle\\\\\\\":\\\\\\\"Your completion became overdue\\\\\\\",\\\\\\\"contenttype\\\\\\\":\\\\\\\"course\\\\\\\",\\\\\\\"contentid\\\\\\\":712,\\\\\\\"notificationbody\\\\\\\":\\\\\\\"Due by \\\\\\\",\\\\\\\"notificationdate\\\\\\\":1665721594,\\\\\\\"url\\\\\\\":\\\\\\\"\\\\\\\\\\\\/view_course\\\\\\\\\\\\/712\\\\\\\",\\\\\\\"dateformat\\\\\\\":\\\\\\\"date\\\\\\\",\\\\\\\"icon\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"webhookpayload\\\\\\\":{\\\\\\\"webhook_event\\\\\\\":\\\\\\\"Duedate\\\\\\\"}}\\\",\\\"read\\\":0,\\\"senttime\\\":1681708071,\\\"updated_at\\\":\\\"2023-04-17 15:07:51\\\",\\\"created_at\\\":\\\"2023-04-17 15:07:51\\\",\\\"id\\\":131835}\",\n \"event\": \"*\",\n \"response\": null,\n \"failed_at\": \"2023-04-17 05:28:00\"\n },\n {\n \"id\": 10,\n \"payload\": \"{\\\"userid\\\":12011,\\\"content_id\\\":\\\"course712\\\",\\\"notification_type\\\":\\\"overdue\\\",\\\"notification_detail\\\":\\\"{\\\\\\\"notificationtitle\\\\\\\":\\\\\\\"Your completion became overdue\\\\\\\",\\\\\\\"contenttype\\\\\\\":\\\\\\\"course\\\\\\\",\\\\\\\"contentid\\\\\\\":712,\\\\\\\"notificationbody\\\\\\\":\\\\\\\"Due by \\\\\\\",\\\\\\\"notificationdate\\\\\\\":1665721595,\\\\\\\"url\\\\\\\":\\\\\\\"\\\\\\\\\\\\/view_course\\\\\\\\\\\\/712\\\\\\\",\\\\\\\"dateformat\\\\\\\":\\\\\\\"date\\\\\\\",\\\\\\\"icon\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"webhookpayload\\\\\\\":{\\\\\\\"webhook_event\\\\\\\":\\\\\\\"Duedate\\\\\\\"}}\\\",\\\"read\\\":0,\\\"senttime\\\":1681708071,\\\"updated_at\\\":\\\"2023-04-17 15:07:51\\\",\\\"created_at\\\":\\\"2023-04-17 15:07:51\\\",\\\"id\\\":131836}\",\n \"event\": \"*\",\n \"response\": null,\n \"failed_at\": \"2023-04-17 05:28:00\"\n }\n ]\n}"}],"_postman_id":"2e0f7a3f-f222-4d36-8edf-5de51275eec9"},{"name":"Subscribe to a Webhook Event","id":"5580ea72-4d50-4b31-a55c-b85be09493f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_subscribe/{{tenancy_id}}?event=","description":"

Subscribe to an event in the system. You can specify either one event or an array of events to subscribe to. Wildcard * may be used to subscribe to groups of events or all system events.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_subscribe","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[{"key":"event","value":""}],"variable":[]}},"response":[{"id":"49a48670-ab31-47ed-9a4e-63896e1194bc","name":"Subscribe to a Webhook","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/local/acorn_administration/index.php/webhookevents_subscribe/{{tenancy_id}}?event=Events\\\\Notifications\\\\Session_deny","host":["{{base_url}}"],"path":["local","acorn_administration","index.php","webhookevents_subscribe","{{tenancy_id}}"],"query":[{"key":"event","value":"Events\\\\Notifications\\\\Session_deny"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event\": [\n \"Events\\\\Notifications\\\\Session_deny\"\n ]\n}"}],"_postman_id":"5580ea72-4d50-4b31-a55c-b85be09493f5"},{"name":"Unsubscribe to a Webhook Event","id":"21c4b2bc-d1f6-4060-b680-10854fb6c388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": [\n \"Events\\\\Notifications\\\\*\",\n \"*\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_unsubscribe/{{tenancy_id}}","description":"

Unsubscribe from an event you have previously subscribed to. You may provide an array of events or a single event to unsubscribe from. Wildcard * may be used to unsubscribe to groups of events or all system events.

\n

The body of the post is either an array of strings or a string defining the webhook or webhook group you are unsubscribing too, * can be used as a wildcard to unsubscribe to multiple events or all events.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_unsubscribe","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fbec4076-f574-4287-92f8-7dec127c9660","name":"Unsubscribe to a Webhook","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": [\n \"Events\\\\Notifications\\\\Account_Merge\",\n \"Events\\\\Notifications\\\\Session_deny\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/local/acorn_administration/index.php/webhookevents_subscribe/{{tenancy_id}}","host":["{{base_url}}"],"path":["local","acorn_administration","index.php","webhookevents_subscribe","{{tenancy_id}}"],"query":[{"key":"event","value":"Events\\\\Users\\\\Updated","description":"Either an array of strings or a string defining the webhook or webhook group you are unsubscribing too, * can be used as a wildcard to unsubscribe to multiple events or all events.","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": [\n \"Events\\\\Notifications\\\\Account_Merge\",\n \"Events\\\\Notifications\\\\Session_deny\"\n ]\n}"}],"_postman_id":"21c4b2bc-d1f6-4060-b680-10854fb6c388"},{"name":"Relay Service","id":"9f2979db-ed6a-4e18-85c0-a349830a68b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"{{webhookUrl}}\",\n \"event\": \"Events\\\\Users\\\\Created\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_relay/{{tenancy_id}}","description":"

Send a sample webhook event back to your service for testing and development purposes.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}},"urlObject":{"path":["local","acorn_administration","index.php","webhookevents_relay","{{tenancy_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cd89b6e5-7233-425b-99cb-cd056a284a9d","name":"Relay Service","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"url\": {{webhookUrl}},\n\"event\": \"Events\\\\Users\\\\Created\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/local/acorn_administration/index.php/webhookevents_relay/{{tenancy_id}}"},"status":"Example payload","_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"event\": \"Events\\\\Users\\\\Created\",\n \"payload\": {\n \"user\": {\n \"id\": \"123456\",\n \"first_name\": \"acorn\",\n \"last_name\": \"user\",\n \"username\": \"user@acornlms.com\",\n \"email\": \"user@acornlms.com\",\n \"last_access\": \"2023-04-21T04:25:42+00:00\",\n \"time_created\": \"2023-04-21T04:25:42+00:00\",\n \"tenancy_id\": \"1\"\n }\n }\n}"}],"_postman_id":"9f2979db-ed6a-4e18-85c0-a349830a68b2"}],"id":"87d8048a-a2c8-420f-8675-4b9461435e51","description":"

Acorn Webhooks are automatic updates for your app that keep it current with what's happening in Acorn. Think of them as your app's personal assistant, keeping you informed so you don't have to check for updates yourself constantly. It's like having a butler that taps you on the shoulder and tells you the important stuff.

\n
\n

How to get started

\n

When an event is triggered in Acorn, the details will be posted to your Webhook URL in the format of a JSON payload.

\n
    \n
  1. Provide your Webhook URL to the Acorn support team @ help.acornlms.com
    2. \n
  2. Subscribe your API Key to an available webhook event.
    3. \n
  3. An event is triggered in Acorn.
    4. \n
  4. Details of the event are posted to your Webhook URL in JSON format.
    5. \n
\n\n
\n

Authenticate requests to this API's endpoints by sending an Authorization header with the value \"Bearer api_key\"

\n","_postman_id":"87d8048a-a2c8-420f-8675-4b9461435e51","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"152319ea-3c92-4649-84f4-a34536dd881f","id":"152319ea-3c92-4649-84f4-a34536dd881f","name":"Acorn API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"78f4cd22-f64c-4f45-9c4e-975c119dca3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1fa9312f-5f09-4b0e-8cad-6454480bd98b","type":"text/javascript","exec":[""]}}]}