{"_id":"5864d2e079ce642d00f0ff3c","__v":0,"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":3,"slug":"class","title":"Class/All Users"},"user":"55dd6b48a649eb170083b97a","version":{"_id":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54","__v":4,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"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\": \"d8b6eb04-5466-4e29-92f5-06584b6b6ef5\",\n  \"creator_id\": \"2afaf0fd-ed92-48c5-9195-7f4bc1e0064e\",\n  \"title\": \"My class - 1\",\n  \"description\": \"This class is intended to make awareness of good habits\",\n  \"greeting\": \"Hi! Welcome to my class\",\n  \"grade\": [\n    4,\n    5\n  ],\n  \"class_sharing\": \"open\",\n  \"cover_image\": \"e264cdc8-19d1-4285-88f5-5b359daf33da.png\",\n  \"code\": \"VZFMEWH\",\n  \"min_score\": 75,\n  \"end_date\": \"2016-12-31\",\n  \"course_id\": null,\n  \"collaborator\": [\n    \"63dd64b2-bb30-47a9-8daf-8330f57e16c3\",\n    \"E4510f0a-a4a1-46d8-b7c3-fce31754c7d8\"\n  ],\n  \"gooru_version\": 3,\n  \"content_visibility\": null,\n  \"is_archived\": false,\n  \"created_at\": \"2016-03-30T23:08:17Z\",\n  \"updated_at\": \"2016-03-30T23:08:17Z\",\n  \"member_count\": 1\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]","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]

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 }}