{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/courses/:course-id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"course-id","type":"int","default":"","desc":"","required":false,"in":"path","ref":"","_id":"564cf237bc81632100b1046e"},{"name":"Authorization","type":"string","default":"","desc":"Token {authorization accesstoken}","required":true,"in":"header","ref":"","_id":"5dce30965b0983002636f356"},{"name":"Content-Type","type":"string","default":"application/json","desc":"Set the Request content-type.","required":false,"in":"header","ref":"","_id":"5dce30965b0983002636f355"}],"results":{"codes":[{"code":"{\n    \"id\": \"9ed650ab-78e0-42a9-830a-1ec4855f4579\",\n    \"title\": \"Introduction Course - updated\",\n    \"description\": \"This is introduction course 1\",\n    \"owner_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"creator_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"original_creator_id\": null,\n    \"modifier_id\": \"44d400e1-4565-4c7e-9fd4-4be96edaa209\",\n    \"original_course_id\": null,\n    \"publish_status\": \"unpublished\",\n    \"publish_date\": null,\n    \"thumbnail\": \"74266efb-74eb-45de-a6a8-4052710af82c.png\",\n    \"metadata\": {\n        \"audience\": []\n    },\n    \"taxonomy\": {\n        \"CCSS.K12.MA-1\": {\n            \"code\": \"CCSS.K12.MA-1\",\n            \"title\": \"Grade 1\",\n            \"description\": \"\",\n            \"parent_title\": \"Math\",\n            \"framework_code\": \"CCSS\"\n        },\n        \"CCSS.K12.MA-SMP\": {\n            \"code\": \"CCSS.K12.MA-SMP\",\n            \"title\": \"Standards for Mathematical Practice\",\n            \"description\": \"\",\n            \"parent_title\": \"Math\",\n            \"framework_code\": \"CCSS\"\n        }\n    },\n    \"collaborator\": null,\n    \"visible_on_profile\": false,\n    \"created_at\": \"2019-11-14T09:51:09Z\",\n    \"updated_at\": \"2019-11-15T04:48:04Z\",\n    \"sequence_id\": 2,\n    \"subject_bucket\": \"K12 Math\",\n    \"license\": 271,\n    \"creator_system\": null,\n    \"use_case\": \"updated use case\",\n    \"version\": null,\n    \"aggregated_taxonomy\": null,\n    \"primary_language\": 1\n}","name":"","status":200,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Fetch a Course by Id","type":"endpoint","slug":"fetch-a-course-by-id","excerpt":"Fetch an existing Course by a specified id","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Error Description\",\n    \"0-0\": \"401 - Unauthorized\",\n    \"0-1\": \"Missing \\\"**Authorization**\\\" in header.\\nInvalid \\\"**Authorization**\\\"\",\n    \"1-0\": \"403 - Forbidden\",\n    \"1-1\": \"Login required to create.\",\n    \"2-0\": \"404 - Not Found\",\n    \"2-1\": \"Missing **course-id** \\nInvalid **course-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 course as an entity. This will provide metadata for course along with summary information associated with the units contained in the course\",\n  \"title\": \"Note\"\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2e079ce642d00f0ff2e","project":"56439dfe9eebf70d00490d54","user":"55dd6b48a649eb170083b97a","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":"","__v":7,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Course","slug":"course","order":4,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fecf","__v":0,"project":"56439dfe9eebf70d00490d54","createdAt":"2015-11-19T02:15:04.822Z","version":"5864d2df79ce642d00f0fec7"},"createdAt":"2015-11-19T02:29:28.063Z","parentDoc":null}

getFetch a Course by Id

Fetch an existing Course by a specified id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

course-id:
integer

Headers

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

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Error Code", "h-1": "Error Description", "0-0": "401 - Unauthorized", "0-1": "Missing \"**Authorization**\" in header.\nInvalid \"**Authorization**\"", "1-0": "403 - Forbidden", "1-1": "Login required to create.", "2-0": "404 - Not Found", "2-1": "Missing **course-id** \nInvalid **course-id**" }, "cols": 2, "rows": 3 } [/block] [block:callout] { "type": "info", "body": "The API will provide data specific to course as an entity. This will provide metadata for course along with summary information associated with the units contained in the course", "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 }}