{"_id":"5864d2e079ce642d00f0ff2c","project":"56439dfe9eebf70d00490d54","__v":21,"githubsync":"","parentDoc":null,"category":{"_id":"5864d2df79ce642d00f0fecf","__v":0,"project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-19T02:15:04.822Z","from_sync":false,"order":4,"slug":"course","title":"Course"},"user":"55dd6b48a649eb170083b97a","version":{"_id":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54","__v":18,"createdAt":"2016-12-29T09:09:51.074Z","releaseDate":"2016-12-29T09:09:51.074Z","categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T02:25:02.698Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"// Check location in header for newly created course id.","name":"","status":201,"language":"json"},{"language":"json","code":"{\n    \"title\": \"Missing field\"\n}","name":"","status":400},{"status":401,"language":"json","code":"\t"}]},"settings":"","examples":{"codes":[{"name":"","code":"{\n    \"title\": \"Introduction\",\n    \"description\": \"This is introduction course\",\n    \"thumbnail\": \"74266efb-74eb-45de-a6a8-4052710af82c.png\",\n    \"visible_on_profile\": false,\n    \"taxonomy\": {\n        \"CCSS.K12.MA-SMP\": {\n            \"title\": \"Standards for Mathematical Practice\",\n            \"code\": \"CCSS.K12.MA-SMP\",\n            \"description\": null,\n            \"framework_code\": \"CCSS\",\n            \"parent_title\": \"Math\"\n        },\n        \"CCSS.K12.MA-1\": {\n            \"title\": \"Grade 1\",\n            \"code\": \"CCSS.K12.MA-1\",\n            \"description\": null,\n            \"framework_code\": \"CCSS\",\n            \"parent_title\": \"Math\"\n        }\n    },\n    \"metadata\": {\n        \"audience\": [\n            12,\n            45\n        ]\n    },\n    \"use_case\": \"updated use case\",\n    \"subject_bucket\": \"K12 Math\"\n}","language":"json"}]},"method":"post","auth":"required","params":[{"_id":"5d5652240fd88d004575718c","ref":"","in":"body","required":true,"desc":"Title\tof\tthe\tcourse","default":"","type":"string","name":"title"},{"_id":"5d5652240fd88d004575718b","ref":"","in":"body","required":false,"desc":"Description\tof\tthe\tcourse","default":"","type":"string","name":"description"},{"_id":"5d5652240fd88d004575718a","ref":"","in":"body","required":false,"desc":"Path\tof\tthe\tthumbnail","default":"","type":"string","name":"thumbnail"},{"_id":"5d5652240fd88d0045757189","ref":"","in":"body","required":false,"desc":"Visibility\tof\tcourse\ton\tProfile","default":"","type":"boolean","name":"visible_on_profile"},{"_id":"5d5652240fd88d0045757188","ref":"","in":"body","required":false,"desc":"Taxonomy\tCourses\ttagged\tto\tcourse","default":"","type":"array_object","name":"taxonomy"},{"_id":"5d5652240fd88d0045757187","ref":"","in":"body","required":false,"desc":"Metadata\twill\tcontain\tthe\t“audience”\tproperty\t containing\tarray\tof\tids","default":"","type":"array_object","name":"metadata"},{"_id":"5d5652240fd88d0045757186","ref":"","in":"body","required":false,"desc":"Use\tcase of the\tcourse","default":"","type":"string","name":"use_case"},{"_id":"5d5652240fd88d0045757185","ref":"","in":"body","required":false,"desc":"Primary\tsubject\tof\tcourse","default":"","type":"string","name":"subject_bucket"},{"_id":"5d5652240fd88d0045757184","ref":"","in":"body","required":false,"desc":"Primary\tLanguage\tof\tcourse","default":"","type":"int","name":"primary_language"},{"_id":"5dcb930fef3291001677840e","ref":"","in":"header","required":true,"desc":"Token {authorization accesstoken}","default":"","type":"string","name":"Authorization"},{"_id":"5dcb930fef3291001677840d","ref":"","in":"header","required":false,"desc":"Set the Request content-type.","default":"application/json","type":"string","name":"Content-Type"}],"url":"/courses"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"1. Any additional data that is part of JSON payload will be ignored silently. \\n2. For the image/thumbnail value, client first needs to call the [Media API](doc:testinput) to upload the image, and then send out the image URL (*filename*) in the payload.\\n3. Audience: Need to call an API to get the [Audience](doc:list-audience) data and pass the respective id in an array.\",\n  \"title\": \"Note\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Error Description\",\n    \"0-0\": \"400 - Bad Request\",\n    \"0-1\": \"Missing required filed(s)\",\n    \"1-0\": \"401 - Unauthorized\",\n    \"1-1\": \"Missing \\\"Authorization\\\" in header.\\nInvalid \\\"Authorization\\\"\",\n    \"2-0\": \"403 - Forbidden\",\n    \"2-1\": \"Login required to create.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"Create a new Course with JSON payload","slug":"create-a-new-course","type":"endpoint","title":"Create a New Course"}

postCreate a New Course

Create a new Course with JSON payload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

title:
required
string
Title of the course
description:
string
Description of the course
thumbnail:
string
Path of the thumbnail
visible_on_profile:
boolean
Visibility of course on Profile
taxonomy:
array of objects
Taxonomy Courses tagged to course
metadata:
array of objects
Metadata will contain the “audience” property containing array of ids
use_case:
string
Use case of the course
subject_bucket:
string
Primary subject of course
primary_language:
integer
Primary Language of course

Headers

Authorization:
required
string
Token {authorization accesstoken}
Content-Type:
stringapplication/json
Set the Request content-type.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "body": "1. Any additional data that is part of JSON payload will be ignored silently. \n2. For the image/thumbnail value, client first needs to call the [Media API](doc:testinput) to upload the image, and then send out the image URL (*filename*) in the payload.\n3. Audience: Need to call an API to get the [Audience](doc:list-audience) data and pass the respective id in an array.", "title": "Note" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Error Description", "0-0": "400 - Bad Request", "0-1": "Missing required filed(s)", "1-0": "401 - Unauthorized", "1-1": "Missing \"Authorization\" in header.\nInvalid \"Authorization\"", "2-0": "403 - Forbidden", "2-1": "Login required to create." }, "cols": 2, "rows": 3 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}