{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/courses/:course-id/units","auth":"required","examples":{"codes":[{"name":"","code":"{ \n   \"title\":\"My third Unit\",\n   \"big_ideas\":\"this is my second call to create unit\",\n   \"essential_questions\":\"what is the purpose of unit?\",\n   \"taxonomy\":{ \n      \"CCSS.K12.MA-K-CC\":{ \n         \"title\":\"Counting & Cardinality\",\n         \"code\":\"CCSS.K12.MA-K-CC\",\n         \"description\":null,\n         \"framework_code\":\"CCSS\",\n         \"parent_title\":\"Kindergarten\"\n      },\n      \"CCSS.K12.MA-3-G\":{ \n         \"title\":\"Geometry\",\n         \"code\":\"CCSS.K12.MA-3-G\",\n         \"description\":null,\n         \"framework_code\":\"CCSS\",\n         \"parent_title\":\"Grade3\"\n      }\n   },\n   \"primary_language\":1\n}","language":"json"}]},"method":"post","params":[{"name":"course-id","type":"string","default":"","desc":"","required":false,"in":"path","ref":"","_id":"56f0cc3042c16f0e00e1fe79"},{"name":"title","type":"string","default":"","desc":"Title\tof\tthe\tUnit","required":true,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc71c"},{"name":"big_ideas","type":"string","default":"null","desc":"Bid\tIdeas\tfor\tUnit","required":false,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc71b"},{"name":"essential_questions","type":"string","default":"null","desc":"Essential\tquestions\tfor\tUnit","required":false,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc71a"},{"name":"taxonomy","type":"array_object","default":"null","desc":"Taxonomy\tDomains\tto\ttag\twith\tUnit","required":false,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc719"},{"name":"creator_system","type":"string","default":"null","desc":"Creator\tname","required":false,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc718"},{"name":"primary_language","type":"int","default":"1","desc":"Primary\tLanguage\tof\tUnit. Default is '1' for English.","required":false,"in":"body","ref":"","_id":"5d5640650cb0af0024bbc717"},{"name":"Authorization","type":"string","default":"","desc":"Token {authorization access token}","required":true,"in":"header","ref":"","_id":"5dd4bf4f11beda002f2e3ef7"},{"name":"Content-Type","type":"string","default":"application/json","desc":"Set the Request content-type.","required":false,"in":"header","ref":"","_id":"5dd4bf4f11beda002f2e3ef6"}],"results":{"codes":[{"name":"","code":"// Check for Unit Id in headers -> location","language":"json","status":201},{"language":"json","status":400,"name":"","code":"{\n    \"title\": \"Missing field\"\n}"},{"status":401,"language":"json","code":""},{"status":403,"language":"json","code":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Create a New Unit","type":"endpoint","slug":"create-a-new-unit","excerpt":"Create a new Unit with JSON payload","body":"[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.\",\n    \"3-0\": \"404 - Not Found\",\n    \"3-1\": \"Missing **course-id** in path params.\\nInvalid **course-id**\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Any additional data that is part of JSON payload will be ignored silently.\",\n  \"title\": \"Note\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2df79ce642d00f0ff03","project":"56439dfe9eebf70d00490d54","user":"55dd6b48a649eb170083b97a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Unit","slug":"unit","order":5,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fed7","project":"56439dfe9eebf70d00490d54","createdAt":"2015-11-19T02:38:36.951Z","version":"5864d2df79ce642d00f0fec7","__v":0},"__v":8,"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"parentDoc":null,"createdAt":"2015-11-19T02:39:37.106Z","githubsync":""}

postCreate a New Unit

Create a new Unit with JSON payload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

course-id:
string

Body Params

title:
required
string
Title of the Unit
big_ideas:
stringnull
Bid Ideas for Unit
essential_questions:
stringnull
Essential questions for Unit
taxonomy:
array of objectsnull
Taxonomy Domains to tag with Unit
creator_system:
stringnull
Creator name
primary_language:
integer1
Primary Language of Unit. Default is '1' for English.

Headers

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

Examples


Result Format


Documentation

[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.", "3-0": "404 - Not Found", "3-1": "Missing **course-id** in path params.\nInvalid **course-id**" }, "cols": 2, "rows": 4 } [/block] [block:callout] { "type": "info", "body": "Any additional data that is part of JSON payload will be ignored silently.", "title": "Note" } [/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 }}