{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/classes/:class-code/members","auth":"required","method":"put","params":[{"name":"class-code","type":"string","default":"","desc":"","required":false,"in":"path","ref":"","_id":"569d640567331a0d002805b3"}],"results":{"codes":[{"language":"json","status":204,"name":"","code":""}]},"settings":"","examples":{"codes":[{"code":"{\n  \t\"roster_id\": \"roster-1\",\n  \t\"creator_system\": \"creator-system\"\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Join a Class","type":"endpoint","slug":"join-a-class","excerpt":"Join a Class by its Code or Invite link","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 payload contains the member information that will be updated individually as an association with the Class.\",\n  \"title\": \"Note\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2e079ce642d00f0ff3a","parentDoc":null,"user":"55dd6b48a649eb170083b97a","__v":0,"project":"56439dfe9eebf70d00490d54","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Class/All Users","slug":"class","order":2,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fecb","createdAt":"2016-01-18T22:25:07.035Z","__v":0,"version":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54"},"createdAt":"2016-01-18T22:32:31.066Z","githubsync":"","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}}

putJoin a Class

Join a Class by its Code or Invite link

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

class-code:
string

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 JSON payload contains the member information that will be updated individually as an association with the Class.", "title": "Note" } [/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 }}