discovery/googleapis/classroom__v1.json - Issue 2779563003: Api-roll 47: 2017-03-27

Side by Side Diff: discovery/googleapis/classroom__v1.json

Issue 2779563003: Api-roll 47: 2017-03-27 (Closed)

Patch Set: Created 3 years, 8 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

OLD	NEW
1 {	1 {

2 "auth": {	2 "auth": {

3 "oauth2": {	3 "oauth2": {

4 "scopes": {	4 "scopes": {

5 "https://www.googleapis.com/auth/classroom.course-work.readonly" : {

6 "description": "View instructions for teacher-assigned work in your Google Classroom classes"

7 },

8 "https://www.googleapis.com/auth/classroom.courses": {

9 "description": "Manage your Google Classroom classes"

10 },

11 "https://www.googleapis.com/auth/classroom.courses.readonly": {

12 "description": "View your Google Classroom classes"

13 },

14 "https://www.googleapis.com/auth/classroom.coursework.me": {

15 "description": "Manage your course work and view your grades in Google Classroom"

16 },

17 "https://www.googleapis.com/auth/classroom.coursework.me.readonl y": {

18 "description": "View your course work and grades in Google C lassroom"

19 },

20 "https://www.googleapis.com/auth/classroom.coursework.students": {

21 "description": "Manage course work and grades for students i n the Google Classroom classes you teach and view the course work and grades for classes you administer"

22 },

23 "https://www.googleapis.com/auth/classroom.coursework.students.r eadonly": {

24 "description": "View course work and grades for students in the Google Classroom classes you teach or administer"

25 },

26 "https://www.googleapis.com/auth/classroom.profile.emails": {

27 "description": "View the email addresses of people in your c lasses"

28 },

29 "https://www.googleapis.com/auth/classroom.profile.photos": {

30 "description": "View the profile photos of people in your cl asses"

31 },

32 "https://www.googleapis.com/auth/classroom.rosters": {

33 "description": "Manage your Google Classroom class rosters"

34 },

35 "https://www.googleapis.com/auth/classroom.rosters.readonly": {	5 "https://www.googleapis.com/auth/classroom.rosters.readonly": {

36 "description": "View your Google Classroom class rosters"	6 "description": "View your Google Classroom class rosters"

37 },	7 },

38 "https://www.googleapis.com/auth/classroom.student-submissions.m e.readonly": {	8 "https://www.googleapis.com/auth/classroom.student-submissions.m e.readonly": {

39 "description": "View your course work and grades in Google C lassroom"	9 "description": "View your course work and grades in Google C lassroom"

40 },	10 },

	11 "https://www.googleapis.com/auth/classroom.coursework.students.r eadonly": {

	12 "description": "View course work and grades for students in the Google Classroom classes you teach or administer"

	13 },

41 "https://www.googleapis.com/auth/classroom.student-submissions.s tudents.readonly": {	14 "https://www.googleapis.com/auth/classroom.student-submissions.s tudents.readonly": {

42 "description": "View course work and grades for students in the Google Classroom classes you teach or administer"	15 "description": "View course work and grades for students in the Google Classroom classes you teach or administer"

	16 },

	17 "https://www.googleapis.com/auth/classroom.rosters": {

	18 "description": "Manage your Google Classroom class rosters"

	19 },

	20 "https://www.googleapis.com/auth/classroom.coursework.me.readonl y": {

	21 "description": "View your course work and grades in Google C lassroom"

	22 },

	23 "https://www.googleapis.com/auth/classroom.courses.readonly": {

	24 "description": "View your Google Classroom classes"

	25 },

	26 "https://www.googleapis.com/auth/classroom.courses": {

	27 "description": "Manage your Google Classroom classes"

	28 },

	29 "https://www.googleapis.com/auth/classroom.coursework.me": {

	30 "description": "Manage your course work and view your grades in Google Classroom"

	31 },

	32 "https://www.googleapis.com/auth/classroom.coursework.students": {

	33 "description": "Manage course work and grades for students i n the Google Classroom classes you teach and view the course work and grades for classes you administer"

	34 },

	35 "https://www.googleapis.com/auth/classroom.profile.photos": {

	36 "description": "View the profile photos of people in your cl asses"

	37 },

	38 "https://www.googleapis.com/auth/classroom.profile.emails": {

	39 "description": "View the email addresses of people in your c lasses"

43 }	40 }

44 }	41 }

45 }	42 }

46 },	43 },

47 "basePath": "",	44 "basePath": "",

48 "baseUrl": "https://classroom.googleapis.com/",	45 "baseUrl": "https://classroom.googleapis.com/",

49 "batchPath": "batch",	46 "batchPath": "batch",

50 "description": "Manages classes, rosters, and invitations in Google Classroo m.",	47 "description": "Manages classes, rosters, and invitations in Google Classroo m.",

51 "discoveryVersion": "v1",	48 "discoveryVersion": "v1",

52 "documentationLink": "https://developers.google.com/classroom/",	49 "documentationLink": "https://developers.google.com/classroom/",

53 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/VPjAdAuQhi94i4H_5Zyjop6mRoc\"",

54 "icons": {	50 "icons": {

55 "x16": "http://www.google.com/images/icons/product/search-16.gif",	51 "x16": "http://www.google.com/images/icons/product/search-16.gif",

56 "x32": "http://www.google.com/images/icons/product/search-32.gif"	52 "x32": "http://www.google.com/images/icons/product/search-32.gif"

57 },	53 },

58 "id": "classroom:v1",	54 "id": "classroom:v1",

59 "kind": "discovery#restDescription",	55 "kind": "discovery#restDescription",

60 "name": "classroom",	56 "name": "classroom",

61 "ownerDomain": "google.com",	57 "ownerDomain": "google.com",

62 "ownerName": "Google",	58 "ownerName": "Google",

63 "parameters": {	59 "parameters": {

64 "access_token": {	60 "access_token": {

65 "description": "OAuth access token.",	61 "description": "OAuth access token.",

66 "location": "query",	62 "location": "query",

67 "type": "string"	63 "type": "string"

68 },	64 },

	65 "prettyPrint": {

	66 "default": "true",

	67 "description": "Returns response with indentations and line breaks." ,

	68 "location": "query",

	69 "type": "boolean"

	70 },

	71 "key": {

	72 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",

	73 "location": "query",

	74 "type": "string"

	75 },

	76 "quotaUser": {

	77 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",

	78 "location": "query",

	79 "type": "string"

	80 },

	81 "pp": {

	82 "default": "true",

	83 "description": "Pretty-print response.",

	84 "location": "query",

	85 "type": "boolean"

	86 },

	87 "fields": {

	88 "description": "Selector specifying which fields to include in a par tial response.",

	89 "location": "query",

	90 "type": "string"

	91 },

69 "alt": {	92 "alt": {

70 "default": "json",	93 "default": "json",

71 "description": "Data format for response.",	94 "description": "Data format for response.",

	95 "enum": [

	96 "json",

	97 "media",

	98 "proto"

	99 ],

72 "enumDescriptions": [	100 "enumDescriptions": [

73 "Responses with Content-Type of application/json",	101 "Responses with Content-Type of application/json",

74 "Media download with context-dependent Content-Type",	102 "Media download with context-dependent Content-Type",

75 "Responses with Content-Type of application/x-protobuf"	103 "Responses with Content-Type of application/x-protobuf"

76 ],	104 ],

77 "location": "query",	105 "location": "query",

78 "type": "string"	106 "type": "string"

79 },	107 },

80 "bearer_token": {	108 "$.xgafv": {

81 "description": "OAuth bearer token.",	109 "description": "V1 error format.",

	110 "enum": [

	111 "1",

	112 "2"

	113 ],

	114 "enumDescriptions": [

	115 "v1 error format",

	116 "v2 error format"

	117 ],

82 "location": "query",	118 "location": "query",

83 "type": "string"	119 "type": "string"

84 },	120 },

85 "callback": {	121 "callback": {

86 "description": "JSONP",	122 "description": "JSONP",

87 "location": "query",	123 "location": "query",

88 "type": "string"	124 "type": "string"

89 },	125 },

90 "fields": {

91 "description": "Selector specifying which fields to include in a par tial response.",

92 "location": "query",

93 "type": "string"

94 },

95 "key": {

96 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",

97 "location": "query",

98 "type": "string"

99 },

100 "oauth_token": {	126 "oauth_token": {

101 "description": "OAuth 2.0 token for the current user.",	127 "description": "OAuth 2.0 token for the current user.",

102 "location": "query",	128 "location": "query",

103 "type": "string"	129 "type": "string"

104 },	130 },

105 "pp": {	131 "uploadType": {

106 "default": "true",	132 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",

107 "description": "Pretty-print response.",

108 "location": "query",

109 "type": "boolean"

110 },

111 "prettyPrint": {

112 "default": "true",

113 "description": "Returns response with indentations and line breaks." ,

114 "location": "query",

115 "type": "boolean"

116 },

117 "quotaUser": {

118 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",

119 "location": "query",	133 "location": "query",

120 "type": "string"	134 "type": "string"

121 },	135 },

	136 "bearer_token": {

	137 "description": "OAuth bearer token.",

	138 "location": "query",

	139 "type": "string"

	140 },

122 "upload_protocol": {	141 "upload_protocol": {

123 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",	142 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",

124 "location": "query",	143 "location": "query",

125 "type": "string"	144 "type": "string"

126 },

127 "uploadType": {

128 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",

129 "location": "query",

130 "type": "string"

131 },

132 "$.xgafv": {

133 "description": "V1 error format.",

134 "enumDescriptions": [

135 "v1 error format",

136 "v2 error format"

137 ],

138 "location": "query",

139 "type": "string"

140 }	145 }

141 },	146 },

142 "protocol": "rest",	147 "protocol": "rest",

143 "resources": {	148 "resources": {

144 "courses": {	149 "invitations": {

145 "methods": {	150 "methods": {

146 "create": {	151 "create": {

147 "description": "Creates a course. The user specified in `own erId` is the owner of the created course and added as a teacher. This method ret urns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the prima ry teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's ac count is disabled or for the following request errors: * UserGroupsMembershipLim itReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already e xists.",	152 "description": "Creates an invitation. Only one invitation f or a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSIO N_DENIED` if the requesting user is not permitted to create\ninvitations for thi s course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREA DY_EXISTS` if an invitation for the specified user and course\nalready exists.",

148 "httpMethod": "POST",	153 "httpMethod": "POST",

149 "id": "classroom.courses.create",	154 "id": "classroom.invitations.create",

150 "path": "v1/courses",	155 "parameterOrder": [],

	156 "parameters": {},

	157 "path": "v1/invitations",

151 "request": {	158 "request": {

152 "$ref": "Course"	159 "$ref": "Invitation"

153 },	160 },

154 "response": {	161 "response": {

155 "$ref": "Course"	162 "$ref": "Invitation"

156 },	163 },

157 "scopes": [	164 "scopes": [

158 "https://www.googleapis.com/auth/classroom.courses"	165 "https://www.googleapis.com/auth/classroom.rosters"

159 ]	166 ]

160 },	167 },

161 "get": {	168 "get": {

162 "description": "Returns a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to access the requested course or for access errors. * `NOT_FOUND` if no cour se exists with the requested ID.",	169 "description": "Returns an invitation.\n\nThis method return s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FO UND` if no invitation exists with the requested ID.",

163 "httpMethod": "GET",	170 "httpMethod": "GET",

164 "id": "classroom.courses.get",	171 "id": "classroom.invitations.get",

165 "parameterOrder": [	172 "parameterOrder": [

166 "id"	173 "id"

167 ],	174 ],

168 "parameters": {	175 "parameters": {

169 "id": {	176 "id": {

170 "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.",	177 "description": "Identifier of the invitation to retu rn.",

171 "location": "path",	178 "location": "path",

172 "required": true,	179 "required": true,

173 "type": "string"	180 "type": "string"

174 }	181 }

175 },	182 },

176 "path": "v1/courses/{id}",	183 "path": "v1/invitations/{id}",

177 "response": {	184 "response": {

178 "$ref": "Course"	185 "$ref": "Invitation"

179 },	186 },

180 "scopes": [	187 "scopes": [

181 "https://www.googleapis.com/auth/classroom.courses",	188 "https://www.googleapis.com/auth/classroom.rosters",

182 "https://www.googleapis.com/auth/classroom.courses.reado nly"	189 "https://www.googleapis.com/auth/classroom.rosters.reado nly"

183 ]	190 ]

184 },	191 },

185 "update": {	192 "list": {

186 "description": "Updates a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to modify the requested course or for access errors. * `NOT_FOUND` if no cour se exists with the requested ID. * `FAILED_PRECONDITION` for the following reque st errors: * CourseNotModifiable",	193 "description": "Returns a list of invitations that the reque sting user is permitted to\nview, restricted to those that match the list reques t.\n\nNote: At least one of `user_id` or `course_id` must be supplied. Both\nf ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P ERMISSION_DENIED` for access errors.",

187 "httpMethod": "PUT",	194 "httpMethod": "GET",

188 "id": "classroom.courses.update",	195 "id": "classroom.invitations.list",

	196 "parameterOrder": [],

	197 "parameters": {

	198 "courseId": {

	199 "description": "Restricts returned invitations to th ose for a course with the specified\nidentifier.",

	200 "location": "query",

	201 "type": "string"

	202 },

	203 "pageSize": {

	204 "description": "Maximum number of items to return. Z ero means no maximum.\n\nThe server may return fewer than the specified number o f results.",

	205 "format": "int32",

	206 "location": "query",

	207 "type": "integer"

	208 },

	209 "userId": {

	210 "description": "Restricts returned invitations to th ose for a specific user. The identifier\ncan be one of the following:\n\n* the n umeric identifier for the user\n* the email address of the user\n* the string li teral `\"me\"`, indicating the requesting user",

	211 "location": "query",

	212 "type": "string"

	213 },

	214 "pageToken": {

	215 "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resul ted in this token.",

	216 "location": "query",

	217 "type": "string"

	218 }

	219 },

	220 "path": "v1/invitations",

	221 "response": {

	222 "$ref": "ListInvitationsResponse"

	223 },

	224 "scopes": [

	225 "https://www.googleapis.com/auth/classroom.rosters",

	226 "https://www.googleapis.com/auth/classroom.rosters.reado nly"

	227 ]

	228 },

	229 "delete": {

	230 "description": "Deletes an invitation.\n\nThis method return s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_ FOUND` if no invitation exists with the requested ID.",

	231 "httpMethod": "DELETE",

	232 "id": "classroom.invitations.delete",

189 "parameterOrder": [	233 "parameterOrder": [

190 "id"	234 "id"

191 ],	235 ],

192 "parameters": {	236 "parameters": {

193 "id": {	237 "id": {

194 "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",	238 "description": "Identifier of the invitation to dele te.",

195 "location": "path",	239 "location": "path",

196 "required": true,	240 "required": true,

197 "type": "string"	241 "type": "string"

198 }	242 }

199 },	243 },

200 "path": "v1/courses/{id}",	244 "path": "v1/invitations/{id}",

201 "request": {

202 "$ref": "Course"

203 },

204 "response": {	245 "response": {

205 "$ref": "Course"	246 "$ref": "Empty"

206 },	247 },

207 "scopes": [	248 "scopes": [

208 "https://www.googleapis.com/auth/classroom.courses"	249 "https://www.googleapis.com/auth/classroom.rosters"

209 ]	250 ]

210 },	251 },

211 "patch": {	252 "accept": {

212 "description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesti ng user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if i nvalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable ",	253 "description": "Accepts an invitation, removing it and addin g the invited user to the\nteachers or students (as appropriate) of the specifie d course. Only the\ninvited user may accept an invitation.\n\nThis method return s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAIL ED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReach ed\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroups MembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",

213 "httpMethod": "PATCH",	254 "httpMethod": "POST",

214 "id": "classroom.courses.patch",	255 "id": "classroom.invitations.accept",

215 "parameterOrder": [	256 "parameterOrder": [

216 "id"	257 "id"

217 ],	258 ],

218 "parameters": {	259 "parameters": {

219 "id": {	260 "id": {

220 "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",	261 "description": "Identifier of the invitation to acce pt.",

221 "location": "path",

222 "required": true,

223 "type": "string"

224 },

225 "updateMask": {

226 "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will f ail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When s et in a query parameter, this field should be specified as `updateMask=,,...`",

227 "location": "query",

228 "type": "string"

229 }

230 },

231 "path": "v1/courses/{id}",

232 "request": {

233 "$ref": "Course"

234 },

235 "response": {

236 "$ref": "Course"

237 },

238 "scopes": [

239 "https://www.googleapis.com/auth/classroom.courses"

240 ]

241 },

242 "delete": {

243 "description": "Deletes a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to delete the requested course or for access errors. * `NOT_FOUND` if no cour se exists with the requested ID.",

244 "httpMethod": "DELETE",

245 "id": "classroom.courses.delete",

246 "parameterOrder": [

247 "id"

248 ],

249 "parameters": {

250 "id": {

251 "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.",

252 "location": "path",	262 "location": "path",

253 "required": true,	263 "required": true,

254 "type": "string"	264 "type": "string"

255 }	265 }

256 },	266 },

257 "path": "v1/courses/{id}",	267 "path": "v1/invitations/{id}:accept",

258 "response": {	268 "response": {

259 "$ref": "Empty"	269 "$ref": "Empty"

260 },	270 },

261 "scopes": [	271 "scopes": [

262 "https://www.googleapis.com/auth/classroom.courses"	272 "https://www.googleapis.com/auth/classroom.rosters"

263 ]	273 ]

264 },	274 }

	275 }

	276 },

	277 "courses": {

	278 "methods": {

265 "list": {	279 "list": {

266 "description": "Returns a list of courses that the requestin g user is permitted to view, restricted to those that match the request. This me thod returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any u sers specified in the query arguments do not exist.",	280 "description": "Returns a list of courses that the requestin g user is permitted to view,\nrestricted to those that match the request.\n\nThi s method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",

267 "httpMethod": "GET",	281 "httpMethod": "GET",

268 "id": "classroom.courses.list",	282 "id": "classroom.courses.list",

	283 "parameterOrder": [],

269 "parameters": {	284 "parameters": {

270 "studentId": {

271 "description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the use r * the string literal `\"me\"`, indicating the requesting user",

272 "location": "query",

273 "type": "string"

274 },

275 "teacherId": {

276 "description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the use r * the string literal `\"me\"`, indicating the requesting user",

277 "location": "query",

278 "type": "string"

279 },

280 "courseStates": {	285 "courseStates": {

281 "description": "Restricts returned courses to those in one of the specified states",	286 "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION ED, DECLINED.",

282 "enum": [	287 "enum": [

283 "COURSE_STATE_UNSPECIFIED",	288 "COURSE_STATE_UNSPECIFIED",

284 "ACTIVE",	289 "ACTIVE",

285 "ARCHIVED",	290 "ARCHIVED",

286 "PROVISIONED",	291 "PROVISIONED",

287 "DECLINED"	292 "DECLINED",

	293 "SUSPENDED"

288 ],	294 ],

289 "location": "query",	295 "location": "query",

290 "repeated": true,	296 "repeated": true,

291 "type": "string"	297 "type": "string"

292 },	298 },

293 "pageSize": {	299 "pageSize": {

294 "description": "Maximum number of items to return. Z ero or unspecified indicates that the server may assign a maximum. The server ma y return fewer than the specified number of results.",	300 "description": "Maximum number of items to return. Z ero or unspecified indicates that the\nserver may assign a maximum.\n\nThe serve r may return fewer than the specified number of results.",

295 "format": "int32",	301 "format": "int32",

296 "location": "query",	302 "location": "query",

297 "type": "integer"	303 "type": "integer"

298 },	304 },

	305 "teacherId": {

	306 "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of th e following:\n\n* the numeric identifier for the user\n* the email address of th e user\n* the string literal `\"me\"`, indicating the requesting user",

	307 "location": "query",

	308 "type": "string"

	309 },

	310 "studentId": {

	311 "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of th e following:\n\n* the numeric identifier for the user\n* the email address of th e user\n* the string literal `\"me\"`, indicating the requesting user",

	312 "location": "query",

	313 "type": "string"

	314 },

299 "pageToken": {	315 "pageToken": {

300 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be ret urned. The list request must be otherwise identical to the one that resulted in this token.",	316 "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resul ted in this token.",

301 "location": "query",	317 "location": "query",

302 "type": "string"	318 "type": "string"

303 }	319 }

304 },	320 },

305 "path": "v1/courses",	321 "path": "v1/courses",

306 "response": {	322 "response": {

307 "$ref": "ListCoursesResponse"	323 "$ref": "ListCoursesResponse"

308 },	324 },

309 "scopes": [	325 "scopes": [

310 "https://www.googleapis.com/auth/classroom.courses",	326 "https://www.googleapis.com/auth/classroom.courses",

311 "https://www.googleapis.com/auth/classroom.courses.reado nly"	327 "https://www.googleapis.com/auth/classroom.courses.reado nly"

312 ]	328 ]

	329 },

	330 "get": {

	331 "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",

	332 "httpMethod": "GET",

	333 "id": "classroom.courses.get",

	334 "parameterOrder": [

	335 "id"

	336 ],

	337 "parameters": {

	338 "id": {

	339 "description": "Identifier of the course to return.\ nThis identifier can be either the Classroom-assigned identifier or an\nalias.",

	340 "location": "path",

	341 "required": true,

	342 "type": "string"

	343 }

	344 },

	345 "path": "v1/courses/{id}",

	346 "response": {

	347 "$ref": "Course"

	348 },

	349 "scopes": [

	350 "https://www.googleapis.com/auth/classroom.courses",

	351 "https://www.googleapis.com/auth/classroom.courses.reado nly"

	352 ]

	353 },

	354 "create": {

	355 "description": "Creates a course.\n\nThe user specified in ` ownerId` is the owner of the created course\nand added as a teacher.\n\nThis met hod returns the following error codes:\n\n* `PERMISSION_DENIED` if the requestin g user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the cour se owner's account is disabled or for\nthe following request errors:\n * User GroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in th e `id` and\nalready exists.",

	356 "httpMethod": "POST",

	357 "id": "classroom.courses.create",

	358 "parameterOrder": [],

	359 "parameters": {},

	360 "path": "v1/courses",

	361 "request": {

	362 "$ref": "Course"

	363 },

	364 "response": {

	365 "$ref": "Course"

	366 },

	367 "scopes": [

	368 "https://www.googleapis.com/auth/classroom.courses"

	369 ]

	370 },

	371 "update": {

	372 "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p ermitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the follow ing request errors:\n * CourseNotModifiable",

	373 "httpMethod": "PUT",

	374 "id": "classroom.courses.update",

	375 "parameterOrder": [

	376 "id"

	377 ],

	378 "parameters": {

	379 "id": {

	380 "description": "Identifier of the course to update.\ nThis identifier can be either the Classroom-assigned identifier or an\nalias.",

	381 "location": "path",

	382 "required": true,

	383 "type": "string"

	384 }

	385 },

	386 "path": "v1/courses/{id}",

	387 "request": {

	388 "$ref": "Course"

	389 },

	390 "response": {

	391 "$ref": "Course"

	392 },

	393 "scopes": [

	394 "https://www.googleapis.com/auth/classroom.courses"

	395 ]

	396 },

	397 "patch": {

	398 "description": "Updates one or more fields in a course.\n\nT his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re questing user is not permitted to modify the\nrequested course or for access err ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM ENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * Cou rseNotModifiable",

	399 "httpMethod": "PATCH",

	400 "id": "classroom.courses.patch",

	401 "parameterOrder": [

	402 "id"

	403 ],

	404 "parameters": {

	405 "updateMask": {

	406 "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `nam e`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseSta te`\n\nWhen set in a query parameter, this field should be specified as\n\n`upda teMask=<field1>,<field2>,...`",

	407 "format": "google-fieldmask",

	408 "location": "query",

	409 "type": "string"

	410 },

	411 "id": {

	412 "description": "Identifier of the course to update.\ nThis identifier can be either the Classroom-assigned identifier or an\nalias.",

	413 "location": "path",

	414 "required": true,

	415 "type": "string"

	416 }

	417 },

	418 "path": "v1/courses/{id}",

	419 "request": {

	420 "$ref": "Course"

	421 },

	422 "response": {

	423 "$ref": "Course"

	424 },

	425 "scopes": [

	426 "https://www.googleapis.com/auth/classroom.courses"

	427 ]

	428 },

	429 "delete": {

	430 "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p ermitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",

	431 "httpMethod": "DELETE",

	432 "id": "classroom.courses.delete",

	433 "parameterOrder": [

	434 "id"

	435 ],

	436 "parameters": {

	437 "id": {

	438 "description": "Identifier of the course to delete.\ nThis identifier can be either the Classroom-assigned identifier or an\nalias.",

	439 "location": "path",

	440 "required": true,

	441 "type": "string"

	442 }

	443 },

	444 "path": "v1/courses/{id}",

	445 "response": {

	446 "$ref": "Empty"

	447 },

	448 "scopes": [

	449 "https://www.googleapis.com/auth/classroom.courses"

	450 ]

313 }	451 }

314 },	452 },

315 "resources": {	453 "resources": {

316 "aliases": {

317 "methods": {

318 "create": {

319 "description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.",

320 "httpMethod": "POST",

321 "id": "classroom.courses.aliases.create",

322 "parameterOrder": [

323 "courseId"

324 ],

325 "parameters": {

326 "courseId": {

327 "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an ali as.",

328 "location": "path",

329 "required": true,

330 "type": "string"

331 }

332 },

333 "path": "v1/courses/{courseId}/aliases",

334 "request": {

335 "$ref": "CourseAlias"

336 },

337 "response": {

338 "$ref": "CourseAlias"

339 },

340 "scopes": [

341 "https://www.googleapis.com/auth/classroom.cours es"

342 ]

343 },

344 "delete": {

345 "description": "Deletes an alias of a course. This m ethod returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` i f the alias does not exist.",

346 "httpMethod": "DELETE",

347 "id": "classroom.courses.aliases.delete",

348 "parameterOrder": [

349 "courseId",

350 "alias"

351 ],

352 "parameters": {

353 "courseId": {

354 "description": "Identifier of the course who se alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.",

355 "location": "path",

356 "required": true,

357 "type": "string"

358 },

359 "alias": {

360 "description": "Alias to delete. This may no t be the Classroom-assigned identifier.",

361 "location": "path",

362 "required": true,

363 "type": "string"

364 }

365 },

366 "path": "v1/courses/{courseId}/aliases/{alias}",

367 "response": {

368 "$ref": "Empty"

369 },

370 "scopes": [

371 "https://www.googleapis.com/auth/classroom.cours es"

372 ]

373 },

374 "list": {

375 "description": "Returns a list of aliases for a cour se. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `N OT_FOUND` if the course does not exist.",

376 "httpMethod": "GET",

377 "id": "classroom.courses.aliases.list",

378 "parameterOrder": [

379 "courseId"

380 ],

381 "parameters": {

382 "courseId": {

383 "description": "The identifier of the course . This identifier can be either the Classroom-assigned identifier or an alias.",

384 "location": "path",

385 "required": true,

386 "type": "string"

387 },

388 "pageSize": {

389 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the server may assign a maximum. The s erver may return fewer than the specified number of results.",

390 "format": "int32",

391 "location": "query",

392 "type": "integer"

393 },

394 "pageToken": {

395 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",

396 "location": "query",

397 "type": "string"

398 }

399 },

400 "path": "v1/courses/{courseId}/aliases",

401 "response": {

402 "$ref": "ListCourseAliasesResponse"

403 },

404 "scopes": [

405 "https://www.googleapis.com/auth/classroom.cours es",

406 "https://www.googleapis.com/auth/classroom.cours es.readonly"

407 ]

408 }

409 }

410 },

411 "teachers": {	454 "teachers": {

412 "methods": {	455 "methods": {

413 "create": {	456 "create": {

414 "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * U serGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teac her or student in the course.",	457 "description": "Creates a teacher of a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRE CONDITION` if the requested user's account is disabled,\nfor the following reque st errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * Cou rseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXIST S` if the user is already a teacher or student in the\ncourse.",

415 "httpMethod": "POST",	458 "httpMethod": "POST",

416 "id": "classroom.courses.teachers.create",	459 "id": "classroom.courses.teachers.create",

417 "parameterOrder": [	460 "parameterOrder": [

418 "courseId"	461 "courseId"

419 ],	462 ],

420 "parameters": {	463 "parameters": {

421 "courseId": {	464 "courseId": {

422 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	465 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

423 "location": "path",	466 "location": "path",

424 "required": true,	467 "required": true,

425 "type": "string"	468 "type": "string"

426 }	469 }

427 },	470 },

428 "path": "v1/courses/{courseId}/teachers",	471 "path": "v1/courses/{courseId}/teachers",

429 "request": {	472 "request": {

430 "$ref": "Teacher"	473 "$ref": "Teacher"

431 },	474 },

432 "response": {	475 "response": {

433 "$ref": "Teacher"	476 "$ref": "Teacher"

434 },	477 },

435 "scopes": [	478 "scopes": [

436 "https://www.googleapis.com/auth/classroom.profi le.emails",	479 "https://www.googleapis.com/auth/classroom.profi le.emails",

437 "https://www.googleapis.com/auth/classroom.profi le.photos",	480 "https://www.googleapis.com/auth/classroom.profi le.photos",

438 "https://www.googleapis.com/auth/classroom.roste rs"	481 "https://www.googleapis.com/auth/classroom.roste rs"

439 ]	482 ]

440 },	483 },

441 "get": {	484 "get": {

442 "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course d oes not exist.",	485 "description": "Returns a teacher of a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to view\nteachers of this course or for access err ors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ ncourse does not exist.",

443 "httpMethod": "GET",	486 "httpMethod": "GET",

444 "id": "classroom.courses.teachers.get",	487 "id": "classroom.courses.teachers.get",

445 "parameterOrder": [	488 "parameterOrder": [

446 "courseId",	489 "courseId",

447 "userId"	490 "userId"

448 ],	491 ],

449 "parameters": {	492 "parameters": {

450 "courseId": {	493 "courseId": {

451 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	494 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

452 "location": "path",	495 "location": "path",

453 "required": true,	496 "required": true,

454 "type": "string"	497 "type": "string"

455 },	498 },

456 "userId": {	499 "userId": {

457 "description": "Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier fo r the user * the email address of the user * the string literal `\"me\"`, indica ting the requesting user",	500 "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie r for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

458 "location": "path",	501 "location": "path",

459 "required": true,	502 "required": true,

460 "type": "string"	503 "type": "string"

461 }	504 }

462 },	505 },

463 "path": "v1/courses/{courseId}/teachers/{userId}",	506 "path": "v1/courses/{courseId}/teachers/{userId}",

464 "response": {	507 "response": {

465 "$ref": "Teacher"	508 "$ref": "Teacher"

466 },	509 },

467 "scopes": [	510 "scopes": [

468 "https://www.googleapis.com/auth/classroom.profi le.emails",	511 "https://www.googleapis.com/auth/classroom.profi le.emails",

469 "https://www.googleapis.com/auth/classroom.profi le.photos",	512 "https://www.googleapis.com/auth/classroom.profi le.photos",

470 "https://www.googleapis.com/auth/classroom.roste rs",	513 "https://www.googleapis.com/auth/classroom.roste rs",

471 "https://www.googleapis.com/auth/classroom.roste rs.readonly"	514 "https://www.googleapis.com/auth/classroom.roste rs.readonly"

472 ]	515 ]

473 },	516 },

474 "delete": {

475 "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the prim ary teacher of this course.",

476 "httpMethod": "DELETE",

477 "id": "classroom.courses.teachers.delete",

478 "parameterOrder": [

479 "courseId",

480 "userId"

481 ],

482 "parameters": {

483 "courseId": {

484 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",

485 "location": "path",

486 "required": true,

487 "type": "string"

488 },

489 "userId": {

490 "description": "Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier fo r the user * the email address of the user * the string literal `\"me\"`, indica ting the requesting user",

491 "location": "path",

492 "required": true,

493 "type": "string"

494 }

495 },

496 "path": "v1/courses/{courseId}/teachers/{userId}",

497 "response": {

498 "$ref": "Empty"

499 },

500 "scopes": [

501 "https://www.googleapis.com/auth/classroom.roste rs"

502 ]

503 },

504 "list": {	517 "list": {

505 "description": "Returns a list of teachers of this c ourse that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",	518 "description": "Returns a list of teachers of this c ourse that the requester\nis permitted to view.\n\nThis method returns the follo wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_ DENIED` for access errors.",

506 "httpMethod": "GET",	519 "httpMethod": "GET",

507 "id": "classroom.courses.teachers.list",	520 "id": "classroom.courses.teachers.list",

508 "parameterOrder": [	521 "parameterOrder": [

509 "courseId"	522 "courseId"

510 ],	523 ],

511 "parameters": {	524 "parameters": {

512 "courseId": {	525 "courseId": {

513 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	526 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

514 "location": "path",	527 "location": "path",

515 "required": true,	528 "required": true,

516 "type": "string"	529 "type": "string"

517 },	530 },

518 "pageSize": {	531 "pageSize": {

519 "description": "Maximum number of items to r eturn. Zero means no maximum. The server may return fewer than the specified num ber of results.",	532 "description": "Maximum number of items to r eturn. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",

520 "format": "int32",	533 "format": "int32",

521 "location": "query",	534 "location": "query",

522 "type": "integer"	535 "type": "integer"

523 },	536 },

524 "pageToken": {	537 "pageToken": {

525 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",	538 "description": "nextPageToken\nvalue returne d from a previous\nlist call, indicating that\nthe subsequent page of results sh ould be returned.\n\nThe list request must be\notherwise identical to the one th at resulted in this token.",

526 "location": "query",	539 "location": "query",

527 "type": "string"	540 "type": "string"

528 }	541 }

529 },	542 },

530 "path": "v1/courses/{courseId}/teachers",	543 "path": "v1/courses/{courseId}/teachers",

531 "response": {	544 "response": {

532 "$ref": "ListTeachersResponse"	545 "$ref": "ListTeachersResponse"

533 },	546 },

534 "scopes": [	547 "scopes": [

535 "https://www.googleapis.com/auth/classroom.profi le.emails",	548 "https://www.googleapis.com/auth/classroom.profi le.emails",

536 "https://www.googleapis.com/auth/classroom.profi le.photos",	549 "https://www.googleapis.com/auth/classroom.profi le.photos",

537 "https://www.googleapis.com/auth/classroom.roste rs",	550 "https://www.googleapis.com/auth/classroom.roste rs",

538 "https://www.googleapis.com/auth/classroom.roste rs.readonly"	551 "https://www.googleapis.com/auth/classroom.roste rs.readonly"

539 ]	552 ]

	553 },

	554 "delete": {

	555 "description": "Deletes a teacher of a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to delete\nteachers of this course or for access e rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t o the primary teacher\nof this course.",

	556 "httpMethod": "DELETE",

	557 "id": "classroom.courses.teachers.delete",

	558 "parameterOrder": [

	559 "courseId",

	560 "userId"

	561 ],

	562 "parameters": {

	563 "courseId": {

	564 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

	565 "location": "path",

	566 "required": true,

	567 "type": "string"

	568 },

	569 "userId": {

	570 "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie r for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

	571 "location": "path",

	572 "required": true,

	573 "type": "string"

	574 }

	575 },

	576 "path": "v1/courses/{courseId}/teachers/{userId}",

	577 "response": {

	578 "$ref": "Empty"

	579 },

	580 "scopes": [

	581 "https://www.googleapis.com/auth/classroom.roste rs"

	582 ]

	583 }

	584 }

	585 },

	586 "aliases": {

	587 "methods": {

	588 "create": {

	589 "description": "Creates an alias for a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to create the\nalias or for access errors.\n* `NOT _FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already e xists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for t he\n requesting user or course (for example, if a user not in a domain\n attem pts to access a domain-scoped alias).",

	590 "httpMethod": "POST",

	591 "id": "classroom.courses.aliases.create",

	592 "parameterOrder": [

	593 "courseId"

	594 ],

	595 "parameters": {

	596 "courseId": {

	597 "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\na lias.",

	598 "location": "path",

	599 "required": true,

	600 "type": "string"

	601 }

	602 },

	603 "path": "v1/courses/{courseId}/aliases",

	604 "request": {

	605 "$ref": "CourseAlias"

	606 },

	607 "response": {

	608 "$ref": "CourseAlias"

	609 },

	610 "scopes": [

	611 "https://www.googleapis.com/auth/classroom.cours es"

	612 ]

	613 },

	614 "list": {

	615 "description": "Returns a list of aliases for a cour se.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i f the requesting user is not permitted to access the\ncourse or for access error s.\n* `NOT_FOUND` if the course does not exist.",

	616 "httpMethod": "GET",

	617 "id": "classroom.courses.aliases.list",

	618 "parameterOrder": [

	619 "courseId"

	620 ],

	621 "parameters": {

	622 "courseId": {

	623 "description": "The identifier of the course .\nThis identifier can be either the Classroom-assigned identifier or an\nalias. ",

	624 "location": "path",

	625 "required": true,

	626 "type": "string"

	627 },

	628 "pageSize": {

	629 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT he server may return fewer than the specified number of results.",

	630 "format": "int32",

	631 "location": "query",

	632 "type": "integer"

	633 },

	634 "pageToken": {

	635 "description": "nextPageToken\nvalue returne d from a previous\nlist call,\nindicating that the subsequent page of results sh ould be returned.\n\nThe list request\nmust be otherwise identical to the one th at resulted in this token.",

	636 "location": "query",

	637 "type": "string"

	638 }

	639 },

	640 "path": "v1/courses/{courseId}/aliases",

	641 "response": {

	642 "$ref": "ListCourseAliasesResponse"

	643 },

	644 "scopes": [

	645 "https://www.googleapis.com/auth/classroom.cours es",

	646 "https://www.googleapis.com/auth/classroom.cours es.readonly"

	647 ]

	648 },

	649 "delete": {

	650 "description": "Deletes an alias of a course.\n\nThi s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_ FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques ted does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",

	651 "httpMethod": "DELETE",

	652 "id": "classroom.courses.aliases.delete",

	653 "parameterOrder": [

	654 "courseId",

	655 "alias"

	656 ],

	657 "parameters": {

	658 "courseId": {

	659 "description": "Identifier of the course who se alias should be deleted.\nThis identifier can be either the Classroom-assigne d identifier or an\nalias.",

	660 "location": "path",

	661 "required": true,

	662 "type": "string"

	663 },

	664 "alias": {

	665 "description": "Alias to delete.\nThis may n ot be the Classroom-assigned identifier.",

	666 "location": "path",

	667 "required": true,

	668 "type": "string"

	669 }

	670 },

	671 "path": "v1/courses/{courseId}/aliases/{alias}",

	672 "response": {

	673 "$ref": "Empty"

	674 },

	675 "scopes": [

	676 "https://www.googleapis.com/auth/classroom.cours es"

	677 ]

540 }	678 }

541 }	679 }

542 },	680 },

543 "students": {	681 "students": {

544 "methods": {	682 "methods": {

545 "create": {	683 "create": {

546 "description": "Adds a user as a student of a course . This method returns the following error codes: * `PERMISSION_DENIED` if the re questing user is not permitted to create students in this course or for access e rrors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECON DITION` if the requested user's account is disabled, for the following request e rrors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLi mitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",	684 "description": "Adds a user as a student of a course .\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for a ccess errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAIL ED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",

547 "httpMethod": "POST",	685 "httpMethod": "POST",

548 "id": "classroom.courses.students.create",	686 "id": "classroom.courses.students.create",

549 "parameterOrder": [	687 "parameterOrder": [

550 "courseId"	688 "courseId"

551 ],	689 ],

552 "parameters": {	690 "parameters": {

553 "courseId": {	691 "courseId": {

554 "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned iden tifier or an alias.",	692 "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned ide ntifier or an\nalias.",

555 "location": "path",	693 "location": "path",

556 "required": true,	694 "required": true,

557 "type": "string"	695 "type": "string"

558 },	696 },

559 "enrollmentCode": {	697 "enrollmentCode": {

560 "description": "Enrollment code of the cours e to create the student in. This code is required if userId corresponds to the r equesting user; it may be omitted if the requesting user has administrative perm issions to create students for any user.",	698 "description": "Enrollment code of the cours e to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative p ermissions to create students for any user.",

561 "location": "query",	699 "location": "query",

562 "type": "string"	700 "type": "string"

563 }	701 }

564 },	702 },

565 "path": "v1/courses/{courseId}/students",	703 "path": "v1/courses/{courseId}/students",

566 "request": {	704 "request": {

567 "$ref": "Student"	705 "$ref": "Student"

568 },	706 },

569 "response": {	707 "response": {

570 "$ref": "Student"	708 "$ref": "Student"

571 },	709 },

572 "scopes": [	710 "scopes": [

573 "https://www.googleapis.com/auth/classroom.profi le.emails",	711 "https://www.googleapis.com/auth/classroom.profi le.emails",

574 "https://www.googleapis.com/auth/classroom.profi le.photos",	712 "https://www.googleapis.com/auth/classroom.profi le.photos",

575 "https://www.googleapis.com/auth/classroom.roste rs"	713 "https://www.googleapis.com/auth/classroom.roste rs"

576 ]	714 ]

577 },	715 },

578 "get": {	716 "get": {

579 "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course d oes not exist.",	717 "description": "Returns a student of a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to view\nstudents of this course or for access err ors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ ncourse does not exist.",

580 "httpMethod": "GET",	718 "httpMethod": "GET",

581 "id": "classroom.courses.students.get",	719 "id": "classroom.courses.students.get",

582 "parameterOrder": [	720 "parameterOrder": [

583 "courseId",	721 "courseId",

584 "userId"	722 "userId"

585 ],	723 ],

586 "parameters": {	724 "parameters": {

587 "courseId": {	725 "courseId": {

588 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	726 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

589 "location": "path",	727 "location": "path",

590 "required": true,	728 "required": true,

591 "type": "string"	729 "type": "string"

592 },	730 },

593 "userId": {	731 "userId": {

594 "description": "Identifier of the student to return. The identifier can be one of the following: * the numeric identifier fo r the user * the email address of the user * the string literal `\"me\"`, indica ting the requesting user",	732 "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie r for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

595 "location": "path",	733 "location": "path",

596 "required": true,	734 "required": true,

597 "type": "string"	735 "type": "string"

598 }	736 }

599 },	737 },

600 "path": "v1/courses/{courseId}/students/{userId}",	738 "path": "v1/courses/{courseId}/students/{userId}",

601 "response": {	739 "response": {

602 "$ref": "Student"	740 "$ref": "Student"

603 },	741 },

604 "scopes": [	742 "scopes": [

605 "https://www.googleapis.com/auth/classroom.profi le.emails",	743 "https://www.googleapis.com/auth/classroom.profi le.emails",

606 "https://www.googleapis.com/auth/classroom.profi le.photos",	744 "https://www.googleapis.com/auth/classroom.profi le.photos",

607 "https://www.googleapis.com/auth/classroom.roste rs",	745 "https://www.googleapis.com/auth/classroom.roste rs",

608 "https://www.googleapis.com/auth/classroom.roste rs.readonly"	746 "https://www.googleapis.com/auth/classroom.roste rs.readonly"

609 ]	747 ]

610 },	748 },

611 "delete": {

612 "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",

613 "httpMethod": "DELETE",

614 "id": "classroom.courses.students.delete",

615 "parameterOrder": [

616 "courseId",

617 "userId"

618 ],

619 "parameters": {

620 "courseId": {

621 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",

622 "location": "path",

623 "required": true,

624 "type": "string"

625 },

626 "userId": {

627 "description": "Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier fo r the user * the email address of the user * the string literal `\"me\"`, indica ting the requesting user",

628 "location": "path",

629 "required": true,

630 "type": "string"

631 }

632 },

633 "path": "v1/courses/{courseId}/students/{userId}",

634 "response": {

635 "$ref": "Empty"

636 },

637 "scopes": [

638 "https://www.googleapis.com/auth/classroom.roste rs"

639 ]

640 },

641 "list": {	749 "list": {

642 "description": "Returns a list of students of this c ourse that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",	750 "description": "Returns a list of students of this c ourse that the requester\nis permitted to view.\n\nThis method returns the follo wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_ DENIED` for access errors.",

643 "httpMethod": "GET",	751 "httpMethod": "GET",

644 "id": "classroom.courses.students.list",	752 "id": "classroom.courses.students.list",

645 "parameterOrder": [	753 "parameterOrder": [

646 "courseId"	754 "courseId"

647 ],	755 ],

648 "parameters": {	756 "parameters": {

649 "courseId": {	757 "courseId": {

650 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	758 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

651 "location": "path",	759 "location": "path",

652 "required": true,	760 "required": true,

653 "type": "string"	761 "type": "string"

654 },	762 },

655 "pageSize": {	763 "pageSize": {

656 "description": "Maximum number of items to r eturn. Zero means no maximum. The server may return fewer than the specified num ber of results.",	764 "description": "Maximum number of items to r eturn. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",

657 "format": "int32",	765 "format": "int32",

658 "location": "query",	766 "location": "query",

659 "type": "integer"	767 "type": "integer"

660 },	768 },

661 "pageToken": {	769 "pageToken": {

662 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",	770 "description": "nextPageToken\nvalue returne d from a previous\nlist call, indicating that\nthe subsequent page of results sh ould be returned.\n\nThe list request must be\notherwise identical to the one th at resulted in this token.",

663 "location": "query",	771 "location": "query",

664 "type": "string"	772 "type": "string"

665 }	773 }

666 },	774 },

667 "path": "v1/courses/{courseId}/students",	775 "path": "v1/courses/{courseId}/students",

668 "response": {	776 "response": {

669 "$ref": "ListStudentsResponse"	777 "$ref": "ListStudentsResponse"

670 },	778 },

671 "scopes": [	779 "scopes": [

672 "https://www.googleapis.com/auth/classroom.profi le.emails",	780 "https://www.googleapis.com/auth/classroom.profi le.emails",

673 "https://www.googleapis.com/auth/classroom.profi le.photos",	781 "https://www.googleapis.com/auth/classroom.profi le.photos",

674 "https://www.googleapis.com/auth/classroom.roste rs",	782 "https://www.googleapis.com/auth/classroom.roste rs",

675 "https://www.googleapis.com/auth/classroom.roste rs.readonly"	783 "https://www.googleapis.com/auth/classroom.roste rs.readonly"

676 ]	784 ]

	785 },

	786 "delete": {

	787 "description": "Deletes a student of a course.\n\nTh is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req uesting user is not permitted to delete\nstudents of this course or for access e rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th e\ncourse does not exist.",

	788 "httpMethod": "DELETE",

	789 "id": "classroom.courses.students.delete",

	790 "parameterOrder": [

	791 "courseId",

	792 "userId"

	793 ],

	794 "parameters": {

	795 "courseId": {

	796 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

	797 "location": "path",

	798 "required": true,

	799 "type": "string"

	800 },

	801 "userId": {

	802 "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie r for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

	803 "location": "path",

	804 "required": true,

	805 "type": "string"

	806 }

	807 },

	808 "path": "v1/courses/{courseId}/students/{userId}",

	809 "response": {

	810 "$ref": "Empty"

	811 },

	812 "scopes": [

	813 "https://www.googleapis.com/auth/classroom.roste rs"

	814 ]

677 }	815 }

678 }	816 }

679 },	817 },

680 "courseWork": {	818 "courseWork": {

681 "methods": {	819 "methods": {

682 "create": {	820 "create": {

683 "description": "Creates course work. The resulting c ourse work (and corresponding student submissions) are associated with the Devel oper Console project of the [OAuth client ID](https://support.google.com/cloud/a nswer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the asso ciated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the req uested course, create course work in the requested course, share a Drive attachm ent, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * ` NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for t he following request error: * AttachmentNotVisible",	821 "description": "Creates course work.\n\nThe resultin g course work (and corresponding student submissions) are\nassociated with the D eveloper Console project of the\n[OAuth client ID](https://support.google.com/cl oud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from t he associated\nDeveloper Console project.\n\nThis method returns the following e rror codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_ PRECONDITION` for the following request error:\n * AttachmentNotVisible",

684 "httpMethod": "POST",	822 "httpMethod": "POST",

685 "id": "classroom.courses.courseWork.create",	823 "id": "classroom.courses.courseWork.create",

686 "parameterOrder": [	824 "parameterOrder": [

687 "courseId"	825 "courseId"

688 ],	826 ],

689 "parameters": {	827 "parameters": {

690 "courseId": {	828 "courseId": {

691 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	829 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

692 "location": "path",	830 "location": "path",

693 "required": true,	831 "required": true,

694 "type": "string"	832 "type": "string"

695 }	833 }

696 },	834 },

697 "path": "v1/courses/{courseId}/courseWork",	835 "path": "v1/courses/{courseId}/courseWork",

698 "request": {	836 "request": {

699 "$ref": "CourseWork"	837 "$ref": "CourseWork"

700 },	838 },

701 "response": {	839 "response": {

702 "$ref": "CourseWork"	840 "$ref": "CourseWork"

703 },	841 },

704 "scopes": [	842 "scopes": [

705 "https://www.googleapis.com/auth/classroom.cours ework.students"	843 "https://www.googleapis.com/auth/classroom.cours ework.students"

706 ]	844 ]

707 },	845 },

708 "patch": {

709 "description": "Updates one or more fields of a cour se work. See google.classroom.v1.CourseWork for details of which fields may be u pdated and who may change them. This request must be made by the Developer Conso le project of the [OAuth client ID](https://support.google.com/cloud/answer/6158 849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to m ake the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",

710 "httpMethod": "PATCH",

711 "id": "classroom.courses.courseWork.patch",

712 "parameterOrder": [

713 "courseId",

714 "id"

715 ],

716 "parameters": {

717 "courseId": {

718 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",

719 "location": "path",

720 "required": true,

721 "type": "string"

722 },

723 "id": {

724 "description": "Identifier of the course wor k.",

725 "location": "path",

726 "required": true,

727 "type": "string"

728 },

729 "updateMask": {

730 "description": "Mask that identifies which f ields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be r eturned. The following fields may be specified by teachers: * `title` * `descrip tion` * `state` * `due_date` * `due_time` * `max_points` * `submission_modificat ion_mode`",

731 "location": "query",

732 "type": "string"

733 }

734 },

735 "path": "v1/courses/{courseId}/courseWork/{id}",

736 "request": {

737 "$ref": "CourseWork"

738 },

739 "response": {

740 "$ref": "CourseWork"

741 },

742 "scopes": [

743 "https://www.googleapis.com/auth/classroom.cours ework.students"

744 ]

745 },

746 "delete": {

747 "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://s upport.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work , if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.",

748 "httpMethod": "DELETE",

749 "id": "classroom.courses.courseWork.delete",

750 "parameterOrder": [

751 "courseId",

752 "id"

753 ],

754 "parameters": {

755 "courseId": {

756 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",

757 "location": "path",

758 "required": true,

759 "type": "string"

760 },

761 "id": {

762 "description": "Identifier of the course wor k to delete. This identifier is a Classroom-assigned identifier.",

763 "location": "path",

764 "required": true,

765 "type": "string"

766 }

767 },

768 "path": "v1/courses/{courseId}/courseWork/{id}",

769 "response": {

770 "$ref": "Empty"

771 },

772 "scopes": [

773 "https://www.googleapis.com/auth/classroom.cours ework.students"

774 ]

775 },

776 "get": {	846 "get": {

777 "description": "Returns course work. This method ret urns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access error s. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the reques ted course or course work does not exist.",	847 "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting us er is not permitted to access the\nrequested course or course work, or for acces s errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if t he requested course or course work does not exist.",

778 "httpMethod": "GET",	848 "httpMethod": "GET",

779 "id": "classroom.courses.courseWork.get",	849 "id": "classroom.courses.courseWork.get",

780 "parameterOrder": [	850 "parameterOrder": [

781 "courseId",	851 "courseId",

782 "id"	852 "id"

783 ],	853 ],

784 "parameters": {	854 "parameters": {

785 "courseId": {	855 "courseId": {

786 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	856 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

787 "location": "path",	857 "location": "path",

788 "required": true,	858 "required": true,

789 "type": "string"	859 "type": "string"

790 },	860 },

791 "id": {	861 "id": {

792 "description": "Identifier of the course wor k.",	862 "description": "Identifier of the course wor k.",

793 "location": "path",	863 "location": "path",

794 "required": true,	864 "required": true,

795 "type": "string"	865 "type": "string"

796 }	866 }

797 },	867 },

798 "path": "v1/courses/{courseId}/courseWork/{id}",	868 "path": "v1/courses/{courseId}/courseWork/{id}",

799 "response": {	869 "response": {

800 "$ref": "CourseWork"	870 "$ref": "CourseWork"

801 },	871 },

802 "scopes": [	872 "scopes": [

803 "https://www.googleapis.com/auth/classroom.cours e-work.readonly",

804 "https://www.googleapis.com/auth/classroom.cours ework.me",	873 "https://www.googleapis.com/auth/classroom.cours ework.me",

805 "https://www.googleapis.com/auth/classroom.cours ework.me.readonly",	874 "https://www.googleapis.com/auth/classroom.cours ework.me.readonly",

806 "https://www.googleapis.com/auth/classroom.cours ework.students",	875 "https://www.googleapis.com/auth/classroom.cours ework.students",

807 "https://www.googleapis.com/auth/classroom.cours ework.students.readonly"	876 "https://www.googleapis.com/auth/classroom.cours ework.students.readonly"

808 ]	877 ]

809 },	878 },

810 "list": {	879 "list": {

811 "description": "Returns a list of course work that t he requester is permitted to view. Course students may only view `PUBLISHED` cou rse work. Course teachers and domain administrators may view all course work. Th is method returns the following error codes: * `PERMISSION_DENIED` if the reques ting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",	880 "description": "Returns a list of course work that t he requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work .\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for acce ss errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",

812 "httpMethod": "GET",	881 "httpMethod": "GET",

813 "id": "classroom.courses.courseWork.list",	882 "id": "classroom.courses.courseWork.list",

814 "parameterOrder": [	883 "parameterOrder": [

815 "courseId"	884 "courseId"

816 ],	885 ],

817 "parameters": {	886 "parameters": {

818 "courseId": {	887 "courseId": {

819 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",	888 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

820 "location": "path",	889 "location": "path",

821 "required": true,	890 "required": true,

822 "type": "string"	891 "type": "string"

823 },	892 },

824 "courseWorkStates": {	893 "courseWorkStates": {

825 "description": "Restriction on the work stat us to return. Only courseWork that matches is returned. If unspecified, items wi th a work status of `PUBLISHED` is returned.",	894 "description": "Restriction on the work stat us to return. Only courseWork that matches\nis returned. If unspecified, items w ith a work status of `PUBLISHED`\nis returned.",

826 "enum": [	895 "enum": [

827 "COURSE_WORK_STATE_UNSPECIFIED",	896 "COURSE_WORK_STATE_UNSPECIFIED",

828 "PUBLISHED",	897 "PUBLISHED",

829 "DRAFT",	898 "DRAFT",

830 "DELETED"	899 "DELETED"

831 ],	900 ],

832 "location": "query",	901 "location": "query",

833 "repeated": true,	902 "repeated": true,

834 "type": "string"	903 "type": "string"

835 },	904 },

836 "orderBy": {

837 "description": "Optional sort ordering for r esults. A comma-separated list of fields with an optional sort direction keyword . Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavio r. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",

838 "location": "query",

839 "type": "string"

840 },

841 "pageSize": {	905 "pageSize": {

842 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the server may assign a maximum. The s erver may return fewer than the specified number of results.",	906 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT he server may return fewer than the specified number of results.",

843 "format": "int32",	907 "format": "int32",

844 "location": "query",	908 "location": "query",

845 "type": "integer"	909 "type": "integer"

846 },	910 },

	911 "orderBy": {

	912 "description": "Optional sort ordering for r esults. A comma-separated list of fields with\nan optional sort direction keywor d. Supported fields are `updateTime`\nand `dueDate`. Supported direction keyword s are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default beha vior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",

	913 "location": "query",

	914 "type": "string"

	915 },

847 "pageToken": {	916 "pageToken": {

848 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",	917 "description": "nextPageToken\nvalue returne d from a previous\nlist call,\nindicating that the subsequent page of results sh ould be returned.\n\nThe list request\nmust be otherwise identical to the one th at resulted in this token.",

849 "location": "query",	918 "location": "query",

850 "type": "string"	919 "type": "string"

851 }	920 }

852 },	921 },

853 "path": "v1/courses/{courseId}/courseWork",	922 "path": "v1/courses/{courseId}/courseWork",

854 "response": {	923 "response": {

855 "$ref": "ListCourseWorkResponse"	924 "$ref": "ListCourseWorkResponse"

856 },	925 },

857 "scopes": [	926 "scopes": [

858 "https://www.googleapis.com/auth/classroom.cours e-work.readonly",

859 "https://www.googleapis.com/auth/classroom.cours ework.me",	927 "https://www.googleapis.com/auth/classroom.cours ework.me",

860 "https://www.googleapis.com/auth/classroom.cours ework.me.readonly",	928 "https://www.googleapis.com/auth/classroom.cours ework.me.readonly",

861 "https://www.googleapis.com/auth/classroom.cours ework.students",	929 "https://www.googleapis.com/auth/classroom.cours ework.students",

862 "https://www.googleapis.com/auth/classroom.cours ework.students.readonly"	930 "https://www.googleapis.com/auth/classroom.cours ework.students.readonly"

863 ]	931 ]

	932 },

	933 "patch": {

	934 "description": "Updates one or more fields of a cour se work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Develope r Console project of the\n[OAuth client ID](https://support.google.com/cloud/ans wer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting de veloper project did not create\nthe corresponding course work, if the user is no t permitted to make the\nrequested modification to the student submission, or fo r\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_ PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FO UND` if the requested course, course work, or student submission\ndoes not exist .",

	935 "httpMethod": "PATCH",

	936 "id": "classroom.courses.courseWork.patch",

	937 "parameterOrder": [

	938 "courseId",

	939 "id"

	940 ],

	941 "parameters": {

	942 "courseId": {

	943 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

	944 "location": "path",

	945 "required": true,

	946 "type": "string"

	947 },

	948 "updateMask": {

	949 "description": "Mask that identifies which f ields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values , it can be cleared\nby specifying it in the update mask and not in the CourseWo rk object. If a\nfield that does not support empty values is included in the upd ate mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\ n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `subm ission_modification_mode`",

	950 "format": "google-fieldmask",

	951 "location": "query",

	952 "type": "string"

	953 },

	954 "id": {

	955 "description": "Identifier of the course wor k.",

	956 "location": "path",

	957 "required": true,

	958 "type": "string"

	959 }

	960 },

	961 "path": "v1/courses/{courseId}/courseWork/{id}",

	962 "request": {

	963 "$ref": "CourseWork"

	964 },

	965 "response": {

	966 "$ref": "CourseWork"

	967 },

	968 "scopes": [

	969 "https://www.googleapis.com/auth/classroom.cours ework.students"

	970 ]

	971 },

	972 "delete": {

	973 "description": "Deletes a course work.\n\nThis reque st must be made by the Developer Console project of the\n[OAuth client ID](https ://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI ON_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested c ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request ed ID.",

	974 "httpMethod": "DELETE",

	975 "id": "classroom.courses.courseWork.delete",

	976 "parameterOrder": [

	977 "courseId",

	978 "id"

	979 ],

	980 "parameters": {

	981 "courseId": {

	982 "description": "Identifier of the course.\nT his identifier can be either the Classroom-assigned identifier or an\nalias.",

	983 "location": "path",

	984 "required": true,

	985 "type": "string"

	986 },

	987 "id": {

	988 "description": "Identifier of the course wor k to delete.\nThis identifier is a Classroom-assigned identifier.",

	989 "location": "path",

	990 "required": true,

	991 "type": "string"

	992 }

	993 },

	994 "path": "v1/courses/{courseId}/courseWork/{id}",

	995 "response": {

	996 "$ref": "Empty"

	997 },

	998 "scopes": [

	999 "https://www.googleapis.com/auth/classroom.cours ework.students"

	1000 ]

864 }	1001 }

865 },	1002 },

866 "resources": {	1003 "resources": {

867 "studentSubmissions": {	1004 "studentSubmissions": {

868 "methods": {	1005 "methods": {

869 "get": {	1006 "modifyAttachments": {

870 "description": "Returns a student submission . * `PERMISSION_DENIED` if the requesting user is not permitted to access the re quested course, course work, or student submission or for access errors. * `INVA LID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course , course work, or student submission does not exist.",	1007 "description": "Modifies attachments of stud ent submission.\n\nAttachments may only be added to student submissions belongin g to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request mus t be made by the Developer Console project of the\n[OAuth client ID](https://sup port.google.com/cloud/answer/6158849) used to\ncreate the corresponding course w ork item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DEN IED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requeste d student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the reques t is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",

871 "httpMethod": "GET",	1008 "httpMethod": "POST",

872 "id": "classroom.courses.courseWork.studentS ubmissions.get",	1009 "id": "classroom.courses.courseWork.studentS ubmissions.modifyAttachments",

873 "parameterOrder": [	1010 "parameterOrder": [

874 "courseId",	1011 "courseId",

875 "courseWorkId",	1012 "courseWorkId",

876 "id"	1013 "id"

877 ],	1014 ],

878 "parameters": {	1015 "parameters": {

879 "courseId": {	1016 "courseId": {

880 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",	1017 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

881 "location": "path",	1018 "location": "path",

882 "required": true,	1019 "required": true,

883 "type": "string"	1020 "type": "string"

884 },	1021 },

885 "courseWorkId": {	1022 "courseWorkId": {

886 "description": "Identifier of the co urse work.",	1023 "description": "Identifier of the co urse work.",

887 "location": "path",	1024 "location": "path",

888 "required": true,	1025 "required": true,

889 "type": "string"	1026 "type": "string"

890 },	1027 },

891 "id": {	1028 "id": {

892 "description": "Identifier of the st udent submission.",	1029 "description": "Identifier of the st udent submission.",

893 "location": "path",	1030 "location": "path",

894 "required": true,	1031 "required": true,

895 "type": "string"	1032 "type": "string"

896 }	1033 }

897 },	1034 },

898 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}",	1035 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:modifyAttachments",

	1036 "request": {

	1037 "$ref": "ModifyAttachmentsRequest"

	1038 },

899 "response": {	1039 "response": {

900 "$ref": "StudentSubmission"	1040 "$ref": "StudentSubmission"

901 },	1041 },

902 "scopes": [	1042 "scopes": [

903 "https://www.googleapis.com/auth/classro om.coursework.me",	1043 "https://www.googleapis.com/auth/classro om.coursework.me",

904 "https://www.googleapis.com/auth/classro om.coursework.me.readonly",	1044 "https://www.googleapis.com/auth/classro om.coursework.students"

905 "https://www.googleapis.com/auth/classro om.coursework.students",

906 "https://www.googleapis.com/auth/classro om.coursework.students.readonly",

907 "https://www.googleapis.com/auth/classro om.student-submissions.me.readonly",

908 "https://www.googleapis.com/auth/classro om.student-submissions.students.readonly"

909 ]	1045 ]

910 },	1046 },

911 "patch": {	1047 "reclaim": {

912 "description": "Updates one or more fields o f a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google .com/cloud/answer/6158849) used to create the corresponding course work item. Th is method returns the following error codes: * `PERMISSION_DENIED` if the reques ting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_F OUND` if the requested course, course work, or student submission does not exist .",	1048 "description": "Reclaims a student submissio n on behalf of the student that owns it.\n\nReclaiming a student submission tran sfers ownership of attached Drive\nfiles to the student and update the submissio n state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThi s request must be made by the Developer Console project of the\n[OAuth client ID ](https://support.google.com/cloud/answer/6158849) used to\ncreate the correspon ding course work item.\n\nThis method returns the following error codes:\n\n* `P ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest ed course or course work, unsubmit the requested student submission,\nor for acc ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",

913 "httpMethod": "PATCH",	1049 "httpMethod": "POST",

914 "id": "classroom.courses.courseWork.studentS ubmissions.patch",	1050 "id": "classroom.courses.courseWork.studentS ubmissions.reclaim",

915 "parameterOrder": [	1051 "parameterOrder": [

916 "courseId",	1052 "courseId",

917 "courseWorkId",	1053 "courseWorkId",

918 "id"	1054 "id"

919 ],	1055 ],

920 "parameters": {	1056 "parameters": {

921 "courseId": {	1057 "courseId": {

922 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",	1058 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

923 "location": "path",	1059 "location": "path",

924 "required": true,	1060 "required": true,

925 "type": "string"	1061 "type": "string"

926 },	1062 },

927 "courseWorkId": {	1063 "courseWorkId": {

928 "description": "Identifier of the co urse work.",	1064 "description": "Identifier of the co urse work.",

929 "location": "path",	1065 "location": "path",

930 "required": true,	1066 "required": true,

931 "type": "string"	1067 "type": "string"

932 },	1068 },

933 "id": {	1069 "id": {

934 "description": "Identifier of the st udent submission.",	1070 "description": "Identifier of the st udent submission.",

935 "location": "path",	1071 "location": "path",

936 "required": true,	1072 "required": true,

937 "type": "string"	1073 "type": "string"

	1074 }

	1075 },

	1076 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:reclaim",

	1077 "request": {

	1078 "$ref": "ReclaimStudentSubmissionRequest "

	1079 },

	1080 "response": {

	1081 "$ref": "Empty"

	1082 },

	1083 "scopes": [

	1084 "https://www.googleapis.com/auth/classro om.coursework.me"

	1085 ]

	1086 },

	1087 "turnIn": {

	1088 "description": "Turns in a student submissio n.\n\nTurning in a student submission transfers ownership of attached Drive\nfil es to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis reque st must be made by the Developer Console project of the\n[OAuth client ID](https ://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI ON_DENIED` if the requesting user is not permitted to access the\nrequested cour se or course work, turn in the requested student submission,\nor for access erro rs.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the req uested course, course work, or student submission\ndoes not exist.",

	1089 "httpMethod": "POST",

	1090 "id": "classroom.courses.courseWork.studentS ubmissions.turnIn",

	1091 "parameterOrder": [

	1092 "courseId",

	1093 "courseWorkId",

	1094 "id"

	1095 ],

	1096 "parameters": {

	1097 "courseId": {

	1098 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

	1099 "location": "path",

	1100 "required": true,

	1101 "type": "string"

938 },	1102 },

939 "updateMask": {	1103 "courseWorkId": {

940 "description": "Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following field s may be specified by teachers: * `draft_grade` * `assigned_grade`",	1104 "description": "Identifier of the co urse work.",

941 "location": "query",	1105 "location": "path",

	1106 "required": true,

	1107 "type": "string"

	1108 },

	1109 "id": {

	1110 "description": "Identifier of the st udent submission.",

	1111 "location": "path",

	1112 "required": true,

942 "type": "string"	1113 "type": "string"

943 }	1114 }

944 },	1115 },

945 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}",	1116 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:turnIn",

946 "request": {	1117 "request": {

947 "$ref": "StudentSubmission"	1118 "$ref": "TurnInStudentSubmissionRequest"

948 },	1119 },

949 "response": {	1120 "response": {

950 "$ref": "StudentSubmission"	1121 "$ref": "Empty"

951 },	1122 },

952 "scopes": [	1123 "scopes": [

953 "https://www.googleapis.com/auth/classro om.coursework.me",	1124 "https://www.googleapis.com/auth/classro om.coursework.me"

954 "https://www.googleapis.com/auth/classro om.coursework.students"

955 ]	1125 ]

956 },	1126 },

957 "list": {	1127 "list": {

958 "description": "Returns a list of student su bmissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submis sions. This method returns the following error codes: * `PERMISSION_DENIED` if t he requesting user is not permitted to access the requested course or course wor k, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NO T_FOUND` if the requested course does not exist.",	1128 "description": "Returns a list of student su bmissions that the requester is permitted to\nview, factoring in the OAuth scope s of the request.\n`-` may be specified as the `course_work_id` to include stude nt\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION _DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is m alformed.\n* `NOT_FOUND` if the requested course does not exist.",

959 "httpMethod": "GET",	1129 "httpMethod": "GET",

960 "id": "classroom.courses.courseWork.studentS ubmissions.list",	1130 "id": "classroom.courses.courseWork.studentS ubmissions.list",

961 "parameterOrder": [	1131 "parameterOrder": [

962 "courseId",	1132 "courseId",

963 "courseWorkId"	1133 "courseWorkId"

964 ],	1134 ],

965 "parameters": {	1135 "parameters": {

966 "courseId": {

967 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",

968 "location": "path",

969 "required": true,

970 "type": "string"

971 },

972 "courseWorkId": {

973 "description": "Identifer of the stu dent work to request. This may be set to the string literal `\"-\"` to request s tudent work for all course work in the specified course.",

974 "location": "path",

975 "required": true,

976 "type": "string"

977 },

978 "userId": {

979 "description": "Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifie r for the user * the email address of the user * the string literal `\"me\"`, in dicating the requesting user",

980 "location": "query",

981 "type": "string"

982 },

983 "states": {	1136 "states": {

984 "description": "Requested submission states. If specified, returned student submissions match one of the specified s ubmission states.",	1137 "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",

985 "enum": [	1138 "enum": [

986 "SUBMISSION_STATE_UNSPECIFIED",	1139 "SUBMISSION_STATE_UNSPECIFIED",

987 "NEW",	1140 "NEW",

988 "CREATED",	1141 "CREATED",

989 "TURNED_IN",	1142 "TURNED_IN",

990 "RETURNED",	1143 "RETURNED",

991 "RECLAIMED_BY_STUDENT"	1144 "RECLAIMED_BY_STUDENT"

992 ],	1145 ],

993 "location": "query",	1146 "location": "query",

994 "repeated": true,	1147 "repeated": true,

995 "type": "string"	1148 "type": "string"

996 },	1149 },

	1150 "userId": {

	1151 "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specifie d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden tifier for the user\n* the email address of the user\n* the string literal `\"me \"`, indicating the requesting user",

	1152 "location": "query",

	1153 "type": "string"

	1154 },

	1155 "pageSize": {

	1156 "description": "Maximum number of it ems to return. Zero or unspecified indicates that the\nserver may assign a maxim um.\n\nThe server may return fewer than the specified number of results.",

	1157 "format": "int32",

	1158 "location": "query",

	1159 "type": "integer"

	1160 },

	1161 "courseId": {

	1162 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

	1163 "location": "path",

	1164 "required": true,

	1165 "type": "string"

	1166 },

997 "late": {	1167 "late": {

998 "description": "Requested lateness v alue. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.",	1168 "description": "Requested lateness v alue. If specified, returned student submissions are\nrestricted by the requeste d value.\nIf unspecified, submissions are returned regardless of `late` value.",

999 "enum": [	1169 "enum": [

1000 "LATE_VALUES_UNSPECIFIED",	1170 "LATE_VALUES_UNSPECIFIED",

1001 "LATE_ONLY",	1171 "LATE_ONLY",

1002 "NOT_LATE_ONLY"	1172 "NOT_LATE_ONLY"

1003 ],	1173 ],

1004 "location": "query",	1174 "location": "query",

1005 "type": "string"	1175 "type": "string"

1006 },	1176 },

1007 "pageSize": {	1177 "courseWorkId": {

1008 "description": "Maximum number of it ems to return. Zero or unspecified indicates that the server may assign a maximu m. The server may return fewer than the specified number of results.",	1178 "description": "Identifer of the stu dent work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",

1009 "format": "int32",	1179 "location": "path",

1010 "location": "query",	1180 "required": true,

1011 "type": "integer"	1181 "type": "string"

1012 },	1182 },

1013 "pageToken": {	1183 "pageToken": {

1014 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of resul ts should be returned. The list request must be otherwise identical to the one t hat resulted in this token.",	1184 "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of re sults should be returned.\n\nThe list request\nmust be otherwise identical to th e one that resulted in this token.",

1015 "location": "query",	1185 "location": "query",

1016 "type": "string"	1186 "type": "string"

1017 }	1187 }

1018 },	1188 },

1019 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions",	1189 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions",

1020 "response": {	1190 "response": {

1021 "$ref": "ListStudentSubmissionsResponse"	1191 "$ref": "ListStudentSubmissionsResponse"

1022 },	1192 },

1023 "scopes": [	1193 "scopes": [

1024 "https://www.googleapis.com/auth/classro om.coursework.me",	1194 "https://www.googleapis.com/auth/classro om.coursework.me",

1025 "https://www.googleapis.com/auth/classro om.coursework.me.readonly",	1195 "https://www.googleapis.com/auth/classro om.coursework.me.readonly",

1026 "https://www.googleapis.com/auth/classro om.coursework.students",	1196 "https://www.googleapis.com/auth/classro om.coursework.students",

1027 "https://www.googleapis.com/auth/classro om.coursework.students.readonly",	1197 "https://www.googleapis.com/auth/classro om.coursework.students.readonly",

1028 "https://www.googleapis.com/auth/classro om.student-submissions.me.readonly",	1198 "https://www.googleapis.com/auth/classro om.student-submissions.me.readonly",

1029 "https://www.googleapis.com/auth/classro om.student-submissions.students.readonly"	1199 "https://www.googleapis.com/auth/classro om.student-submissions.students.readonly"

1030 ]	1200 ]

1031 },	1201 },

1032 "turnIn": {	1202 "get": {

1033 "description": "Turns in a student submissio n. Turning in a student submission transfers ownership of attached Drive files t o the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.g oogle.com/cloud/answer/6158849) used to create the corresponding course work ite m. This method returns the following error codes: * `PERMISSION_DENIED` if the r equesting user is not permitted to access the requested course or course work, t urn in the requested student submission, or for access errors. * `INVALID_ARGUME NT` if the request is malformed. * `NOT_FOUND` if the requested course, course w ork, or student submission does not exist.",	1203 "description": "Returns a student submission .\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the \nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",

1034 "httpMethod": "POST",	1204 "httpMethod": "GET",

1035 "id": "classroom.courses.courseWork.studentS ubmissions.turnIn",	1205 "id": "classroom.courses.courseWork.studentS ubmissions.get",

1036 "parameterOrder": [	1206 "parameterOrder": [

1037 "courseId",	1207 "courseId",

1038 "courseWorkId",	1208 "courseWorkId",

1039 "id"

1040 ],

1041 "parameters": {

1042 "courseId": {

1043 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",

1044 "location": "path",

1045 "required": true,

1046 "type": "string"

1047 },

1048 "courseWorkId": {

1049 "description": "Identifier of the co urse work.",

1050 "location": "path",

1051 "required": true,

1052 "type": "string"

1053 },

1054 "id": {

1055 "description": "Identifier of the st udent submission.",

1056 "location": "path",

1057 "required": true,

1058 "type": "string"

1059 }

1060 },

1061 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:turnIn",

1062 "request": {

1063 "$ref": "TurnInStudentSubmissionRequest"

1064 },

1065 "response": {

1066 "$ref": "Empty"

1067 },

1068 "scopes": [

1069 "https://www.googleapis.com/auth/classro om.coursework.me"

1070 ]

1071 },

1072 "reclaim": {

1073 "description": "Reclaims a student submissio n on behalf of the student that owns it. Reclaiming a student submission transfe rs ownership of attached Drive files to the student and update the submission st ate. Only the student that owns the requested student submission may call this m ethod, and only for a student submission that has been turned in. This request m ust be made by the Developer Console project of the [OAuth client ID](https://su pport.google.com/cloud/answer/6158849) used to create the corresponding course w ork item. This method returns the following error codes: * `PERMISSION_DENIED` i f the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED _PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGU MENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",

1074 "httpMethod": "POST",

1075 "id": "classroom.courses.courseWork.studentS ubmissions.reclaim",

1076 "parameterOrder": [

1077 "courseId",

1078 "courseWorkId",

1079 "id"	1209 "id"

1080 ],	1210 ],

1081 "parameters": {	1211 "parameters": {

1082 "courseId": {	1212 "courseId": {

1083 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",	1213 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

1084 "location": "path",	1214 "location": "path",

1085 "required": true,	1215 "required": true,

1086 "type": "string"	1216 "type": "string"

1087 },	1217 },

1088 "courseWorkId": {	1218 "courseWorkId": {

1089 "description": "Identifier of the co urse work.",	1219 "description": "Identifier of the co urse work.",

1090 "location": "path",	1220 "location": "path",

1091 "required": true,	1221 "required": true,

1092 "type": "string"	1222 "type": "string"

1093 },	1223 },

1094 "id": {	1224 "id": {

1095 "description": "Identifier of the st udent submission.",	1225 "description": "Identifier of the st udent submission.",

1096 "location": "path",	1226 "location": "path",

1097 "required": true,	1227 "required": true,

1098 "type": "string"	1228 "type": "string"

1099 }	1229 }

1100 },	1230 },

1101 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:reclaim",	1231 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}",

1102 "request": {

1103 "$ref": "ReclaimStudentSubmissionRequest "

1104 },

1105 "response": {	1232 "response": {

1106 "$ref": "Empty"	1233 "$ref": "StudentSubmission"

1107 },	1234 },

1108 "scopes": [	1235 "scopes": [

1109 "https://www.googleapis.com/auth/classro om.coursework.me"	1236 "https://www.googleapis.com/auth/classro om.coursework.me",

	1237 "https://www.googleapis.com/auth/classro om.coursework.me.readonly",

	1238 "https://www.googleapis.com/auth/classro om.coursework.students",

	1239 "https://www.googleapis.com/auth/classro om.coursework.students.readonly",

	1240 "https://www.googleapis.com/auth/classro om.student-submissions.me.readonly",

	1241 "https://www.googleapis.com/auth/classro om.student-submissions.students.readonly"

1110 ]	1242 ]

1111 },	1243 },

1112 "return": {	1244 "return": {

1113 "description": "Returns a student submission . Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom appli cation, returning a student submission does not set assignedGrade to the draftGr ade value. Only a teacher of the course that contains the requested student subm ission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849 ) used to create the corresponding course work item. This method returns the fol lowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitte d to access the requested course or course work, return the requested student su bmission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed . * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",	1245 "description": "Returns a student submission .\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the d raftGrade value.\n\nOnly a teacher of the course that contains the requested stu dent submission\nmay call this method.\n\nThis request must be made by the Devel oper Console project of the\n[OAuth client ID](https://support.google.com/cloud/ answer/6158849) used to\ncreate the corresponding course work item.\n\nThis meth od returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return th e requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, o r student submission\ndoes not exist.",

1114 "httpMethod": "POST",	1246 "httpMethod": "POST",

1115 "id": "classroom.courses.courseWork.studentS ubmissions.return",	1247 "id": "classroom.courses.courseWork.studentS ubmissions.return",

1116 "parameterOrder": [	1248 "parameterOrder": [

1117 "courseId",	1249 "courseId",

1118 "courseWorkId",	1250 "courseWorkId",

1119 "id"	1251 "id"

1120 ],	1252 ],

1121 "parameters": {	1253 "parameters": {

1122 "courseId": {	1254 "courseId": {

1123 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",	1255 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

1124 "location": "path",	1256 "location": "path",

1125 "required": true,	1257 "required": true,

1126 "type": "string"	1258 "type": "string"

1127 },	1259 },

1128 "courseWorkId": {	1260 "courseWorkId": {

1129 "description": "Identifier of the co urse work.",	1261 "description": "Identifier of the co urse work.",

1130 "location": "path",	1262 "location": "path",

1131 "required": true,	1263 "required": true,

1132 "type": "string"	1264 "type": "string"

1133 },	1265 },

1134 "id": {	1266 "id": {

1135 "description": "Identifier of the st udent submission.",	1267 "description": "Identifier of the st udent submission.",

1136 "location": "path",	1268 "location": "path",

1137 "required": true,	1269 "required": true,

1138 "type": "string"	1270 "type": "string"

1139 }	1271 }

1140 },	1272 },

1141 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:return",	1273 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:return",

1142 "request": {	1274 "request": {

1143 "$ref": "ReturnStudentSubmissionRequest"	1275 "$ref": "ReturnStudentSubmissionRequest"

1144 },	1276 },

1145 "response": {	1277 "response": {

1146 "$ref": "Empty"	1278 "$ref": "Empty"

1147 },	1279 },

1148 "scopes": [	1280 "scopes": [

1149 "https://www.googleapis.com/auth/classro om.coursework.students"	1281 "https://www.googleapis.com/auth/classro om.coursework.students"

1150 ]	1282 ]

1151 },	1283 },

1152 "modifyAttachments": {	1284 "patch": {

1153 "description": "Modifies attachments of stud ent submission. Attachments may only be added to student submissions belonging t o course work objects with a `workType` of `ASSIGNMENT`. This request must be ma de by the Developer Console project of the [OAuth client ID](https://support.goo gle.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the req uesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submiss ion, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * ` NOT_FOUND` if the requested course, course work, or student submission does not exist.",	1285 "description": "Updates one or more fields o f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details \nof which fields may be updated and who may change them.\n\nThis request must b e made by the Developer Console project of the\n[OAuth client ID](https://suppor t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED ` if the requesting developer project did not create\nthe corresponding course w ork, if the user is not permitted to make the\nrequested modification to the stu dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi ssion\ndoes not exist.",

1154 "httpMethod": "POST",	1286 "httpMethod": "PATCH",

1155 "id": "classroom.courses.courseWork.studentS ubmissions.modifyAttachments",	1287 "id": "classroom.courses.courseWork.studentS ubmissions.patch",

1156 "parameterOrder": [	1288 "parameterOrder": [

1157 "courseId",	1289 "courseId",

1158 "courseWorkId",	1290 "courseWorkId",

1159 "id"	1291 "id"

1160 ],	1292 ],

1161 "parameters": {	1293 "parameters": {

1162 "courseId": {	1294 "courseId": {

1163 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",	1295 "description": "Identifier of the co urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal ias.",

1164 "location": "path",	1296 "location": "path",

1165 "required": true,	1297 "required": true,

1166 "type": "string"	1298 "type": "string"

1167 },	1299 },

1168 "courseWorkId": {	1300 "courseWorkId": {

1169 "description": "Identifier of the co urse work.",	1301 "description": "Identifier of the co urse work.",

1170 "location": "path",	1302 "location": "path",

1171 "required": true,	1303 "required": true,

1172 "type": "string"	1304 "type": "string"

1173 },	1305 },

	1306 "updateMask": {

	1307 "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",

	1308 "format": "google-fieldmask",

	1309 "location": "query",

	1310 "type": "string"

	1311 },

1174 "id": {	1312 "id": {

1175 "description": "Identifier of the st udent submission.",	1313 "description": "Identifier of the st udent submission.",

1176 "location": "path",	1314 "location": "path",

1177 "required": true,	1315 "required": true,

1178 "type": "string"	1316 "type": "string"

1179 }	1317 }

1180 },	1318 },

1181 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}:modifyAttachments",	1319 "path": "v1/courses/{courseId}/courseWork/{c ourseWorkId}/studentSubmissions/{id}",

1182 "request": {	1320 "request": {

1183 "$ref": "ModifyAttachmentsRequest"	1321 "$ref": "StudentSubmission"

1184 },	1322 },

1185 "response": {	1323 "response": {

1186 "$ref": "StudentSubmission"	1324 "$ref": "StudentSubmission"

1187 },	1325 },

1188 "scopes": [	1326 "scopes": [

1189 "https://www.googleapis.com/auth/classro om.coursework.me",	1327 "https://www.googleapis.com/auth/classro om.coursework.me",

1190 "https://www.googleapis.com/auth/classro om.coursework.students"	1328 "https://www.googleapis.com/auth/classro om.coursework.students"

1191 ]	1329 ]

1192 }	1330 }

1193 }	1331 }

1194 }	1332 }

1195 }	1333 }

1196 }	1334 }

1197 }	1335 }

1198 },	1336 },

1199 "userProfiles": {	1337 "userProfiles": {

1200 "methods": {	1338 "methods": {

1201 "get": {	1339 "get": {

1202 "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not p ermitted to access this user profile, if no profile exists with the requested ID , or for access errors.",	1340 "description": "Returns a user profile.\n\nThis method retur ns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the reque sted ID, or for\naccess errors.",

1203 "httpMethod": "GET",	1341 "httpMethod": "GET",

1204 "id": "classroom.userProfiles.get",	1342 "id": "classroom.userProfiles.get",

1205 "parameterOrder": [	1343 "parameterOrder": [

1206 "userId"	1344 "userId"

1207 ],	1345 ],

1208 "parameters": {	1346 "parameters": {

1209 "userId": {	1347 "userId": {

1210 "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the us er * the email address of the user * the string literal `\"me\"`, indicating the requesting user",	1348 "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for th e user\n* the email address of the user\n* the string literal `\"me\"`, indicati ng the requesting user",

1211 "location": "path",	1349 "location": "path",

1212 "required": true,	1350 "required": true,

1213 "type": "string"	1351 "type": "string"

1214 }	1352 }

1215 },	1353 },

1216 "path": "v1/userProfiles/{userId}",	1354 "path": "v1/userProfiles/{userId}",

1217 "response": {	1355 "response": {

1218 "$ref": "UserProfile"	1356 "$ref": "UserProfile"

1219 },	1357 },

1220 "scopes": [	1358 "scopes": [

1221 "https://www.googleapis.com/auth/classroom.profile.email s",	1359 "https://www.googleapis.com/auth/classroom.profile.email s",

1222 "https://www.googleapis.com/auth/classroom.profile.photo s",	1360 "https://www.googleapis.com/auth/classroom.profile.photo s",

1223 "https://www.googleapis.com/auth/classroom.rosters",	1361 "https://www.googleapis.com/auth/classroom.rosters",

1224 "https://www.googleapis.com/auth/classroom.rosters.reado nly"	1362 "https://www.googleapis.com/auth/classroom.rosters.reado nly"

1225 ]	1363 ]

1226 }	1364 }

1227 },	1365 },

1228 "resources": {	1366 "resources": {

1229 "guardianInvitations": {	1367 "guardians": {

1230 "methods": {	1368 "methods": {

	1369 "get": {

	1370 "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user t hat matches the provided `student_id`\n is visible to the requesting user, if t he requesting user is not\n permitted to view guardian information for the stud ent identified by the\n `student_id`, if guardians are not enabled for the doma in in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `stude nt_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `N OT_FOUND` if the requesting user is permitted to view guardians for\n the reque sted `student_id`, but no `Guardian` record exists for that\n student that matc hes the provided `guardian_id`.",

	1371 "httpMethod": "GET",

	1372 "id": "classroom.userProfiles.guardians.get",

	1373 "parameterOrder": [

	1374 "studentId",

	1375 "guardianId"

	1376 ],

	1377 "parameters": {

	1378 "studentId": {

	1379 "description": "The student whose guardian i s being requested. One of the following:\n\n* the numeric identifier for the use r\n* the email address of the user\n* the string literal `\"me\"`, indicating th e requesting user",

	1380 "location": "path",

	1381 "required": true,

	1382 "type": "string"

	1383 },

	1384 "guardianId": {

	1385 "description": "The `id` field from a `Guard ian`.",

	1386 "location": "path",

	1387 "required": true,

	1388 "type": "string"

	1389 }

	1390 },

	1391 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",

	1392 "response": {

	1393 "$ref": "Guardian"

	1394 }

	1395 },

1231 "list": {	1396 "list": {

1232 "description": "Returns a list of guardian invitatio ns that the requesting user is permitted to view, filtered by the parameters pro vided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view gua rdian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `stud ent_id` is specified, but its format cannot be recognized (it is not an email ad dress, nor a `student_id` from the API, nor the literal string `me`). May also b e returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",	1397 "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the reque st.\n\nTo list guardians for any student that the requesting user may view\nguar dians for, use the literal character `-` for the student ID.\n\nThis method retu rns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is spe cified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user i s not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a \n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`) . May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classr oom has no record of that student.",

1233 "httpMethod": "GET",	1398 "httpMethod": "GET",

1234 "id": "classroom.userProfiles.guardianInvitations.li st",	1399 "id": "classroom.userProfiles.guardians.list",

1235 "parameterOrder": [	1400 "parameterOrder": [

1236 "studentId"	1401 "studentId"

1237 ],	1402 ],

1238 "parameters": {	1403 "parameters": {

	1404 "pageSize": {

	1405 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT he server may return fewer than the specified number of results.",

	1406 "format": "int32",

	1407 "location": "query",

	1408 "type": "integer"

	1409 },

	1410 "invitedEmailAddress": {

	1411 "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian li nk.\nThis filter can only be used by domain administrators.",

	1412 "location": "query",

	1413 "type": "string"

	1414 },

1239 "studentId": {	1415 "studentId": {

1240 "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the follow ing: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\ "-\"`, indicating that results should be returned for all students that the requ esting user is permitted to view guardian invitations.",	1416 "description": "Filter results by the studen t who the guardian is linked to.\nThe identifier can be one of the following:\n\ n* the numeric identifier for the user\n* the email address of the user\n* the s tring literal `\"me\"`, indicating the requesting user\n* the string literal `\" -\"`, indicating that results should be returned for\n all students that the re questing user has access to view.",

1241 "location": "path",	1417 "location": "path",

1242 "required": true,	1418 "required": true,

1243 "type": "string"	1419 "type": "string"

1244 },	1420 },

1245 "invitedEmailAddress": {	1421 "pageToken": {

1246 "description": "If specified, only results w ith the specified `invited_email_address` will be returned.",	1422 "description": "nextPageToken\nvalue returne d from a previous\nlist call,\nindicating that the subsequent page of results sh ould be returned.\n\nThe list request\nmust be otherwise identical to the one th at resulted in this token.",

1247 "location": "query",	1423 "location": "query",

1248 "type": "string"	1424 "type": "string"

1249 },	1425 }

1250 "states": {	1426 },

1251 "description": "If specified, only results w ith the specified `state` values will be returned. Otherwise, results with a `st ate` of `PENDING` will be returned.",	1427 "path": "v1/userProfiles/{studentId}/guardians",

1252 "enum": [	1428 "response": {

1253 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",	1429 "$ref": "ListGuardiansResponse"

1254 "PENDING",	1430 }

1255 "COMPLETE"	1431 },

1256 ],	1432 "delete": {

1257 "location": "query",	1433 "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer b e accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is vis ible to the requesting user, if the requesting user is not\n permitted to manag e guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVAL ID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recogni zed (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FO UND` if the requesting user is permitted to modify guardians for\n the requeste d `student_id`, but no `Guardian` record exists for that\n student with the pro vided `guardian_id`.",

1258 "repeated": true,	1434 "httpMethod": "DELETE",

	1435 "id": "classroom.userProfiles.guardians.delete",

	1436 "parameterOrder": [

	1437 "studentId",

	1438 "guardianId"

	1439 ],

	1440 "parameters": {

	1441 "studentId": {

	1442 "description": "The student whose guardian i s to be deleted. One of the following:\n\n* the numeric identifier for the user\ n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

	1443 "location": "path",

	1444 "required": true,

1259 "type": "string"	1445 "type": "string"

1260 },	1446 },

1261 "pageToken": {	1447 "guardianId": {

1262 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",	1448 "description": "The `id` field from a `Guard ian`.",

1263 "location": "query",	1449 "location": "path",

	1450 "required": true,

1264 "type": "string"	1451 "type": "string"

1265 },

1266 "pageSize": {

1267 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the server may assign a maximum. The s erver may return fewer than the specified number of results.",

1268 "format": "int32",

1269 "location": "query",

1270 "type": "integer"

1271 }	1452 }

1272 },	1453 },

1273 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",	1454 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",

1274 "response": {	1455 "response": {

1275 "$ref": "ListGuardianInvitationsResponse"	1456 "$ref": "Empty"

1276 }	1457 }

1277 },	1458 }

	1459 }

	1460 },

	1461 "guardianInvitations": {

	1462 "methods": {

1278 "get": {	1463 "get": {

1279 "description": "Returns a specific guardian invitati on. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student id entified by the `student_id`, if guardians are not enabled for the domain in que stion, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is spe cified, but its format cannot be recognized (it is not an email address, nor a ` student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classro om cannot find any record of the given student or `invitation_id`. May also be r eturned if the student exists, but the requesting user does not have access to s ee that student.",	1464 "description": "Returns a specific guardian invitati on.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i f the requesting user is not permitted to view\n guardian invitations for the s tudent identified by the `student_id`, if\n guardians are not enabled for the d omain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `st udent_id` is specified, but its format cannot\n be recognized (it is not an ema il address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `inv itation_id`. May also be returned if the student exists, but the\n requesting u ser does not have access to see that student.",

1280 "httpMethod": "GET",	1465 "httpMethod": "GET",

1281 "id": "classroom.userProfiles.guardianInvitations.ge t",	1466 "id": "classroom.userProfiles.guardianInvitations.ge t",

1282 "parameterOrder": [	1467 "parameterOrder": [

1283 "studentId",	1468 "studentId",

1284 "invitationId"	1469 "invitationId"

1285 ],	1470 ],

1286 "parameters": {	1471 "parameters": {

	1472 "invitationId": {

	1473 "description": "The `id` field of the `Guard ianInvitation` being requested.",

	1474 "location": "path",

	1475 "required": true,

	1476 "type": "string"

	1477 },

1287 "studentId": {	1478 "studentId": {

1288 "description": "The ID of the student whose guardian invitation is being requested.",	1479 "description": "The ID of the student whose guardian invitation is being requested.",

1289 "location": "path",	1480 "location": "path",

1290 "required": true,	1481 "required": true,

1291 "type": "string"	1482 "type": "string"

1292 },

1293 "invitationId": {

1294 "description": "The `id` field of the `Guard ianInvitation` being requested.",

1295 "location": "path",

1296 "required": true,

1297 "type": "string"

1298 }	1483 }

1299 },	1484 },

1300 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",	1485 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",

1301 "response": {	1486 "response": {

1302 "$ref": "GuardianInvitation"	1487 "$ref": "GuardianInvitation"

1303 }	1488 }

1304 },	1489 },

1305 "create": {	1490 "create": {

1306 "description": "Creates a guardian invitation, and s ends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change t o `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request obj ect must have the `student_id` and `invited_email_address` fields set. Failing t o set these fields, or setting any other fields in the request, will result in a n error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardian s are not enabled for the domain in question, or for other access errors. * `RES OURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit . * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recogn ized (it is not an email address, nor a `user_id` from this API). This error wil l also be returned if read-only fields are set, or if the `state` field is set t o to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXIST S` if there is already a pending guardian invitation for the student and `invite d_email_address` provided, or if the provided `invited_email_address` matches th e Google account of an existing `Guardian` for this user.",	1491 "description": "Creates a guardian invitation, and s ends an email to the guardian asking\nthem to confirm that they are the student' s guardian.\n\nOnce the guardian accepts the invitation, their `state` will chan ge to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Gua rdian` resource will also be created to represent the active guardian.\n\nThe re quest object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERM ISSION_DENIED` if the current user does not have permission to\n manage guardia ns, if the guardian in question has already rejected\n too many requests for th at student, if guardians are not enabled for the\n domain in question, or for o ther access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has excee ded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email addr ess is not valid (for\n example, if it is too long), or if the format of the st udent ID provided\n cannot be recognized (it is not an email address, nor a `us er_id` from\n this API). This error will also be returned if read-only fields a re set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an exi sting\n `Guardian` for this user.",

1307 "httpMethod": "POST",	1492 "httpMethod": "POST",

1308 "id": "classroom.userProfiles.guardianInvitations.cr eate",	1493 "id": "classroom.userProfiles.guardianInvitations.cr eate",

1309 "parameterOrder": [	1494 "parameterOrder": [

1310 "studentId"	1495 "studentId"

1311 ],	1496 ],

1312 "parameters": {	1497 "parameters": {

1313 "studentId": {	1498 "studentId": {

1314 "description": "ID of the student (in standa rd format)",	1499 "description": "ID of the student (in standa rd format)",

1315 "location": "path",	1500 "location": "path",

1316 "required": true,	1501 "required": true,

1317 "type": "string"	1502 "type": "string"

1318 }	1503 }

1319 },	1504 },

1320 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",	1505 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",

1321 "request": {	1506 "request": {

1322 "$ref": "GuardianInvitation"	1507 "$ref": "GuardianInvitation"

1323 },	1508 },

1324 "response": {	1509 "response": {

1325 "$ref": "GuardianInvitation"	1510 "$ref": "GuardianInvitation"

1326 }	1511 }

1327 },	1512 },

	1513 "list": {

	1514 "description": "Returns a list of guardian invitatio ns that the requesting user is\npermitted to view, filtered by the parameters pr ovided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIE D` if a `student_id` is specified, and the requesting\n user is not permitted t o view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the litera l string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\ n recognized, but Classroom has no record of that student.",

	1515 "httpMethod": "GET",

	1516 "id": "classroom.userProfiles.guardianInvitations.li st",

	1517 "parameterOrder": [

	1518 "studentId"

	1519 ],

	1520 "parameters": {

	1521 "pageSize": {

	1522 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT he server may return fewer than the specified number of results.",

	1523 "format": "int32",

	1524 "location": "query",

	1525 "type": "integer"

	1526 },

	1527 "invitedEmailAddress": {

	1528 "description": "If specified, only results w ith the specified `invited_email_address`\nwill be returned.",

	1529 "location": "query",

	1530 "type": "string"

	1531 },

	1532 "states": {

	1533 "description": "If specified, only results w ith the specified `state` values will be\nreturned. Otherwise, results with a `s tate` of `PENDING` will be returned.",

	1534 "enum": [

	1535 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",

	1536 "PENDING",

	1537 "COMPLETE"

	1538 ],

	1539 "location": "query",

	1540 "repeated": true,

	1541 "type": "string"

	1542 },

	1543 "studentId": {

	1544 "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the follo wing:\n\n* the numeric identifier for the user\n* the email address of the user\ n* the string literal `\"me\"`, indicating the requesting user\n* the string lit eral `\"-\"`, indicating that results should be returned for\n all students tha t the requesting user is permitted to view guardian\n invitations.",

	1545 "location": "path",

	1546 "required": true,

	1547 "type": "string"

	1548 },

	1549 "pageToken": {

	1550 "description": "nextPageToken\nvalue returne d from a previous\nlist call,\nindicating that the subsequent page of results sh ould be returned.\n\nThe list request\nmust be otherwise identical to the one th at resulted in this token.",

	1551 "location": "query",

	1552 "type": "string"

	1553 }

	1554 },

	1555 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",

	1556 "response": {

	1557 "$ref": "ListGuardianInvitationsResponse"

	1558 }

	1559 },

1328 "patch": {	1560 "patch": {

1329 "description": "Modifies a guardian invitation. Curr ently, the only valid modification is to change the `state` from `PENDING` to `C OMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not h ave permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the st udent ID provided cannot be recognized (it is not an email address, nor a `user_ id` from this API), or if the passed `GuardianInvitation` has a `state` other th an `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to C lassroom.",	1561 "description": "Modifies a guardian invitation.\n\nC urrently, the only valid modification is to change the `state` from\n`PENDING` t o `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled fo r the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if th e format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation ` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `s tate`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n C lassroom has no record of that student, or if the `id` field does not\n refer t o a guardian invitation known to Classroom.",

1330 "httpMethod": "PATCH",	1562 "httpMethod": "PATCH",

1331 "id": "classroom.userProfiles.guardianInvitations.pa tch",	1563 "id": "classroom.userProfiles.guardianInvitations.pa tch",

1332 "parameterOrder": [	1564 "parameterOrder": [

1333 "studentId",	1565 "studentId",

1334 "invitationId"	1566 "invitationId"

1335 ],	1567 ],

1336 "parameters": {	1568 "parameters": {

	1569 "invitationId": {

	1570 "description": "The `id` field of the `Guard ianInvitation` to be modified.",

	1571 "location": "path",

	1572 "required": true,

	1573 "type": "string"

	1574 },

	1575 "updateMask": {

	1576 "description": "Mask that identifies which f ields on the course to update.\nThis field is required to do an update. The upda te will fail if invalid\nfields are specified. The following fields are valid:\n \n* `state`\n\nWhen set in a query parameter, this field should be specified as\ n\n`updateMask=<field1>,<field2>,...`",

	1577 "format": "google-fieldmask",

	1578 "location": "query",

	1579 "type": "string"

	1580 },

1337 "studentId": {	1581 "studentId": {

1338 "description": "The ID of the student whose guardian invitation is to be modified.",	1582 "description": "The ID of the student whose guardian invitation is to be modified.",

1339 "location": "path",	1583 "location": "path",

1340 "required": true,	1584 "required": true,

1341 "type": "string"	1585 "type": "string"

1342 },

1343 "invitationId": {

1344 "description": "The `id` field of the `Guard ianInvitation` to be modified.",

1345 "location": "path",

1346 "required": true,

1347 "type": "string"

1348 },

1349 "updateMask": {

1350 "description": "Mask that identifies which f ields on the course to update. This field is required to do an update. The updat e will fail if invalid fields are specified. The following fields are valid: * ` state` When set in a query parameter, this field should be specified as `updateM ask=,,...`",

1351 "location": "query",

1352 "type": "string"

1353 }	1586 }

1354 },	1587 },

1355 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",	1588 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",

1356 "request": {	1589 "request": {

1357 "$ref": "GuardianInvitation"	1590 "$ref": "GuardianInvitation"

1358 },	1591 },

1359 "response": {	1592 "response": {

1360 "$ref": "GuardianInvitation"	1593 "$ref": "GuardianInvitation"

1361 }	1594 }

1362 }	1595 }

1363 }	1596 }

1364 },

1365 "guardians": {

1366 "methods": {

1367 "list": {

1368 "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the reques t. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that stud ent, if `\"-\"` is specified as the `student_id` and the user is not a domain ad ministrator, if guardians are not enabled for the domain in question, if the `in vited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student _id` from the API, nor the literal string `me`). May also be returned if an inva lid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",

1369 "httpMethod": "GET",

1370 "id": "classroom.userProfiles.guardians.list",

1371 "parameterOrder": [

1372 "studentId"

1373 ],

1374 "parameters": {

1375 "studentId": {

1376 "description": "Filter results by the studen t who the guardian is linked to. The identifier can be one of the following: * t he numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, i ndicating that results should be returned for all students that the requesting u ser has access to view.",

1377 "location": "path",

1378 "required": true,

1379 "type": "string"

1380 },

1381 "invitedEmailAddress": {

1382 "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian lin k. This filter can only be used by domain administrators.",

1383 "location": "query",

1384 "type": "string"

1385 },

1386 "pageToken": {

1387 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",

1388 "location": "query",

1389 "type": "string"

1390 },

1391 "pageSize": {

1392 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the server may assign a maximum. The s erver may return fewer than the specified number of results.",

1393 "format": "int32",

1394 "location": "query",

1395 "type": "integer"

1396 }

1397 },

1398 "path": "v1/userProfiles/{studentId}/guardians",

1399 "response": {

1400 "$ref": "ListGuardiansResponse"

1401 }

1402 },

1403 "get": {

1404 "description": "Returns a specific guardian. This me thod returns the following error codes: * `PERMISSION_DENIED` if no user that ma tches the provided `student_id` is visible to the requesting user, if the reques ting user is not permitted to view guardian information for the student identifi ed by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified , but its format cannot be recognized (it is not an email address, nor a `studen t_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requestin g user is permitted to view guardians for the requested `student_id`, but no `Gu ardian` record exists for that student that matches the provided `guardian_id`." ,

1405 "httpMethod": "GET",

1406 "id": "classroom.userProfiles.guardians.get",

1407 "parameterOrder": [

1408 "studentId",

1409 "guardianId"

1410 ],

1411 "parameters": {

1412 "studentId": {

1413 "description": "The student whose guardian i s being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the req uesting user",

1414 "location": "path",

1415 "required": true,

1416 "type": "string"

1417 },

1418 "guardianId": {

1419 "description": "The `id` field from a `Guard ian`.",

1420 "location": "path",

1421 "required": true,

1422 "type": "string"

1423 }

1424 },

1425 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",

1426 "response": {

1427 "$ref": "Guardian"

1428 }

1429 },

1430 "delete": {

1431 "description": "Deletes a guardian. The guardian wil l no longer receive guardian notifications and the guardian will no longer be ac cessible via the API. This method returns the following error codes: * `PERMISSI ON_DENIED` if no user that matches the provided `student_id` is visible to the r equesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `stud ent_id` is specified, but its format cannot be recognized (it is not an email ad dress, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.",

1432 "httpMethod": "DELETE",

1433 "id": "classroom.userProfiles.guardians.delete",

1434 "parameterOrder": [

1435 "studentId",

1436 "guardianId"

1437 ],

1438 "parameters": {

1439 "studentId": {

1440 "description": "The student whose guardian i s to be deleted. One of the following: * the numeric identifier for the user * t he email address of the user * the string literal `\"me\"`, indicating the reque sting user",

1441 "location": "path",

1442 "required": true,

1443 "type": "string"

1444 },

1445 "guardianId": {

1446 "description": "The `id` field from a `Guard ian`.",

1447 "location": "path",

1448 "required": true,

1449 "type": "string"

1450 }

1451 },

1452 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",

1453 "response": {

1454 "$ref": "Empty"

1455 }

1456 }

1457 }

1458 }

1459 }

1460 },

1461 "invitations": {

1462 "methods": {

1463 "create": {

1464 "description": "Creates an invitation. Only one invitation f or a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIE D` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the use r already has this role or a role with greater permissions. * `ALREADY_EXISTS` i f an invitation for the specified user and course already exists.",

1465 "httpMethod": "POST",

1466 "id": "classroom.invitations.create",

1467 "path": "v1/invitations",

1468 "request": {

1469 "$ref": "Invitation"

1470 },

1471 "response": {

1472 "$ref": "Invitation"

1473 },

1474 "scopes": [

1475 "https://www.googleapis.com/auth/classroom.rosters"

1476 ]

1477 },

1478 "get": {

1479 "description": "Returns an invitation. This method returns t he following error codes: * `PERMISSION_DENIED` if the requesting user is not pe rmitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",

1480 "httpMethod": "GET",

1481 "id": "classroom.invitations.get",

1482 "parameterOrder": [

1483 "id"

1484 ],

1485 "parameters": {

1486 "id": {

1487 "description": "Identifier of the invitation to retu rn.",

1488 "location": "path",

1489 "required": true,

1490 "type": "string"

1491 }

1492 },

1493 "path": "v1/invitations/{id}",

1494 "response": {

1495 "$ref": "Invitation"

1496 },

1497 "scopes": [

1498 "https://www.googleapis.com/auth/classroom.rosters",

1499 "https://www.googleapis.com/auth/classroom.rosters.reado nly"

1500 ]

1501 },

1502 "delete": {

1503 "description": "Deletes an invitation. This method returns t he following error codes: * `PERMISSION_DENIED` if the requesting user is not pe rmitted to delete the requested invitation or for access errors. * `NOT_FOUND` i f no invitation exists with the requested ID.",

1504 "httpMethod": "DELETE",

1505 "id": "classroom.invitations.delete",

1506 "parameterOrder": [

1507 "id"

1508 ],

1509 "parameters": {

1510 "id": {

1511 "description": "Identifier of the invitation to dele te.",

1512 "location": "path",

1513 "required": true,

1514 "type": "string"

1515 }

1516 },

1517 "path": "v1/invitations/{id}",

1518 "response": {

1519 "$ref": "Empty"

1520 },

1521 "scopes": [

1522 "https://www.googleapis.com/auth/classroom.rosters"

1523 ]

1524 },

1525 "list": {

1526 "description": "Returns a list of invitations that the reque sting user is permitted to view, restricted to those that match the list request . Note: At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_D ENIED` for access errors.",

1527 "httpMethod": "GET",

1528 "id": "classroom.invitations.list",

1529 "parameters": {

1530 "userId": {

1531 "description": "Restricts returned invitations to th ose for a specific user. The identifier can be one of the following: * the numer ic identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",

1532 "location": "query",

1533 "type": "string"

1534 },

1535 "courseId": {

1536 "description": "Restricts returned invitations to th ose for a course with the specified identifier.",

1537 "location": "query",

1538 "type": "string"

1539 },

1540 "pageSize": {

1541 "description": "Maximum number of items to return. Z ero means no maximum. The server may return fewer than the specified number of r esults.",

1542 "format": "int32",

1543 "location": "query",

1544 "type": "integer"

1545 },

1546 "pageToken": {

1547 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be ret urned. The list request must be otherwise identical to the one that resulted in this token.",

1548 "location": "query",

1549 "type": "string"

1550 }

1551 },

1552 "path": "v1/invitations",

1553 "response": {

1554 "$ref": "ListInvitationsResponse"

1555 },

1556 "scopes": [

1557 "https://www.googleapis.com/auth/classroom.rosters",

1558 "https://www.googleapis.com/auth/classroom.rosters.reado nly"

1559 ]

1560 },

1561 "accept": {

1562 "description": "Accepts an invitation, removing it and addin g the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not perm itted to accept the requested invitation or for access errors. * `FAILED_PRECOND ITION` for the following request errors: * CourseMemberLimitReached * CourseNotM odifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_ FOUND` if no invitation exists with the requested ID.",

1563 "httpMethod": "POST",

1564 "id": "classroom.invitations.accept",

1565 "parameterOrder": [

1566 "id"

1567 ],

1568 "parameters": {

1569 "id": {

1570 "description": "Identifier of the invitation to acce pt.",

1571 "location": "path",

1572 "required": true,

1573 "type": "string"

1574 }

1575 },

1576 "path": "v1/invitations/{id}:accept",

1577 "response": {

1578 "$ref": "Empty"

1579 },

1580 "scopes": [

1581 "https://www.googleapis.com/auth/classroom.rosters"

1582 ]

1583 }	1597 }

1584 }	1598 }

1585 }	1599 }

1586 },	1600 },

1587 "revision": "20170110",	1601 "revision": "20170321",

1588 "rootUrl": "https://classroom.googleapis.com/",	1602 "rootUrl": "https://classroom.googleapis.com/",

1589 "schemas": {	1603 "schemas": {

1590 "Course": {	1604 "Attachment": {

1591 "description": "A Course in Classroom.",	1605 "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",

1592 "id": "Course",	1606 "id": "Attachment",

1593 "properties": {	1607 "properties": {

1594 "id": {	1608 "driveFile": {

1595 "description": "Identifier for this course assigned by Class room. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assign ed by Classroom and cannot be updated after the course is created. Specifying th is field in a course update mask results in an error.",	1609 "$ref": "DriveFile",

1596 "type": "string"	1610 "description": "Google Drive file attachment."

1597 },	1611 },

1598 "name": {	1612 "youTubeVideo": {

1599 "description": "Name of the course. For example, \"10th Grad e Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.",	1613 "$ref": "YouTubeVideo",

1600 "type": "string"	1614 "description": "Youtube video attachment."

1601 },	1615 },

1602 "section": {	1616 "link": {

1603 "description": "Section of the course. For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 ch aracters.",	1617 "$ref": "Link",

1604 "type": "string"	1618 "description": "Link attachment."

1605 },	1619 },

1606 "descriptionHeading": {	1620 "form": {

1607 "description": "Optional heading for the description. For ex ample, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF -8 string and no longer than 3600 characters.",	1621 "$ref": "Form",

1608 "type": "string"	1622 "description": "Google Forms attachment."

1609 },	1623 }

1610 "description": {	1624 },

1611 "description": "Optional description. For example, \"We'll b e learning about the structure of living creatures from a combination of textboo ks, guest lectures, and lab work. Expect to be excited!\" If set, this field mus t be a valid UTF-8 string and no longer than 30,000 characters.",	1625 "type": "object"

1612 "type": "string"	1626 },

1613 },	1627 "ListGuardianInvitationsResponse": {

1614 "room": {	1628 "description": "Response when listing guardian invitations.",

1615 "description": "Optional room location. For example, \"301\" . If set, this field must be a valid UTF-8 string and no longer than 650 charact ers.",	1629 "id": "ListGuardianInvitationsResponse",

1616 "type": "string"	1630 "properties": {

1617 },	1631 "nextPageToken": {

1618 "ownerId": {	1632 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

1619 "description": "The identifier of the owner of a course. Whe n specified as a parameter of a create course request, this field is required. T he identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the r equesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.",	1633 "type": "string"

1620 "type": "string"	1634 },

1621 },	1635 "guardianInvitations": {

1622 "creationTime": {	1636 "description": "Guardian invitations that matched the list r equest.",

1623 "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.",

1624 "type": "string"

1625 },

1626 "updateTime": {

1627 "description": "Time of the most recent update to this cours e. Specifying this field in a course update mask results in an error. Read-only. ",

1628 "type": "string"

1629 },

1630 "enrollmentCode": {

1631 "description": "Enrollment code to use when joining this cou rse. Specifying this field in a course update mask results in an error. Read-onl y.",

1632 "type": "string"

1633 },

1634 "courseState": {

1635 "description": "State of the course. If unspecified, the def ault state is `PROVISIONED`.",

1636 "enum": [

1637 "COURSE_STATE_UNSPECIFIED",

1638 "ACTIVE",

1639 "ARCHIVED",

1640 "PROVISIONED",

1641 "DECLINED"

1642 ],

1643 "type": "string"

1644 },

1645 "alternateLink": {

1646 "description": "Absolute link to this course in the Classroo m web UI. Read-only.",

1647 "type": "string"

1648 },

1649 "teacherGroupEmail": {

1650 "description": "The email address of a Google group containi ng all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.",

1651 "type": "string"

1652 },

1653 "courseGroupEmail": {

1654 "description": "The email address of a Google group containi ng all members of the course. This group does not accept email and can only be u sed for permissions. Read-only.",

1655 "type": "string"

1656 },

1657 "teacherFolder": {

1658 "$ref": "DriveFolder",

1659 "description": "Information about a Drive Folder that is sha red with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only."

1660 },

1661 "courseMaterialSets": {

1662 "description": "Sets of materials that appear on the \"about \" page of this course. Read-only.",

1663 "items": {	1637 "items": {

1664 "$ref": "CourseMaterialSet"	1638 "$ref": "GuardianInvitation"

1665 },	1639 },

1666 "type": "array"	1640 "type": "array"

1667 },	1641 }

1668 "guardiansEnabled": {	1642 },

1669 "description": "Whether or not guardian notifications are en abled for this course. Read-only.",	1643 "type": "object"

	1644 },

	1645 "CourseWork": {

	1646 "description": "Course work created by a teacher for students of the course.",

	1647 "id": "CourseWork",

	1648 "properties": {

	1649 "id": {

	1650 "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",

	1651 "type": "string"

	1652 },

	1653 "description": {

	1654 "description": "Optional description of this course work.\nI f set, the description must be a valid UTF-8 string containing no more\nthan 30, 000 characters.",

	1655 "type": "string"

	1656 },

	1657 "submissionModificationMode": {

	1658 "description": "Setting to determine when students are allow ed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTI L_TURNED_IN`.",

	1659 "enum": [

	1660 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",

	1661 "MODIFIABLE_UNTIL_TURNED_IN",

	1662 "MODIFIABLE"

	1663 ],

	1664 "enumDescriptions": [

	1665 "No modification mode specified. This is never returned. ",

	1666 "Submisisons can be modified before being turned in.",

	1667 "Submisisons can be modified at any time."

	1668 ],

	1669 "type": "string"

	1670 },

	1671 "associatedWithDeveloper": {

	1672 "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom. Work.CreateCourseWork for more\ndetails.\n\nRead-only.",

1670 "type": "boolean"	1673 "type": "boolean"

1671 }	1674 },

1672 },	1675 "updateTime": {

1673 "type": "object"	1676 "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",

	1677 "format": "google-datetime",

	1678 "type": "string"

	1679 },

	1680 "title": {

	1681 "description": "Title of this course work.\nThe title must b e a valid UTF-8 string containing between 1 and 3000\ncharacters.",

	1682 "type": "string"

	1683 },

	1684 "alternateLink": {

	1685 "description": "Absolute link to this course work in the Cla ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only." ,

	1686 "type": "string"

	1687 },

	1688 "workType": {

	1689 "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",

	1690 "enum": [

	1691 "COURSE_WORK_TYPE_UNSPECIFIED",

	1692 "ASSIGNMENT",

	1693 "SHORT_ANSWER_QUESTION",

	1694 "MULTIPLE_CHOICE_QUESTION"

	1695 ],

	1696 "enumDescriptions": [

	1697 "No work type specified. This is never returned.",

	1698 "An assignment.",

	1699 "A short answer question.",

	1700 "A multiple-choice question."

	1701 ],

	1702 "type": "string"

	1703 },

	1704 "materials": {

	1705 "description": "Additional materials.\n\nCourseWork must hav e no more than 20 material items.",

	1706 "items": {

	1707 "$ref": "Material"

	1708 },

	1709 "type": "array"

	1710 },

	1711 "state": {

	1712 "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",

	1713 "enum": [

	1714 "COURSE_WORK_STATE_UNSPECIFIED",

	1715 "PUBLISHED",

	1716 "DRAFT",

	1717 "DELETED"

	1718 ],

	1719 "enumDescriptions": [

	1720 "No state specified. This is never returned.",

	1721 "Status for work that has been published.\nThis is the d efault state.",

	1722 "Status for work that is not yet published.\nWork in thi s state is visible only to course teachers and domain\nadministrators.",

	1723 "Status for work that was published but is now deleted.\ nWork in this state is visible only to course teachers and domain\nadministrator s.\nWork in this state is deleted after some time."

	1724 ],

	1725 "type": "string"

	1726 },

	1727 "dueDate": {

	1728 "$ref": "Date",

	1729 "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specifie d."

	1730 },

	1731 "multipleChoiceQuestion": {

	1732 "$ref": "MultipleChoiceQuestion",

	1733 "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_Q UESTION`.\nFor write operations, this field must be specified when creating cour se\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\ns et otherwise."

	1734 },

	1735 "creationTime": {

	1736 "description": "Timestamp when this course work was created. \n\nRead-only.",

	1737 "format": "google-datetime",

	1738 "type": "string"

	1739 },

	1740 "courseId": {

	1741 "description": "Identifier of the course.\n\nRead-only.",

	1742 "type": "string"

	1743 },

	1744 "maxPoints": {

	1745 "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-neg ative integer value.",

	1746 "format": "double",

	1747 "type": "number"

	1748 },

	1749 "assignment": {

	1750 "$ref": "Assignment",

	1751 "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."

	1752 },

	1753 "dueTime": {

	1754 "$ref": "TimeOfDay",

	1755 "description": "Optional time of day, in UTC, that submissio ns for this this course work\nare due.\nThis must be specified if `due_date` is specified."

	1756 }

	1757 },

	1758 "type": "object"

	1759 },

	1760 "DriveFile": {

	1761 "description": "Representation of a Google Drive file.",

	1762 "id": "DriveFile",

	1763 "properties": {

	1764 "thumbnailUrl": {

	1765 "description": "URL of a thumbnail image of the Drive item.\ n\nRead-only.",

	1766 "type": "string"

	1767 },

	1768 "title": {

	1769 "description": "Title of the Drive item.\n\nRead-only.",

	1770 "type": "string"

	1771 },

	1772 "alternateLink": {

	1773 "description": "URL that can be used to access the Drive ite m.\n\nRead-only.",

	1774 "type": "string"

	1775 },

	1776 "id": {

	1777 "description": "Drive API resource ID.",

	1778 "type": "string"

	1779 }

	1780 },

	1781 "type": "object"

1674 },	1782 },

1675 "DriveFolder": {	1783 "DriveFolder": {

1676 "description": "Representation of a Google Drive folder.",	1784 "description": "Representation of a Google Drive folder.",

1677 "id": "DriveFolder",	1785 "id": "DriveFolder",

1678 "properties": {	1786 "properties": {

1679 "id": {

1680 "description": "Drive API resource ID.",

1681 "type": "string"

1682 },

1683 "title": {	1787 "title": {

1684 "description": "Title of the Drive folder. Read-only.",	1788 "description": "Title of the Drive folder.\n\nRead-only.",

1685 "type": "string"	1789 "type": "string"

1686 },	1790 },

1687 "alternateLink": {	1791 "alternateLink": {

1688 "description": "URL that can be used to access the Drive fol der. Read-only.",	1792 "description": "URL that can be used to access the Drive fol der.\n\nRead-only.",

	1793 "type": "string"

	1794 },

	1795 "id": {

	1796 "description": "Drive API resource ID.",

1689 "type": "string"	1797 "type": "string"

1690 }	1798 }

1691 },	1799 },

1692 "type": "object"	1800 "type": "object"

1693 },	1801 },

1694 "CourseMaterialSet": {	1802 "ListCourseAliasesResponse": {

1695 "description": "A set of materials that appears on the \"About\" pag e of the course. These materials might include a syllabus, schedule, or other ba ckground information relating to the course as a whole.",	1803 "description": "Response when listing course aliases.",

1696 "id": "CourseMaterialSet",	1804 "id": "ListCourseAliasesResponse",

1697 "properties": {	1805 "properties": {

1698 "title": {	1806 "nextPageToken": {

1699 "description": "Title for this set.",	1807 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

1700 "type": "string"	1808 "type": "string"

1701 },	1809 },

1702 "materials": {	1810 "aliases": {

1703 "description": "Materials attached to this set.",	1811 "description": "The course aliases.",

1704 "items": {	1812 "items": {

1705 "$ref": "CourseMaterial"	1813 "$ref": "CourseAlias"

1706 },	1814 },

1707 "type": "array"	1815 "type": "array"

1708 }	1816 }

1709 },	1817 },

1710 "type": "object"	1818 "type": "object"

1711 },	1819 },

	1820 "ShortAnswerSubmission": {

	1821 "description": "Student work for a short answer question.",

	1822 "id": "ShortAnswerSubmission",

	1823 "properties": {

	1824 "answer": {

	1825 "description": "Student response to a short-answer question. ",

	1826 "type": "string"

	1827 }

	1828 },

	1829 "type": "object"

	1830 },

1712 "CourseMaterial": {	1831 "CourseMaterial": {

1713 "description": "A material attached to a course as part of a materia l set.",	1832 "description": "A material attached to a course as part of a materia l set.",

1714 "id": "CourseMaterial",	1833 "id": "CourseMaterial",

1715 "properties": {	1834 "properties": {

1716 "driveFile": {	1835 "driveFile": {

1717 "$ref": "DriveFile",	1836 "$ref": "DriveFile",

1718 "description": "Google Drive file attachment."	1837 "description": "Google Drive file attachment."

1719 },	1838 },

1720 "youTubeVideo": {	1839 "youTubeVideo": {

1721 "$ref": "YouTubeVideo",	1840 "$ref": "YouTubeVideo",

1722 "description": "Youtube video attachment."	1841 "description": "Youtube video attachment."

1723 },	1842 },

1724 "link": {	1843 "link": {

1725 "$ref": "Link",	1844 "$ref": "Link",

1726 "description": "Link atatchment."	1845 "description": "Link atatchment."

1727 },	1846 },

1728 "form": {	1847 "form": {

1729 "$ref": "Form",	1848 "$ref": "Form",

1730 "description": "Google Forms attachment."	1849 "description": "Google Forms attachment."

1731 }	1850 }

1732 },	1851 },

1733 "type": "object"	1852 "type": "object"

1734 },	1853 },

1735 "DriveFile": {	1854 "MultipleChoiceSubmission": {

1736 "description": "Representation of a Google Drive file.",	1855 "description": "Student work for a multiple-choice question.",

1737 "id": "DriveFile",	1856 "id": "MultipleChoiceSubmission",

1738 "properties": {	1857 "properties": {

1739 "id": {	1858 "answer": {

1740 "description": "Drive API resource ID.",	1859 "description": "Student's select choice.",

1741 "type": "string"

1742 },

1743 "title": {

1744 "description": "Title of the Drive item. Read-only.",

1745 "type": "string"

1746 },

1747 "alternateLink": {

1748 "description": "URL that can be used to access the Drive ite m. Read-only.",

1749 "type": "string"

1750 },

1751 "thumbnailUrl": {

1752 "description": "URL of a thumbnail image of the Drive item. Read-only.",

1753 "type": "string"

1754 }

1755 },

1756 "type": "object"

1757 },

1758 "YouTubeVideo": {

1759 "description": "YouTube video item.",

1760 "id": "YouTubeVideo",

1761 "properties": {

1762 "id": {

1763 "description": "YouTube API resource ID.",

1764 "type": "string"

1765 },

1766 "title": {

1767 "description": "Title of the YouTube video. Read-only.",

1768 "type": "string"

1769 },

1770 "alternateLink": {

1771 "description": "URL that can be used to view the YouTube vid eo. Read-only.",

1772 "type": "string"

1773 },

1774 "thumbnailUrl": {

1775 "description": "URL of a thumbnail image of the YouTube vide o. Read-only.",

1776 "type": "string"	1860 "type": "string"

1777 }	1861 }

1778 },	1862 },

1779 "type": "object"	1863 "type": "object"

1780 },	1864 },

1781 "Link": {	1865 "Link": {

1782 "description": "URL item.",	1866 "description": "URL item.",

1783 "id": "Link",	1867 "id": "Link",

1784 "properties": {	1868 "properties": {

1785 "url": {	1869 "url": {

1786 "description": "URL to link to. This must be a valid UTF-8 s tring containing between 1 and 2024 characters.",	1870 "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",

	1871 "type": "string"

	1872 },

	1873 "thumbnailUrl": {

	1874 "description": "URL of a thumbnail image of the target URL.\ n\nRead-only.",

1787 "type": "string"	1875 "type": "string"

1788 },	1876 },

1789 "title": {	1877 "title": {

1790 "description": "Title of the target of the URL. Read-only.",	1878 "description": "Title of the target of the URL.\n\nRead-only .",

1791 "type": "string"

1792 },

1793 "thumbnailUrl": {

1794 "description": "URL of a thumbnail image of the target URL. Read-only.",

1795 "type": "string"	1879 "type": "string"

1796 }	1880 }

1797 },	1881 },

1798 "type": "object"	1882 "type": "object"

	1883 },

	1884 "ModifyAttachmentsRequest": {

	1885 "description": "Request to modify the attachments of a student submi ssion.",

	1886 "id": "ModifyAttachmentsRequest",

	1887 "properties": {

	1888 "addAttachments": {

	1889 "description": "Attachments to add.\nA student submission ma y not have more than 20 attachments.\n\nForm attachments are not supported.",

	1890 "items": {

	1891 "$ref": "Attachment"

	1892 },

	1893 "type": "array"

	1894 }

	1895 },

	1896 "type": "object"

	1897 },

	1898 "TimeOfDay": {

	1899 "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp `.",

	1900 "id": "TimeOfDay",

	1901 "properties": {

	1902 "nanos": {

	1903 "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",

	1904 "format": "int32",

	1905 "type": "integer"

	1906 },

	1907 "hours": {

	1908 "description": "Hours of day in 24 hour format. Should be fr om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik e business closing time.",

	1909 "format": "int32",

	1910 "type": "integer"

	1911 },

	1912 "minutes": {

	1913 "description": "Minutes of hour of day. Must be from 0 to 59 .",

	1914 "format": "int32",

	1915 "type": "integer"

	1916 },

	1917 "seconds": {

	1918 "description": "Seconds of minutes of the time. Must normall y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",

	1919 "format": "int32",

	1920 "type": "integer"

	1921 }

	1922 },

	1923 "type": "object"

1799 },	1924 },

1800 "Form": {	1925 "Form": {

1801 "description": "Google Forms item.",	1926 "description": "Google Forms item.",

1802 "id": "Form",	1927 "id": "Form",

1803 "properties": {	1928 "properties": {

	1929 "thumbnailUrl": {

	1930 "description": "URL of a thumbnail image of the Form.\n\nRea d-only.",

	1931 "type": "string"

	1932 },

1804 "formUrl": {	1933 "formUrl": {

1805 "description": "URL of the form.",	1934 "description": "URL of the form.",

1806 "type": "string"	1935 "type": "string"

1807 },	1936 },

	1937 "title": {

	1938 "description": "Title of the Form.\n\nRead-only.",

	1939 "type": "string"

	1940 },

1808 "responseUrl": {	1941 "responseUrl": {

1809 "description": "URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.",	1942 "description": "URL of the form responses document.\nOnly se t if respsonses have been recorded and only when the\nrequesting user is an edit or of the form.\n\nRead-only.",

1810 "type": "string"	1943 "type": "string"

1811 },	1944 }

1812 "title": {	1945 },

1813 "description": "Title of the Form. Read-only.",	1946 "type": "object"

1814 "type": "string"	1947 },

1815 },	1948 "MultipleChoiceQuestion": {

1816 "thumbnailUrl": {	1949 "description": "Additional details for multiple-choice questions.",

1817 "description": "URL of a thumbnail image of the Form. Read-o nly.",	1950 "id": "MultipleChoiceQuestion",

1818 "type": "string"	1951 "properties": {

1819 }	1952 "choices": {

1820 },	1953 "description": "Possible choices.",

1821 "type": "object"

1822 },

1823 "Empty": {

1824 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re presentation for `Empty` is empty JSON object `{}`.",

1825 "id": "Empty",

1826 "type": "object"

1827 },

1828 "ListCoursesResponse": {

1829 "description": "Response when listing courses.",

1830 "id": "ListCoursesResponse",

1831 "properties": {

1832 "courses": {

1833 "description": "Courses that match the list request.",

1834 "items": {	1954 "items": {

1835 "$ref": "Course"	1955 "type": "string"

1836 },	1956 },

1837 "type": "array"	1957 "type": "array"

1838 },	1958 }

1839 "nextPageToken": {	1959 },

1840 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	1960 "type": "object"

1841 "type": "string"	1961 },

1842 }	1962 "CourseMaterialSet": {

1843 },	1963 "description": "A set of materials that appears on the \"About\" pag e of the course.\nThese materials might include a syllabus, schedule, or other b ackground\ninformation relating to the course as a whole.",

1844 "type": "object"	1964 "id": "CourseMaterialSet",

1845 },	1965 "properties": {

1846 "CourseAlias": {	1966 "materials": {

1847 "description": "Alternative identifier for a course. An alias unique ly identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is ofte n used when a course has an identifier external to Classroom. * project: A proje ct-scoped alias is visible to any request from an application using the Develope r Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifi ers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a p revious one has succeeded.",	1967 "description": "Materials attached to this set.",

1848 "id": "CourseAlias",

1849 "properties": {

1850 "alias": {

1851 "description": "Alias string. The format of the string indic ates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.",

1852 "type": "string"

1853 }

1854 },

1855 "type": "object"

1856 },

1857 "ListCourseAliasesResponse": {

1858 "description": "Response when listing course aliases.",

1859 "id": "ListCourseAliasesResponse",

1860 "properties": {

1861 "aliases": {

1862 "description": "The course aliases.",

1863 "items": {	1968 "items": {

1864 "$ref": "CourseAlias"	1969 "$ref": "CourseMaterial"

1865 },	1970 },

1866 "type": "array"	1971 "type": "array"

1867 },	1972 },

1868 "nextPageToken": {	1973 "title": {

1869 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	1974 "description": "Title for this set.",

1870 "type": "string"	1975 "type": "string"

1871 }	1976 }

1872 },	1977 },

1873 "type": "object"	1978 "type": "object"

1874 },	1979 },

1875 "ListGuardianInvitationsResponse": {	1980 "StudentSubmission": {

1876 "description": "Response when listing guardian invitations.",	1981 "description": "Student submission for course work.\n\nStudentSubmis sion items are generated when a CourseWork item is created.\n\nStudentSubmission s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati on time or update time.",

1877 "id": "ListGuardianInvitationsResponse",	1982 "id": "StudentSubmission",

1878 "properties": {	1983 "properties": {

1879 "guardianInvitations": {	1984 "id": {

1880 "description": "Guardian invitations that matched the list r equest.",	1985 "description": "Classroom-assigned Identifier for the studen t submission.\nThis is unique among submissions for the relevant course work.\n\ nRead-only.",

	1986 "type": "string"

	1987 },

	1988 "courseWorkType": {

	1989 "description": "Type of course work this submission is for.\ n\nRead-only.",

	1990 "enum": [

	1991 "COURSE_WORK_TYPE_UNSPECIFIED",

	1992 "ASSIGNMENT",

	1993 "SHORT_ANSWER_QUESTION",

	1994 "MULTIPLE_CHOICE_QUESTION"

	1995 ],

	1996 "enumDescriptions": [

	1997 "No work type specified. This is never returned.",

	1998 "An assignment.",

	1999 "A short answer question.",

	2000 "A multiple-choice question."

	2001 ],

	2002 "type": "string"

	2003 },

	2004 "assignedGrade": {

	2005 "description": "Optional grade. If unset, no grade was set.\ nThis must be a non-negative integer value.\n\nThis may be modified only by cour se teachers.",

	2006 "format": "double",

	2007 "type": "number"

	2008 },

	2009 "associatedWithDeveloper": {

	2010 "description": "Whether this student submission is associate d with the Developer Console\nproject making the request.\n\nSee google.classroo m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",

	2011 "type": "boolean"

	2012 },

	2013 "updateTime": {

	2014 "description": "Last update time of this submission.\nThis m ay be unset if the student has not accessed this item.\n\nRead-only.",

	2015 "format": "google-datetime",

	2016 "type": "string"

	2017 },

	2018 "alternateLink": {

	2019 "description": "Absolute link to the submission in the Class room web UI.\n\nRead-only.",

	2020 "type": "string"

	2021 },

	2022 "draftGrade": {

	2023 "description": "Optional pending grade. If unset, no grade w as set.\nThis must be a non-negative integer value.\n\nThis is only visible to a nd modifiable by course teachers.",

	2024 "format": "double",

	2025 "type": "number"

	2026 },

	2027 "userId": {

	2028 "description": "Identifier for the student that owns this su bmission.\n\nRead-only.",

	2029 "type": "string"

	2030 },

	2031 "multipleChoiceSubmission": {

	2032 "$ref": "MultipleChoiceSubmission",

	2033 "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."

	2034 },

	2035 "state": {

	2036 "description": "State of this submission.\n\nRead-only.",

	2037 "enum": [

	2038 "SUBMISSION_STATE_UNSPECIFIED",

	2039 "NEW",

	2040 "CREATED",

	2041 "TURNED_IN",

	2042 "RETURNED",

	2043 "RECLAIMED_BY_STUDENT"

	2044 ],

	2045 "enumDescriptions": [

	2046 "No state specified. This should never be returned.",

	2047 "The student has never accessed this submission. Attachm ents are not\nreturned and timestamps is not set.",

	2048 "Has been created.",

	2049 "Has been turned in to the teacher.",

	2050 "Has been returned to the student.",

	2051 "Student chose to \"unsubmit\" the assignment."

	2052 ],

	2053 "type": "string"

	2054 },

	2055 "assignmentSubmission": {

	2056 "$ref": "AssignmentSubmission",

	2057 "description": "Submission content when course_work_type is ASSIGNMENT ."

	2058 },

	2059 "creationTime": {

	2060 "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",

	2061 "format": "google-datetime",

	2062 "type": "string"

	2063 },

	2064 "courseId": {

	2065 "description": "Identifier of the course.\n\nRead-only.",

	2066 "type": "string"

	2067 },

	2068 "shortAnswerSubmission": {

	2069 "$ref": "ShortAnswerSubmission",

	2070 "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."

	2071 },

	2072 "late": {

	2073 "description": "Whether this submission is late.\n\nRead-onl y.",

	2074 "type": "boolean"

	2075 },

	2076 "courseWorkId": {

	2077 "description": "Identifier for the course work this correspo nds to.\n\nRead-only.",

	2078 "type": "string"

	2079 }

	2080 },

	2081 "type": "object"

	2082 },

	2083 "CourseAlias": {

	2084 "description": "Alternative identifier for a course.\n\nAn alias uni quely identifies a course. It must be unique within one of the\nfollowing scopes :\n\n* domain: A domain-scoped alias is visible to all users within the alias\nc reator's domain and can be created only by a domain admin. A domain-scoped\nalia s is often used when a course has an identifier external to Classroom.\n\n* proj ect: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alter native identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREA DY_EXISTS` if a previous one has succeeded.",

	2085 "id": "CourseAlias",

	2086 "properties": {

	2087 "alias": {

	2088 "description": "Alias string. The format of the string indic ates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias. \n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Exa mple: `p:abc123`\n\nThis field has a maximum length of 256 characters.",

	2089 "type": "string"

	2090 }

	2091 },

	2092 "type": "object"

	2093 },

	2094 "ListGuardiansResponse": {

	2095 "description": "Response when listing guardians.",

	2096 "id": "ListGuardiansResponse",

	2097 "properties": {

	2098 "guardians": {

	2099 "description": "Guardians on this page of results that met t he criteria specified in\nthe request.",

1881 "items": {	2100 "items": {

1882 "$ref": "GuardianInvitation"	2101 "$ref": "Guardian"

1883 },	2102 },

1884 "type": "array"	2103 "type": "array"

1885 },	2104 },

1886 "nextPageToken": {	2105 "nextPageToken": {

1887 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2106 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

1888 "type": "string"	2107 "type": "string"

1889 }	2108 }

1890 },	2109 },

1891 "type": "object"	2110 "type": "object"

1892 },	2111 },

1893 "GuardianInvitation": {	2112 "Guardian": {

1894 "description": "An invitation to become the guardian of a specified user, sent to a specified email address.",	2113 "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work. ",

1895 "id": "GuardianInvitation",	2114 "id": "Guardian",

1896 "properties": {	2115 "properties": {

	2116 "guardianProfile": {

	2117 "$ref": "UserProfile",

	2118 "description": "User profile for the guardian."

	2119 },

	2120 "invitedEmailAddress": {

	2121 "description": "The email address to which the initial guard ian invitation was sent.\nThis field is only visible to domain administrators.",

	2122 "type": "string"

	2123 },

1897 "studentId": {	2124 "studentId": {

1898 "description": "ID of the student (in standard format)",	2125 "description": "Identifier for the student to whom the guard ian relationship applies.",

1899 "type": "string"	2126 "type": "string"

1900 },	2127 },

1901 "invitationId": {	2128 "guardianId": {

1902 "description": "Unique identifier for this invitation. Read- only.",	2129 "description": "Identifier for the guardian.",

1903 "type": "string"	2130 "type": "string"

1904 },	2131 }

1905 "invitedEmailAddress": {	2132 },

1906 "description": "Email address that the invitation was sent t o. This field is only visible to domain administrators.",

1907 "type": "string"

1908 },

1909 "state": {

1910 "description": "The state that this invitation is in.",

1911 "enum": [

1912 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",

1913 "PENDING",

1914 "COMPLETE"

1915 ],

1916 "type": "string"

1917 },

1918 "creationTime": {

1919 "description": "The time that this invitation was created. R ead-only.",

1920 "type": "string"

1921 }

1922 },

1923 "type": "object"

1924 },

1925 "UserProfile": {

1926 "description": "Global information for a user.",

1927 "id": "UserProfile",

1928 "properties": {

1929 "id": {

1930 "description": "Identifier of the user. Read-only.",

1931 "type": "string"

1932 },

1933 "name": {

1934 "$ref": "Name",

1935 "description": "Name of the user. Read-only."

1936 },

1937 "emailAddress": {

1938 "description": "Email address of the user. Read-only.",

1939 "type": "string"

1940 },

1941 "photoUrl": {

1942 "description": "URL of user's profile photo. Read-only.",

1943 "type": "string"

1944 },

1945 "permissions": {

1946 "description": "Global permissions of the user. Read-only.",

1947 "items": {

1948 "$ref": "GlobalPermission"

1949 },

1950 "type": "array"

1951 }

1952 },

1953 "type": "object"

1954 },

1955 "Name": {

1956 "description": "Details of the user's name.",

1957 "id": "Name",

1958 "properties": {

1959 "givenName": {

1960 "description": "The user's first name. Read-only.",

1961 "type": "string"

1962 },

1963 "familyName": {

1964 "description": "The user's last name. Read-only.",

1965 "type": "string"

1966 },

1967 "fullName": {

1968 "description": "The user's full name formed by concatenating the first and last name values. Read-only.",

1969 "type": "string"

1970 }

1971 },

1972 "type": "object"

1973 },

1974 "GlobalPermission": {

1975 "description": "Global user permission description.",

1976 "id": "GlobalPermission",

1977 "properties": {

1978 "permission": {

1979 "description": "Permission value.",

1980 "enum": [

1981 "PERMISSION_UNSPECIFIED",

1982 "CREATE_COURSE"

1983 ],

1984 "type": "string"

1985 }

1986 },

1987 "type": "object"	2133 "type": "object"

1988 },	2134 },

1989 "Teacher": {	2135 "Teacher": {

1990 "description": "Teacher of a course.",	2136 "description": "Teacher of a course.",

1991 "id": "Teacher",	2137 "id": "Teacher",

1992 "properties": {	2138 "properties": {

1993 "courseId": {	2139 "courseId": {

1994 "description": "Identifier of the course. Read-only.",	2140 "description": "Identifier of the course.\n\nRead-only.",

1995 "type": "string"

1996 },

1997 "userId": {

1998 "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numer ic identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",

1999 "type": "string"	2141 "type": "string"

2000 },	2142 },

2001 "profile": {	2143 "profile": {

2002 "$ref": "UserProfile",	2144 "$ref": "UserProfile",

2003 "description": "Global user information for the teacher. Rea d-only."	2145 "description": "Global user information for the teacher.\n\n Read-only."

	2146 },

	2147 "userId": {

	2148 "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* th e numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

	2149 "type": "string"

	2150 }

	2151 },

	2152 "type": "object"

	2153 },

	2154 "UserProfile": {

	2155 "description": "Global information for a user.",

	2156 "id": "UserProfile",

	2157 "properties": {

	2158 "emailAddress": {

	2159 "description": "Email address of the user.\n\nRead-only.",

	2160 "type": "string"

	2161 },

	2162 "permissions": {

	2163 "description": "Global permissions of the user.\n\nRead-only .",

	2164 "items": {

	2165 "$ref": "GlobalPermission"

	2166 },

	2167 "type": "array"

	2168 },

	2169 "id": {

	2170 "description": "Identifier of the user.\n\nRead-only.",

	2171 "type": "string"

	2172 },

	2173 "name": {

	2174 "$ref": "Name",

	2175 "description": "Name of the user.\n\nRead-only."

	2176 },

	2177 "photoUrl": {

	2178 "description": "URL of user's profile photo.\n\nRead-only.",

	2179 "type": "string"

	2180 }

	2181 },

	2182 "type": "object"

	2183 },

	2184 "ReclaimStudentSubmissionRequest": {

	2185 "description": "Request to reclaim a student submission.",

	2186 "id": "ReclaimStudentSubmissionRequest",

	2187 "properties": {},

	2188 "type": "object"

	2189 },

	2190 "Student": {

	2191 "description": "Student in a course.",

	2192 "id": "Student",

	2193 "properties": {

	2194 "courseId": {

	2195 "description": "Identifier of the course.\n\nRead-only.",

	2196 "type": "string"

	2197 },

	2198 "profile": {

	2199 "$ref": "UserProfile",

	2200 "description": "Global user information for the student.\n\n Read-only."

	2201 },

	2202 "studentWorkFolder": {

	2203 "$ref": "DriveFolder",

	2204 "description": "Information about a Drive Folder for this st udent's work in this course.\nOnly visible to the student and domain administrat ors.\n\nRead-only."

	2205 },

	2206 "userId": {

	2207 "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* th e numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",

	2208 "type": "string"

2004 }	2209 }

2005 },	2210 },

2006 "type": "object"	2211 "type": "object"

2007 },	2212 },

2008 "ListTeachersResponse": {	2213 "ListTeachersResponse": {

2009 "description": "Response when listing teachers.",	2214 "description": "Response when listing teachers.",

2010 "id": "ListTeachersResponse",	2215 "id": "ListTeachersResponse",

2011 "properties": {	2216 "properties": {

	2217 "nextPageToken": {

	2218 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

	2219 "type": "string"

	2220 },

2012 "teachers": {	2221 "teachers": {

2013 "description": "Teachers who match the list request.",	2222 "description": "Teachers who match the list request.",

2014 "items": {	2223 "items": {

2015 "$ref": "Teacher"	2224 "$ref": "Teacher"

2016 },	2225 },

2017 "type": "array"	2226 "type": "array"

2018 },	2227 }

2019 "nextPageToken": {	2228 },

2020 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2229 "type": "object"

2021 "type": "string"	2230 },

2022 }	2231 "Course": {

2023 },	2232 "description": "A Course in Classroom.",

2024 "type": "object"	2233 "id": "Course",

2025 },	2234 "properties": {

2026 "Student": {	2235 "id": {

2027 "description": "Student in a course.",	2236 "description": "Identifier for this course assigned by Class room.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\ nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSp ecifying this field in a course update mask results in an error.",

2028 "id": "Student",	2237 "type": "string"

2029 "properties": {	2238 },

2030 "courseId": {	2239 "description": {

2031 "description": "Identifier of the course. Read-only.",	2240 "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textb ooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",

2032 "type": "string"	2241 "type": "string"

2033 },	2242 },

2034 "userId": {	2243 "updateTime": {

2035 "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numer ic identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",	2244 "description": "Time of the most recent update to this cours e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o nly.",

2036 "type": "string"	2245 "format": "google-datetime",

2037 },	2246 "type": "string"

2038 "profile": {	2247 },

2039 "$ref": "UserProfile",	2248 "section": {

2040 "description": "Global user information for the student. Rea d-only."	2249 "description": "Section of the course.\nFor example, \"Perio d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ ncharacters.",

2041 },	2250 "type": "string"

2042 "studentWorkFolder": {	2251 },

	2252 "alternateLink": {

	2253 "description": "Absolute link to this course in the Classroo m web UI.\n\nRead-only.",

	2254 "type": "string"

	2255 },

	2256 "teacherGroupEmail": {

	2257 "description": "The email address of a Google group containi ng all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",

	2258 "type": "string"

	2259 },

	2260 "guardiansEnabled": {

	2261 "description": "Whether or not guardian notifications are en abled for this course.\n\nRead-only.",

	2262 "type": "boolean"

	2263 },

	2264 "ownerId": {

	2265 "description": "The identifier of the owner of a course.\n\n When specified as a parameter of a\ncreate course request, this\nfield is requir ed.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indic ating the requesting user\n\nThis must be set in a create request. Specifying th is field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.",

	2266 "type": "string"

	2267 },

	2268 "descriptionHeading": {

	2269 "description": "Optional heading for the description.\nFor e xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U TF-8 string and no longer than 3600\ncharacters.",

	2270 "type": "string"

	2271 },

	2272 "courseGroupEmail": {

	2273 "description": "The email address of a Google group containi ng all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",

	2274 "type": "string"

	2275 },

	2276 "courseState": {

	2277 "description": "State of the course.\nIf unspecified, the de fault state is `PROVISIONED`.",

	2278 "enum": [

	2279 "COURSE_STATE_UNSPECIFIED",

	2280 "ACTIVE",

	2281 "ARCHIVED",

	2282 "PROVISIONED",

	2283 "DECLINED",

	2284 "SUSPENDED"

	2285 ],

	2286 "enumDescriptions": [

	2287 "No course state. No returned Course message will use th is value.",

	2288 "The course is active.",

	2289 "The course has been archived. You cannot modify it exce pt to change it\nto a different state.",

	2290 "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be cha nged to `PROVISIONED` if it is in the `DECLINED`\nstate.",

	2291 "The course has been created, but declined. It is access ible by the\ncourse owner and domain administrators, though it will not be\ndisp layed in the web UI. You cannot modify the course except to change it\nto the `P ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the ` PROVISIONED`\nstate.",

	2292 "The course has been suspended. You cannot modify the co urse, and only the\nuser identified by the `owner_id` can view the course.\nA co urse may be placed in this state if it potentially violates the\nTerms of Servic e."

	2293 ],

	2294 "type": "string"

	2295 },

	2296 "room": {

	2297 "description": "Optional room location.\nFor example, \"301\ ".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar acters.",

	2298 "type": "string"

	2299 },

	2300 "name": {

	2301 "description": "Name of the course.\nFor example, \"10th Gra de Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",

	2302 "type": "string"

	2303 },

	2304 "creationTime": {

	2305 "description": "Creation time of the course.\nSpecifying thi s field in a course update mask results in an error.\n\nRead-only.",

	2306 "format": "google-datetime",

	2307 "type": "string"

	2308 },

	2309 "enrollmentCode": {

	2310 "description": "Enrollment code to use when joining this cou rse.\nSpecifying this field in a course update mask results in an error.\n\nRead -only.",

	2311 "type": "string"

	2312 },

	2313 "teacherFolder": {

2043 "$ref": "DriveFolder",	2314 "$ref": "DriveFolder",

2044 "description": "Information about a Drive Folder for this st udent's work in this course. Only visible to the student and domain administrato rs. Read-only."	2315 "description": "Information about a Drive Folder that is sha red with all teachers of the\ncourse.\n\nThis field will only be set for teacher s of the course and domain administrators.\n\nRead-only."

2045 }	2316 },

2046 },	2317 "courseMaterialSets": {

2047 "type": "object"	2318 "description": "Sets of materials that appear on the \"about \" page of this course.\n\nRead-only.",

2048 },

2049 "ListStudentsResponse": {

2050 "description": "Response when listing students.",

2051 "id": "ListStudentsResponse",

2052 "properties": {

2053 "students": {

2054 "description": "Students who match the list request.",

2055 "items": {	2319 "items": {

2056 "$ref": "Student"	2320 "$ref": "CourseMaterialSet"

2057 },	2321 },

2058 "type": "array"	2322 "type": "array"

2059 },	2323 }

	2324 },

	2325 "type": "object"

	2326 },

	2327 "ReturnStudentSubmissionRequest": {

	2328 "description": "Request to return a student submission.",

	2329 "id": "ReturnStudentSubmissionRequest",

	2330 "properties": {},

	2331 "type": "object"

	2332 },

	2333 "GuardianInvitation": {

	2334 "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",

	2335 "id": "GuardianInvitation",

	2336 "properties": {

	2337 "creationTime": {

	2338 "description": "The time that this invitation was created.\n \nRead-only.",

	2339 "format": "google-datetime",

	2340 "type": "string"

	2341 },

	2342 "invitationId": {

	2343 "description": "Unique identifier for this invitation.\n\nRe ad-only.",

	2344 "type": "string"

	2345 },

	2346 "state": {

	2347 "description": "The state that this invitation is in.",

	2348 "enum": [

	2349 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",

	2350 "PENDING",

	2351 "COMPLETE"

	2352 ],

	2353 "enumDescriptions": [

	2354 "Should never be returned.",

	2355 "The invitation is active and awaiting a response.",

	2356 "The invitation is no longer active. It may have been ac cepted, declined,\nwithdrawn or it may have expired."

	2357 ],

	2358 "type": "string"

	2359 },

	2360 "invitedEmailAddress": {

	2361 "description": "Email address that the invitation was sent t o.\nThis field is only visible to domain administrators.",

	2362 "type": "string"

	2363 },

	2364 "studentId": {

	2365 "description": "ID of the student (in standard format)",

	2366 "type": "string"

	2367 }

	2368 },

	2369 "type": "object"

	2370 },

	2371 "TurnInStudentSubmissionRequest": {

	2372 "description": "Request to turn in a student submission.",

	2373 "id": "TurnInStudentSubmissionRequest",

	2374 "properties": {},

	2375 "type": "object"

	2376 },

	2377 "YouTubeVideo": {

	2378 "description": "YouTube video item.",

	2379 "id": "YouTubeVideo",

	2380 "properties": {

	2381 "thumbnailUrl": {

	2382 "description": "URL of a thumbnail image of the YouTube vide o.\n\nRead-only.",

	2383 "type": "string"

	2384 },

	2385 "title": {

	2386 "description": "Title of the YouTube video.\n\nRead-only.",

	2387 "type": "string"

	2388 },

	2389 "alternateLink": {

	2390 "description": "URL that can be used to view the YouTube vid eo.\n\nRead-only.",

	2391 "type": "string"

	2392 },

	2393 "id": {

	2394 "description": "YouTube API resource ID.",

	2395 "type": "string"

	2396 }

	2397 },

	2398 "type": "object"

	2399 },

	2400 "Empty": {

	2401 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",

	2402 "id": "Empty",

	2403 "properties": {},

	2404 "type": "object"

	2405 },

	2406 "ListCourseWorkResponse": {

	2407 "description": "Response when listing course work.",

	2408 "id": "ListCourseWorkResponse",

	2409 "properties": {

2060 "nextPageToken": {	2410 "nextPageToken": {

2061 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2411 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

2062 "type": "string"	2412 "type": "string"

2063 }	2413 },

2064 },	2414 "courseWork": {

2065 "type": "object"	2415 "description": "Course work items that match the request.",

2066 },

2067 "ListGuardiansResponse": {

2068 "description": "Response when listing guardians.",

2069 "id": "ListGuardiansResponse",

2070 "properties": {

2071 "guardians": {

2072 "description": "Guardians on this page of results that met t he criteria specified in the request.",

2073 "items": {	2416 "items": {

2074 "$ref": "Guardian"	2417 "$ref": "CourseWork"

2075 },	2418 },

2076 "type": "array"	2419 "type": "array"

2077 },	2420 }

2078 "nextPageToken": {	2421 },

2079 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2422 "type": "object"

2080 "type": "string"	2423 },

2081 }	2424 "SharedDriveFile": {

2082 },	2425 "description": "Drive file that is used as material for course work. ",

2083 "type": "object"	2426 "id": "SharedDriveFile",

2084 },	2427 "properties": {

2085 "Guardian": {	2428 "driveFile": {

2086 "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work." ,	2429 "$ref": "DriveFile",

2087 "id": "Guardian",	2430 "description": "Drive file details."

2088 "properties": {	2431 },

2089 "studentId": {	2432 "shareMode": {

2090 "description": "Identifier for the student to whom the guard ian relationship applies.",	2433 "description": "Mechanism by which students access the Drive item.",

2091 "type": "string"

2092 },

2093 "guardianId": {

2094 "description": "Identifier for the guardian.",

2095 "type": "string"

2096 },

2097 "guardianProfile": {

2098 "$ref": "UserProfile",

2099 "description": "User profile for the guardian."

2100 },

2101 "invitedEmailAddress": {

2102 "description": "The email address to which the initial guard ian invitation was sent. This field is only visible to domain administrators.",

2103 "type": "string"

2104 }

2105 },

2106 "type": "object"

2107 },

2108 "Invitation": {

2109 "description": "An invitation to join a course.",

2110 "id": "Invitation",

2111 "properties": {

2112 "id": {

2113 "description": "Identifier assigned by Classroom. Read-only. ",

2114 "type": "string"

2115 },

2116 "userId": {

2117 "description": "Identifier of the invited user. When specifi ed as a parameter of a request, this identifier can be set to one of the followi ng: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",

2118 "type": "string"

2119 },

2120 "courseId": {

2121 "description": "Identifier of the course to invite the user to.",

2122 "type": "string"

2123 },

2124 "role": {

2125 "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",

2126 "enum": [	2434 "enum": [

2127 "COURSE_ROLE_UNSPECIFIED",	2435 "UNKNOWN_SHARE_MODE",

2128 "STUDENT",	2436 "VIEW",

2129 "TEACHER"	2437 "EDIT",

2130 ],	2438 "STUDENT_COPY"

2131 "type": "string"	2439 ],

2132 }	2440 "enumDescriptions": [

2133 },	2441 "No sharing mode specified. This should never be returne d.",

2134 "type": "object"	2442 "Students can view the shared file.",

2135 },	2443 "Students can edit the shared file.",

2136 "ListInvitationsResponse": {	2444 "Students have a personal copy of the shared file."

2137 "description": "Response when listing invitations.",	2445 ],

2138 "id": "ListInvitationsResponse",	2446 "type": "string"

2139 "properties": {	2447 }

2140 "invitations": {	2448 },

2141 "description": "Invitations that match the list request.",	2449 "type": "object"

2142 "items": {	2450 },

2143 "$ref": "Invitation"	2451 "GlobalPermission": {

2144 },	2452 "description": "Global user permission description.",

2145 "type": "array"	2453 "id": "GlobalPermission",

2146 },	2454 "properties": {

2147 "nextPageToken": {	2455 "permission": {

2148 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2456 "description": "Permission value.",

2149 "type": "string"

2150 }

2151 },

2152 "type": "object"

2153 },

2154 "CourseWork": {

2155 "description": "Course work created by a teacher for students of the course.",

2156 "id": "CourseWork",

2157 "properties": {

2158 "courseId": {

2159 "description": "Identifier of the course. Read-only.",

2160 "type": "string"

2161 },

2162 "id": {

2163 "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.",

2164 "type": "string"

2165 },

2166 "title": {

2167 "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.",

2168 "type": "string"

2169 },

2170 "description": {

2171 "description": "Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,00 0 characters.",

2172 "type": "string"

2173 },

2174 "materials": {

2175 "description": "Additional materials. CourseWork must have n o more than 20 material items.",

2176 "items": {

2177 "$ref": "Material"

2178 },

2179 "type": "array"

2180 },

2181 "state": {

2182 "description": "Status of this course work. If unspecified, the default state is `DRAFT`.",

2183 "enum": [	2457 "enum": [

2184 "COURSE_WORK_STATE_UNSPECIFIED",	2458 "PERMISSION_UNSPECIFIED",

2185 "PUBLISHED",	2459 "CREATE_COURSE"

2186 "DRAFT",	2460 ],

2187 "DELETED"	2461 "enumDescriptions": [

2188 ],	2462 "No permission is specified. This is not returned and is not a\nvalid value.",

2189 "type": "string"	2463 "User is permitted to create a course."

2190 },	2464 ],

2191 "alternateLink": {	2465 "type": "string"

2192 "description": "Absolute link to this course work in the Cla ssroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.",

2193 "type": "string"

2194 },

2195 "creationTime": {

2196 "description": "Timestamp when this course work was created. Read-only.",

2197 "type": "string"

2198 },

2199 "updateTime": {

2200 "description": "Timestamp of the most recent change to this course work. Read-only.",

2201 "type": "string"

2202 },

2203 "dueDate": {

2204 "$ref": "Date",

2205 "description": "Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified ."

2206 },

2207 "dueTime": {

2208 "$ref": "TimeOfDay",

2209 "description": "Optional time of day, in UTC, that submissio ns for this this course work are due. This must be specified if `due_date` is sp ecified."

2210 },

2211 "maxPoints": {

2212 "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negat ive integer value.",

2213 "format": "double",

2214 "type": "number"

2215 },

2216 "workType": {

2217 "description": "Type of this course work. The type is set wh en the course work is created and cannot be changed.",

2218 "enum": [

2219 "COURSE_WORK_TYPE_UNSPECIFIED",

2220 "ASSIGNMENT",

2221 "SHORT_ANSWER_QUESTION",

2222 "MULTIPLE_CHOICE_QUESTION"

2223 ],

2224 "type": "string"

2225 },

2226 "associatedWithDeveloper": {

2227 "description": "Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work .CreateCourseWork for more details. Read-only.",

2228 "type": "boolean"

2229 },

2230 "submissionModificationMode": {

2231 "description": "Setting to determine when students are allow ed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL _TURNED_IN`.",

2232 "enum": [

2233 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",

2234 "MODIFIABLE_UNTIL_TURNED_IN",

2235 "MODIFIABLE"

2236 ],

2237 "type": "string"

2238 },

2239 "assignment": {

2240 "$ref": "Assignment",

2241 "description": "Assignment details. This is populated only w hen `work_type` is `ASSIGNMENT`. Read-only."

2242 },

2243 "multipleChoiceQuestion": {

2244 "$ref": "MultipleChoiceQuestion",

2245 "description": "Multiple choice question details. For read o perations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUE STION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set ot herwise."

2246 }	2466 }

2247 },	2467 },

2248 "type": "object"	2468 "type": "object"

2249 },	2469 },

2250 "Material": {	2470 "Material": {

2251 "description": "Material attached to course work. When creating atta chments, setting the `form` field is not supported.",	2471 "description": "Material attached to course work.\n\nWhen creating a ttachments, setting the `form` field is not supported.",

2252 "id": "Material",	2472 "id": "Material",

2253 "properties": {	2473 "properties": {

2254 "driveFile": {	2474 "driveFile": {

2255 "$ref": "SharedDriveFile",	2475 "$ref": "SharedDriveFile",

2256 "description": "Google Drive file material."	2476 "description": "Google Drive file material."

2257 },	2477 },

	2478 "link": {

	2479 "$ref": "Link",

	2480 "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the resp onse."

	2481 },

2258 "youtubeVideo": {	2482 "youtubeVideo": {

2259 "$ref": "YouTubeVideo",	2483 "$ref": "YouTubeVideo",

2260 "description": "YouTube video material."	2484 "description": "YouTube video material."

2261 },	2485 },

2262 "link": {

2263 "$ref": "Link",

2264 "description": "Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the respo nse."

2265 },

2266 "form": {	2486 "form": {

2267 "$ref": "Form",	2487 "$ref": "Form",

2268 "description": "Google Forms material."	2488 "description": "Google Forms material."

2269 }	2489 }

2270 },	2490 },

2271 "type": "object"	2491 "type": "object"

2272 },	2492 },

2273 "SharedDriveFile": {	2493 "AssignmentSubmission": {

2274 "description": "Drive file that is used as material for course work. ",	2494 "description": "Student work for an assignment.",

2275 "id": "SharedDriveFile",	2495 "id": "AssignmentSubmission",

2276 "properties": {	2496 "properties": {

2277 "driveFile": {	2497 "attachments": {

2278 "$ref": "DriveFile",	2498 "description": "Attachments added by the student.\nDrive fil es that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attac hment metadata is only populated if the requesting user has\npermission to acces s it. Identifier and alternate_link fields are always\navailable, but others (e. g. title) may not be.",

2279 "description": "Drive file details."	2499 "items": {

2280 },	2500 "$ref": "Attachment"

2281 "shareMode": {	2501 },

2282 "description": "Mechanism by which students access the Drive item.",	2502 "type": "array"

2283 "enum": [

2284 "UNKNOWN_SHARE_MODE",

2285 "VIEW",

2286 "EDIT",

2287 "STUDENT_COPY"

2288 ],

2289 "type": "string"

2290 }	2503 }

2291 },	2504 },

2292 "type": "object"	2505 "type": "object"

2293 },	2506 },

2294 "Date": {	2507 "Date": {

2295 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and time zone are either specified elsewhere or are not signif icant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit ca rd expiration date. The year may be 0 to represent a month and day independent o f year, e.g. anniversary date. Related types are google.type.TimeOfDay and `goog le.protobuf.Timestamp`.",	2508 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",

2296 "id": "Date",	2509 "id": "Date",

2297 "properties": {	2510 "properties": {

2298 "year": {

2299 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without a year.",

2300 "format": "int32",

2301 "type": "integer"

2302 },

2303 "month": {	2511 "month": {

2304 "description": "Month of year. Must be from 1 to 12.",	2512 "description": "Month of year. Must be from 1 to 12.",

2305 "format": "int32",	2513 "format": "int32",

2306 "type": "integer"	2514 "type": "integer"

2307 },	2515 },

	2516 "year": {

	2517 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",

	2518 "format": "int32",

	2519 "type": "integer"

	2520 },

2308 "day": {	2521 "day": {

2309 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not si gnificant.",	2522 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.",

2310 "format": "int32",	2523 "format": "int32",

2311 "type": "integer"	2524 "type": "integer"

2312 }	2525 }

2313 },

2314 "type": "object"

2315 },

2316 "TimeOfDay": {

2317 "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow le ap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`." ,

2318 "id": "TimeOfDay",

2319 "properties": {

2320 "hours": {

2321 "description": "Hours of day in 24 hour format. Should be fr om 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",

2322 "format": "int32",

2323 "type": "integer"

2324 },

2325 "minutes": {

2326 "description": "Minutes of hour of day. Must be from 0 to 59 .",

2327 "format": "int32",

2328 "type": "integer"

2329 },

2330 "seconds": {

2331 "description": "Seconds of minutes of the time. Must normall y be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",

2332 "format": "int32",

2333 "type": "integer"

2334 },

2335 "nanos": {

2336 "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",

2337 "format": "int32",

2338 "type": "integer"

2339 }

2340 },	2526 },

2341 "type": "object"	2527 "type": "object"

2342 },	2528 },

2343 "Assignment": {	2529 "Assignment": {

2344 "description": "Additional details for assignments.",	2530 "description": "Additional details for assignments.",

2345 "id": "Assignment",	2531 "id": "Assignment",

2346 "properties": {	2532 "properties": {

2347 "studentWorkFolder": {	2533 "studentWorkFolder": {

2348 "$ref": "DriveFolder",	2534 "$ref": "DriveFolder",

2349 "description": "Drive folder where attachments from student submissions are placed. This is only populated for course teachers."	2535 "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."

2350 }	2536 }

2351 },	2537 },

2352 "type": "object"	2538 "type": "object"

2353 },	2539 },

2354 "MultipleChoiceQuestion": {	2540 "ListCoursesResponse": {

2355 "description": "Additional details for multiple-choice questions.",	2541 "description": "Response when listing courses.",

2356 "id": "MultipleChoiceQuestion",	2542 "id": "ListCoursesResponse",

2357 "properties": {	2543 "properties": {

2358 "choices": {	2544 "nextPageToken": {

2359 "description": "Possible choices.",	2545 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

	2546 "type": "string"

	2547 },

	2548 "courses": {

	2549 "description": "Courses that match the list request.",

2360 "items": {	2550 "items": {

2361 "type": "string"	2551 "$ref": "Course"

2362 },	2552 },

2363 "type": "array"	2553 "type": "array"

2364 }	2554 }

2365 },	2555 },

2366 "type": "object"	2556 "type": "object"

2367 },	2557 },

2368 "ListCourseWorkResponse": {	2558 "Invitation": {

2369 "description": "Response when listing course work.",	2559 "description": "An invitation to join a course.",

2370 "id": "ListCourseWorkResponse",	2560 "id": "Invitation",

2371 "properties": {

2372 "courseWork": {

2373 "description": "Course work items that match the request.",

2374 "items": {

2375 "$ref": "CourseWork"

2376 },

2377 "type": "array"

2378 },

2379 "nextPageToken": {

2380 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",

2381 "type": "string"

2382 }

2383 },

2384 "type": "object"

2385 },

2386 "StudentSubmission": {

2387 "description": "Student submission for course work. StudentSubmissio n items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.",

2388 "id": "StudentSubmission",

2389 "properties": {	2561 "properties": {

2390 "courseId": {	2562 "courseId": {

2391 "description": "Identifier of the course. Read-only.",	2563 "description": "Identifier of the course to invite the user to.",

2392 "type": "string"	2564 "type": "string"

2393 },	2565 },

2394 "courseWorkId": {	2566 "role": {

2395 "description": "Identifier for the course work this correspo nds to. Read-only.",	2567 "description": "Role to invite the user to have.\nMust not b e `COURSE_ROLE_UNSPECIFIED`.",

	2568 "enum": [

	2569 "COURSE_ROLE_UNSPECIFIED",

	2570 "STUDENT",

	2571 "TEACHER"

	2572 ],

	2573 "enumDescriptions": [

	2574 "No course role.",

	2575 "Student in the course.",

	2576 "Teacher of the course."

	2577 ],

	2578 "type": "string"

	2579 },

	2580 "userId": {

	2581 "description": "Identifier of the invited user.\n\nWhen spec ified as a parameter of a request, this identifier can be set to\none of the fol lowing:\n\n* the numeric identifier for the user\n* the email address of the use r\n* the string literal `\"me\"`, indicating the requesting user",

2396 "type": "string"	2582 "type": "string"

2397 },	2583 },

2398 "id": {	2584 "id": {

2399 "description": "Classroom-assigned Identifier for the studen t submission. This is unique among submissions for the relevant course work. Rea d-only.",	2585 "description": "Identifier assigned by Classroom.\n\nRead-on ly.",

2400 "type": "string"

2401 },

2402 "userId": {

2403 "description": "Identifier for the student that owns this su bmission. Read-only.",

2404 "type": "string"

2405 },

2406 "creationTime": {

2407 "description": "Creation time of this submission. This may b e unset if the student has not accessed this item. Read-only.",

2408 "type": "string"

2409 },

2410 "updateTime": {

2411 "description": "Last update time of this submission. This ma y be unset if the student has not accessed this item. Read-only.",

2412 "type": "string"

2413 },

2414 "state": {

2415 "description": "State of this submission. Read-only.",

2416 "enum": [

2417 "SUBMISSION_STATE_UNSPECIFIED",

2418 "NEW",

2419 "CREATED",

2420 "TURNED_IN",

2421 "RETURNED",

2422 "RECLAIMED_BY_STUDENT"

2423 ],

2424 "type": "string"

2425 },

2426 "late": {

2427 "description": "Whether this submission is late. Read-only." ,

2428 "type": "boolean"

2429 },

2430 "draftGrade": {

2431 "description": "Optional pending grade. If unset, no grade w as set. This must be a non-negative integer value. This is only visible to and m odifiable by course teachers.",

2432 "format": "double",

2433 "type": "number"

2434 },

2435 "assignedGrade": {

2436 "description": "Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course t eachers.",

2437 "format": "double",

2438 "type": "number"

2439 },

2440 "alternateLink": {

2441 "description": "Absolute link to the submission in the Class room web UI. Read-only.",

2442 "type": "string"

2443 },

2444 "courseWorkType": {

2445 "description": "Type of course work this submission is for. Read-only.",

2446 "enum": [

2447 "COURSE_WORK_TYPE_UNSPECIFIED",

2448 "ASSIGNMENT",

2449 "SHORT_ANSWER_QUESTION",

2450 "MULTIPLE_CHOICE_QUESTION"

2451 ],

2452 "type": "string"

2453 },

2454 "associatedWithDeveloper": {

2455 "description": "Whether this student submission is associate d with the Developer Console project making the request. See google.classroom.Wo rk.CreateCourseWork for more details. Read-only.",

2456 "type": "boolean"

2457 },

2458 "assignmentSubmission": {

2459 "$ref": "AssignmentSubmission",

2460 "description": "Submission content when course_work_type is ASSIGNMENT ."

2461 },

2462 "shortAnswerSubmission": {

2463 "$ref": "ShortAnswerSubmission",

2464 "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."

2465 },

2466 "multipleChoiceSubmission": {

2467 "$ref": "MultipleChoiceSubmission",

2468 "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."

2469 }

2470 },

2471 "type": "object"

2472 },

2473 "AssignmentSubmission": {

2474 "description": "Student work for an assignment.",

2475 "id": "AssignmentSubmission",

2476 "properties": {

2477 "attachments": {

2478 "description": "Attachments added by the student. Drive file s that correspond to materials with a share mode of STUDENT_COPY may not exist y et if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. I dentifier and alternate_link fields are always available, but others (e.g. title ) may not be.",

2479 "items": {

2480 "$ref": "Attachment"

2481 },

2482 "type": "array"

2483 }

2484 },

2485 "type": "object"

2486 },

2487 "Attachment": {

2488 "description": "Attachment added to student assignment work. When cr eating attachments, setting the `form` field is not supported.",

2489 "id": "Attachment",

2490 "properties": {

2491 "driveFile": {

2492 "$ref": "DriveFile",

2493 "description": "Google Drive file attachment."

2494 },

2495 "youTubeVideo": {

2496 "$ref": "YouTubeVideo",

2497 "description": "Youtube video attachment."

2498 },

2499 "link": {

2500 "$ref": "Link",

2501 "description": "Link attachment."

2502 },

2503 "form": {

2504 "$ref": "Form",

2505 "description": "Google Forms attachment."

2506 }

2507 },

2508 "type": "object"

2509 },

2510 "ShortAnswerSubmission": {

2511 "description": "Student work for a short answer question.",

2512 "id": "ShortAnswerSubmission",

2513 "properties": {

2514 "answer": {

2515 "description": "Student response to a short-answer question. ",

2516 "type": "string"

2517 }

2518 },

2519 "type": "object"

2520 },

2521 "MultipleChoiceSubmission": {

2522 "description": "Student work for a multiple-choice question.",

2523 "id": "MultipleChoiceSubmission",

2524 "properties": {

2525 "answer": {

2526 "description": "Student's select choice.",

2527 "type": "string"	2586 "type": "string"

2528 }	2587 }

2529 },	2588 },

2530 "type": "object"	2589 "type": "object"

2531 },	2590 },

2532 "ListStudentSubmissionsResponse": {	2591 "ListStudentSubmissionsResponse": {

2533 "description": "Response when listing student submissions.",	2592 "description": "Response when listing student submissions.",

2534 "id": "ListStudentSubmissionsResponse",	2593 "id": "ListStudentSubmissionsResponse",

2535 "properties": {	2594 "properties": {

	2595 "nextPageToken": {

	2596 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

	2597 "type": "string"

	2598 },

2536 "studentSubmissions": {	2599 "studentSubmissions": {

2537 "description": "Student work that matches the request.",	2600 "description": "Student work that matches the request.",

2538 "items": {	2601 "items": {

2539 "$ref": "StudentSubmission"	2602 "$ref": "StudentSubmission"

2540 },	2603 },

2541 "type": "array"	2604 "type": "array"

	2605 }

	2606 },

	2607 "type": "object"

	2608 },

	2609 "Name": {

	2610 "description": "Details of the user's name.",

	2611 "id": "Name",

	2612 "properties": {

	2613 "givenName": {

	2614 "description": "The user's first name.\n\nRead-only.",

	2615 "type": "string"

2542 },	2616 },

2543 "nextPageToken": {	2617 "familyName": {

2544 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",	2618 "description": "The user's last name.\n\nRead-only.",

	2619 "type": "string"

	2620 },

	2621 "fullName": {

	2622 "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",

2545 "type": "string"	2623 "type": "string"

2546 }	2624 }

2547 },	2625 },

2548 "type": "object"	2626 "type": "object"

2549 },	2627 },

2550 "TurnInStudentSubmissionRequest": {	2628 "ListInvitationsResponse": {

2551 "description": "Request to turn in a student submission.",	2629 "description": "Response when listing invitations.",

2552 "id": "TurnInStudentSubmissionRequest",	2630 "id": "ListInvitationsResponse",

2553 "type": "object"

2554 },

2555 "ReclaimStudentSubmissionRequest": {

2556 "description": "Request to reclaim a student submission.",

2557 "id": "ReclaimStudentSubmissionRequest",

2558 "type": "object"

2559 },

2560 "ReturnStudentSubmissionRequest": {

2561 "description": "Request to return a student submission.",

2562 "id": "ReturnStudentSubmissionRequest",

2563 "type": "object"

2564 },

2565 "ModifyAttachmentsRequest": {

2566 "description": "Request to modify the attachments of a student submi ssion.",

2567 "id": "ModifyAttachmentsRequest",

2568 "properties": {	2631 "properties": {

2569 "addAttachments": {	2632 "nextPageToken": {

2570 "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.",	2633 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

	2634 "type": "string"

	2635 },

	2636 "invitations": {

	2637 "description": "Invitations that match the list request.",

2571 "items": {	2638 "items": {

2572 "$ref": "Attachment"	2639 "$ref": "Invitation"

2573 },	2640 },

2574 "type": "array"	2641 "type": "array"

2575 }	2642 }

	2643 },

	2644 "type": "object"

	2645 },

	2646 "ListStudentsResponse": {

	2647 "description": "Response when listing students.",

	2648 "id": "ListStudentsResponse",

	2649 "properties": {

	2650 "nextPageToken": {

	2651 "description": "Token identifying the next page of results t o return. If empty, no further\nresults are available.",

	2652 "type": "string"

	2653 },

	2654 "students": {

	2655 "description": "Students who match the list request.",

	2656 "items": {

	2657 "$ref": "Student"

	2658 },

	2659 "type": "array"

	2660 }

2576 },	2661 },

2577 "type": "object"	2662 "type": "object"

2578 }	2663 }

2579 },	2664 },

2580 "servicePath": "",	2665 "servicePath": "",

2581 "title": "Google Classroom API",	2666 "title": "Google Classroom API",

2582 "version": "v1"	2667 "version": "v1"

2583 }	2668 }

OLD	NEW

« no previous file with comments | « discovery/googleapis/calendar__v3.json ('k') | discovery/googleapis/cloudbilling__v1.json » ('j') | no next file with comments »