{"_id":"5864d2e079ce642d00f0ff3c","__v":3,"githubsync":"","parentDoc":null,"project":"56439dfe9eebf70d00490d54","category":{"_id":"5864d2df79ce642d00f0fecb","__v":0,"version":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-18T22:25:07.035Z","from_sync":false,"order":2,"slug":"class","title":"Class/All Users"},"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":"2016-01-19T00:09:01.621Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"id\": \"0641967d-9999-4283-b17a-431f02cc12d0\",\n    \"creator_id\": \"d41c8968-81a4-4813-abea-3a33d98c44a0\",\n    \"title\": \"Test Class\",\n    \"description\": null,\n    \"greeting\": null,\n    \"grade\": null,\n    \"class_sharing\": \"open\",\n    \"cover_image\": null,\n    \"code\": \"ZHAMSAD\",\n    \"min_score\": 0,\n    \"end_date\": \"2018-06-30\",\n    \"course_id\": \"c617c8c9-2bcd-4c43-bece-f17a51c907b5\",\n    \"collaborator\": null,\n    \"gooru_version\": 3,\n    \"content_visibility\": \"visible_collections\",\n    \"is_archived\": false,\n    \"setting\": null,\n    \"roster_id\": null,\n    \"created_at\": \"2019-11-04T07:51:08Z\",\n    \"updated_at\": \"2019-11-04T08:35:36Z\",\n    \"grade_current\": null,\n    \"grade_lower_bound\": null,\n    \"grade_upper_bound\": null,\n    \"route0_applicable\": false,\n    \"force_calculate_ilp\": false,\n    \"preference\": {\n        \"subject\": \"K12.WL\",\n        \"framework\": \"GDF\"\n    },\n    \"primary_language\": 1,\n    \"milestone_view_applicable\": false,\n    \"member_count\": 2\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"","language":"text"}]},"method":"get","auth":"required","params":[{"_id":"569d7cd267331a0d002805d1","ref":"","in":"path","required":false,"desc":"UUID","default":"","type":"string","name":"class-id"}],"url":"/classes/:class-id"},"isReference":false,"order":2,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Token {{authorization access token}}\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"application/json\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The  JSON result contains the Class information for a given Class Code.\",\n  \"title\": \"Note\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Code Description\",\n    \"0-0\": \"401 - Unauthorized\",\n    \"0-1\": \"Missing **Authorization** in header\\nInvalid  **Authorization** in header\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"Retrieve a specific Class given the Class Code.","slug":"retrieve-a-specific-class-by-the-class-code","type":"endpoint","title":"Retrieve a specific Class by the Class Id"}

getRetrieve a specific Class by the Class Id

Retrieve a specific Class given the Class Code.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

class-id:
string
UUID

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Header name", "h-1": "Value", "0-0": "Authorization", "0-1": "Token {{authorization access token}}", "1-0": "Content-Type", "1-1": "application/json" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "info", "body": "The JSON result contains the Class information for a given Class Code.", "title": "Note" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Code Description", "0-0": "401 - Unauthorized", "0-1": "Missing **Authorization** in header\nInvalid **Authorization** in header" }, "cols": 2, "rows": 1 } [/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 }}