{"_id":"569d67ffec29360d00f667bb","editedParams":true,"version":{"_id":"56439dff9eebf70d00490d57","project":"56439dfe9eebf70d00490d54","__v":26,"createdAt":"2015-11-11T19:58:55.144Z","releaseDate":"2015-11-11T19:58:55.144Z","categories":["56439dff9eebf70d00490d58","56439e17c92c470d002dec71","564ce88e802cd02100444274","564d07ff3657c43500bf1d33","564d0a312da1982d00b19b64","564d2aa92da1982d00b19b8c","564d30a8b88a37210082253e","564d362c2da1982d00b19ba0","569d664371e3650d00acf018","569d7eacec29360d00f667c9","569d8006ec29360d00f667cb","569d855e0306a10d00ce99b9","569d91d571e3650d00acf04c","569d91eeceb7510d00f2a6a3","569e8c262d320817003b806d","569e8f802d320817003b8072","56b038c914dfea0d0007cf05","5717b4f0681bb41900fc575a","5718e0a4cd483219007c2c9a","571924c8e967cb1700d078e9","571e2648edc4a92b00a4cc65","576a677a6f15260e001f899b","576c5eaf5738570e00ff070f","578d127ed9c55c2000d4f213","579f90927ebe9b0e00059c50","582c0af888708a0f00570a69"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1"},"__v":0,"editedParams2":true,"githubsync":"","project":"56439dfe9eebf70d00490d54","category":{"_id":"569d664371e3650d00acf018","version":"56439dff9eebf70d00490d57","__v":18,"pages":["569d679c5a2b060d00874209","569d67ffec29360d00f667bb","569d684867331a0d002805c5","569d68b871e3650d00acf01d","569d69110306a10d00ce9998","569d6956ceb7510d00f2a686","569d69b70306a10d00ce9999","569d69fb0306a10d00ce999a","569d6a5267331a0d002805c7","569d7cd267331a0d002805d0","569d7d6b71e3650d00acf02e","569d7dd667331a0d002805d2","569d7e9d67331a0d002805d4","569d7f4b0306a10d00ce99b1","569d806071e3650d00acf030","56f1b4ab0157b9200072df38","56f1b6eb61376720009412c7","56f1b7f23eb62a34003ea03e"],"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"},"parentDoc":null,"user":"55dd6b48a649eb170083b97a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-18T22:32:31.066Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n  \t\"roster_id\": \"roster-1\",\n  \t\"creator_system\": \"creator-system\"\n}"}]},"method":"put","results":{"codes":[{"status":204,"name":"","code":"","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"569d640567331a0d002805b3","ref":"","in":"path","required":false,"desc":"","default":"","type":"string","name":"class-code"}],"url":"/classes/:class-code/members"},"isReference":false,"order":0,"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]","excerpt":"Join a Class by its Code or Invite link","slug":"join-a-class","type":"endpoint","title":"Join a Class"}

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