{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/classes","auth":"required","method":"post","params":[{"name":"title","type":"string","default":"","desc":"Title of the Class","required":true,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa0d"},{"name":"description","type":"string","default":"","desc":"Description\tof\tthe\tClass","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa0c"},{"name":"greetings","type":"string","default":"","desc":"Greetings\tfor\tClass","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa0b"},{"name":"grade","type":"array_object","default":"","desc":"Grade\tfor\tclass","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa0a"},{"name":"class_sharing","type":"string","default":"","desc":"Sharing\ttype\tof\tthe\tclass.\tEither\t “open”\tor\t“restricted”","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa09"},{"name":"cover_image","type":"string","default":"","desc":"Path\tto\tthe\tcover\timage\tof\tthe\tclass","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa08"},{"name":"min_score","type":"int","default":"","desc":"Minimum\tscore\tfor\tclass.","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa07"},{"name":"end_date","type":"yyyy-mm-dd","default":"","desc":"End\tdate\tof\tclass.\tFormat\t “YYYY-DD-MM”","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa06"},{"name":"content_visibility","type":"string","default":"visible_none","desc":"This field can contain 'visible_none', 'visible_collections', 'visible_all'. By default it is treaded as ‘visible_none’","required":false,"in":"body","ref":"","_id":"5d53fc950f0eac0059a4fa05"}],"results":{"codes":[{"language":"http","code":"// Returns newly created class id in header-->location key","name":"","status":201},{"status":400,"language":"json","code":"{\n    \"title\": \"Missing field\"\n}","name":""}]},"settings":"","examples":{"codes":[{"name":null,"code":"{ \n   \"title\":\"My Class\",\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   \"min_score\":75,\n   \"end_date\":\"2016-12-31\",\t//End date should always be future date\n   \"content_visibility\":\"visible_none\"\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Create a Class","type":"endpoint","slug":"create-a-class","excerpt":"Create a Class using a JSON payload","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 Class entity will be created based on the JSON payload. This could contain title, grade and visibility information.\",\n  \"title\": \"Note\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Error Code\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Error Description\",\n    \"0-0\": \"401 - Unauthorized\",\n    \"1-0\": \"400 - Bad Request\",\n    \"1-1\": \"Missing Required field.\\nInvalid value\",\n    \"0-1\": \"Missing **Authorization** in header\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2df79ce642d00f0fef1","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},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Class/Teacher","slug":"taxonomy","order":3,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fecc","project":"56439dfe9eebf70d00490d54","__v":0,"version":"5864d2df79ce642d00f0fec7","createdAt":"2016-01-19T00:15:02.117Z"},"parentDoc":null,"project":"56439dfe9eebf70d00490d54","__v":16,"user":"55dd6b48a649eb170083b97a","githubsync":"","createdAt":"2016-01-18T22:26:07.510Z"}

postCreate a Class

Create a Class using a JSON payload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

title:
required
string
Title of the Class
description:
string
Description of the Class
greetings:
string
Greetings for Class
grade:
array of objects
Grade for class
class_sharing:
string
Sharing type of the class. Either “open” or “restricted”
cover_image:
string
Path to the cover image of the class
min_score:
integer
Minimum score for class.
end_date:
yyyy-mm-dd
End date of class. Format “YYYY-DD-MM”
content_visibility:
stringvisible_none
This field can contain 'visible_none', 'visible_collections', 'visible_all'. By default it is treaded as ‘visible_none’

Examples


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 Class entity will be created based on the JSON payload. This could contain title, grade and visibility information.", "title": "Note" } [/block] [block:api-header] { "title": "Error Code" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Error Description", "0-0": "401 - Unauthorized", "1-0": "400 - Bad Request", "1-1": "Missing Required field.\nInvalid value", "0-1": "Missing **Authorization** in header" }, "cols": 2, "rows": 2 } [/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 }}