{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/courses/:course-id/units/:unit-id","auth":"required","params":[{"name":"course-id","type":"string","default":"","desc":"","required":false,"in":"path","ref":"","_id":"564cf237bc81632100b1046e"},{"name":"unit-id","type":"string","default":"","desc":"","required":false,"in":"path","ref":"","_id":"564d378aa50db7370001ed44"},{"name":"Authorization","type":"string","default":"","desc":"Token {authorization access token}","required":true,"in":"header","ref":"","_id":"5dd4c396b456540049b70dda"},{"name":"Content-Type","type":"string","default":"application/json","desc":"Set the Request content-type.","required":false,"in":"header","ref":"","_id":"5dd4c396b456540049b70dd9"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"unit_id\": \"16d39e04-280d-43fb-9934-bc4a92e0eb6a\",\n    \"course_id\": \"569fdd89-b728-4f52-b73c-8c9872a9bd72\",\n    \"title\": \"My Unit 1 - Updated\",\n    \"created_at\": \"2019-11-20T04:20:31Z\",\n    \"updated_at\": \"2019-11-20T04:35:24Z\",\n    \"owner_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"creator_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"modifier_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"original_creator_id\": null,\n    \"original_unit_id\": null,\n    \"big_ideas\": \"this is my second call to create unit\",\n    \"essential_questions\": \"what is the purpose of unit?\",\n    \"metadata\": null,\n    \"taxonomy\": {\n        \"CCSS.K12.MA-3-G\": {\n            \"code\": \"CCSS.K12.MA-3-G\",\n            \"title\": \"Geometry\",\n            \"description\": null,\n            \"parent_title\": \"Grade3\",\n            \"framework_code\": \"CCSS\"\n        },\n        \"CCSS.K12.MA-K-CC\": {\n            \"code\": \"CCSS.K12.MA-K-CC\",\n            \"title\": \"Counting & Cardinality\",\n            \"description\": null,\n            \"parent_title\": \"Kindergarten\",\n            \"framework_code\": \"CCSS\"\n        }\n    },\n    \"sequence_id\": 2,\n    \"creator_system\": null,\n    \"aggregated_taxonomy\": null,\n    \"primary_language\": 1\n}","name":""},{"status":404,"language":"html","code":"<html>\n    <body>\n        <h1>Resource not found</h1>\n    </body>\n</html>"}]},"settings":"","examples":{"codes":[{"name":"","code":"","language":"text"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Fetch a Unit by Id","type":"endpoint","slug":"fetch-a-unit-by-id","excerpt":"Fetch an existing Unit by its id","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"401 - Unauthorized\",\n    \"0-1\": \"Missing \\\"**Authorization**\\\" in header.\\nInvalid \\\"**Authorization**\\\"\",\n    \"1-0\": \"403 - Forbidden\",\n    \"1-1\": \"Login required.\",\n    \"2-0\": \"404 - Not Found\",\n    \"2-1\": \"Missing **course-id/unit-id** in path params.\\nInvalid **course-id/unit-id**\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The API will provide data specific to Unit as an entity. In addition this API will provide summary information associated with Lessons as well.\",\n  \"title\": \"Note\"\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2df79ce642d00f0ff05","project":"56439dfe9eebf70d00490d54","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},"githubsync":"","parentDoc":null,"createdAt":"2015-11-19T02:44:26.706Z","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},"user":"55dd6b48a649eb170083b97a","__v":6}

getFetch a Unit by Id

Fetch an existing Unit by its id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

course-id:
string
unit-id:
string

Headers

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

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Header name", "h-1": "Value", "0-0": "401 - Unauthorized", "0-1": "Missing \"**Authorization**\" in header.\nInvalid \"**Authorization**\"", "1-0": "403 - Forbidden", "1-1": "Login required.", "2-0": "404 - Not Found", "2-1": "Missing **course-id/unit-id** in path params.\nInvalid **course-id/unit-id**" }, "cols": 2, "rows": 3 } [/block] [block:callout] { "type": "info", "body": "The API will provide data specific to Unit as an entity. In addition this API will provide summary information associated with Lessons as well.", "title": "Note" } [/block]

User Information

Try It Out

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