{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/classes/:class-id","auth":"required","examples":{"codes":[{"code":"\t\n{\t\n\t\t\"title\":\t\"My\tclass\t2\t-\tupdated\",\t\n\t\t\"description\":\t\"This\tclass\tis\tintended\tto\tmake\tawareness\tof\tgood\thabits\",\t\n\t\t\"greeting\":\t\"Hi!\tWelcome\tto\tmy\tclass\",\t\n\t\t\"grade\":\t[4,\t5],\t\n\t\t\"class_sharing\":\t\"open\",\t\n\t\t\"cover_image\":\t\"e264cdc8-19d1-4285-88f5-5b359daf33da.png\",\t\n\t\t\"min_score\":\t75,\t\n\t\t\"end_date\":\t\"2020-12-31\",\t\n\t\t\"collaborator\":\t[\t\n\t\t\t\t\t\t\t\t\t\"63dd64b2-bb30-47a9-8daf-8330f57e16c3\",\t\n\t\t\t\t\t\t\t\t\t\"E4510f0a-a4a1-46d8-b7c3-fce31754c7d8\"\t\n\t\t]\n}\t","language":"json"}]},"method":"put","params":[{"name":"class-id","type":"string","default":"","desc":"UUID","required":true,"in":"path","ref":"","_id":"569d640567331a0d002805b3"},{"name":"title","type":"string","default":"","desc":"Title of the Class","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5d0"},{"name":"description","type":"string","default":"","desc":"Description\tof\tthe\tClass","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5cf"},{"name":"greetings","type":"string","default":"","desc":"Greetings for\tClass","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5ce"},{"name":"grade","type":"array_object","default":"","desc":"Grade for\tclass","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5cd"},{"name":"class_sharing","type":"string","default":"","desc":"Sharing type of the class. Either “open” or “restricted”","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5cc"},{"name":"min_score","type":"int","default":"","desc":"Minimum\tscore\tfor\tclass.","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5cb"},{"name":"end_date","type":"datetime","default":"","desc":"End date of class. Format “YYYY-DD-MM”","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5ca"},{"name":"collaborator","type":"array_object","default":"","desc":"Collaborators\ton\tclass","required":false,"in":"body","ref":"","_id":"5d53eae7943571006ea1f5c9"}],"results":{"codes":[{"language":"json","code":"","name":"","status":204},{"code":"{\n    \"message\": \"Not allowed\"\n}","language":"json","status":403},{"status":404,"language":"html","code":"<html>\n    <body>\n        <h1>Resource not found</h1>\n    </body>\n</html>"},{"code":"{\n    \"end_date\": \"Invalid value\"\n}","language":"json","status":400}]},"settings":""},"next":{"description":"","pages":[]},"title":"Update a Class","type":"endpoint","slug":"update-a-class","excerpt":"Update 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 updated based on the JSON payload.  This payload can contain the title, grade, visibility.\",\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\": \"400 - Bad Request\",\n    \"1-0\": \"401 - Unauthorized\",\n    \"1-1\": \"Missing **Authorization** in header\",\n    \"0-1\": \"Missing Required field.\\nInvalid value\",\n    \"2-0\": \"403 - Forbidden\",\n    \"2-1\": \"Authenticated user can edit their class details.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2df79ce642d00f0fef2","user":"55dd6b48a649eb170083b97a","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"},"project":"56439dfe9eebf70d00490d54","createdAt":"2016-01-18T22:27:34.169Z","githubsync":"","parentDoc":null,"__v":23,"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}}

putUpdate a Class

Update a Class using a JSON payload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

class-id:
required
string
UUID

Body Params

title:
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”
min_score:
integer
Minimum score for class.
end_date:
datetime
End date of class. Format “YYYY-DD-MM”
collaborator:
array of objects
Collaborators on class

Examples


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 updated based on the JSON payload. This payload can contain the title, grade, visibility.", "title": "Note" } [/block] [block:api-header] { "title": "Error Code" } [/block] [block:parameters] { "data": { "h-0": "Error Code", "h-1": "Error Description", "0-0": "400 - Bad Request", "1-0": "401 - Unauthorized", "1-1": "Missing **Authorization** in header", "0-1": "Missing Required field.\nInvalid value", "2-0": "403 - Forbidden", "2-1": "Authenticated user can edit their class details." }, "cols": 2, "rows": 3 } [/block]

User Information

Try It Out

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