blob: 96d57edc980e5a116b08351fe57d5517f70f75a1 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.posts.html">posts</a> . <a href="classroom_v1.courses.posts.addOnAttachments.html">addOnAttachments</a> . <a href="classroom_v1.courses.posts.addOnAttachments.studentSubmissions.html">studentSubmissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, postId, attachmentId, submissionId, itemId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student submission for an add-on attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.</p>
<p class="toc_element">
<code><a href="#patch">patch(courseId, postId, attachmentId, submissionId, body=None, itemId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(courseId, postId, attachmentId, submissionId, itemId=None, x__xgafv=None)</code>
<pre>Returns a student submission for an add-on attachment. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.
Args:
courseId: string, Required. Identifier of the course. (required)
postId: string, Optional. Deprecated, use `item_id` instead. (required)
attachmentId: string, Required. Identifier of the attachment. (required)
submissionId: string, Required. Identifier of the student’s submission. (required)
itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Payload for grade update requests.
&quot;pointsEarned&quot;: 3.14, # Student grade on this attachment. If unset, no grade was set.
&quot;postSubmissionState&quot;: &quot;A String&quot;, # Submission state of add-on attachment&#x27;s parent post (i.e. assignment).
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(courseId, postId, attachmentId, submissionId, body=None, itemId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.
Args:
courseId: string, Required. Identifier of the course. (required)
postId: string, Optional. Deprecated, use `item_id` instead. (required)
attachmentId: string, Required. Identifier of the attachment. (required)
submissionId: string, Required. Identifier of the student&#x27;s submission. (required)
body: object, The request body.
The object takes the form of:
{ # Payload for grade update requests.
&quot;pointsEarned&quot;: 3.14, # Student grade on this attachment. If unset, no grade was set.
&quot;postSubmissionState&quot;: &quot;A String&quot;, # Submission state of add-on attachment&#x27;s parent post (i.e. assignment).
}
itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
updateMask: string, Required. Mask that identifies which fields on the attachment to 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 `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: * `points_earned`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Payload for grade update requests.
&quot;pointsEarned&quot;: 3.14, # Student grade on this attachment. If unset, no grade was set.
&quot;postSubmissionState&quot;: &quot;A String&quot;, # Submission state of add-on attachment&#x27;s parent post (i.e. assignment).
}</pre>
</div>
</body></html>