Reads the gradebook assessments for the specified course. The course setting ("Use assessment record") must be enabled for this method to work.. The results can be filtered by specifying a number of input parameter documented below:
Input parameters
Name | Description | Type | Mandatory/Optional |
---|---|---|---|
SiteId | Site where action will be executed. | Integer | Optional |
VendorId | VendorId. Currently not used. | Text | Optional |
PageIndex | Index of the requested page. This defaults to 0. | Integer | O |
PageSize | Size of the requested page. The default and limit is 100. | Integer | O |
CourseId | Identifier of the course to get the gradebook assessments for. NOTE: You are not allowed to enter both CourseId and CourseSyncKey. | Integer | M/O |
CourseSyncKey | SyncKey of the course to get the gradebook assessments for. NOTE: You are not allowed to enter both CourseId and CourseSyncKey. | String | M/O |
GradebookItemIdList | List of gradebook item identifiers to filter the results on. | Integer[] | O |
TermId | Term identifier to filter the results on. NOTE: If you set this to 0 you will get all assessments not related to a specific term. If you omit this parameter you will get all assessments regardless of their relation to a term. | Integer | O |
CategoryId | Category identifier to filter the results on. NOTE: If you set this to 0 you will get all assessments not related to a specific category. If you omit this parameter you will get all assessments regardless of their relation to a category. | Integer | O |
PersonId | Identifier of a person to filter the results on. NOTE: You are not allowed to enter both PersonId and PersonSyncKey | Integer | O |
PersonSyncKey | SyncKey of a person to filter the results on. NOTE: You are not allowed to enter both PersonId and PersonSyncKey | String | O |
FromDate | Date and time to filter the result on, so only assessments set after the FromDate are returned. | DateTime | O |
IncludeFeedback | If true then comments to assessments will be exposed in 'Feedback' field. | Boolean | O |
Example request
<
soapenv
:Envelope
xmlns:soapenv
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem
=
"http://tempuri.org/"
xmlns:its
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
xmlns:its1
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CourseGradebook.Assessments"
xmlns:arr
=
"http://schemas.microsoft.com/2003/10/Serialization/Arrays"
>
<
soapenv
:Header/>
<
soapenv
:Body>
<
tem
:ReadCourseGradebookAssessments>
<
tem
:request>
<
its1
:CourseId>3</
its1
:CourseId>
<
its1
:GradebookItemsIdList>
<
arr
:int>1</
arr
:int>
<
arr
:int>2</
arr
:int>
</
its1
:GradebookItemsIdList>
<
its1
:PersonId>5</
its1
:PersonId>
<
its1
:TermId>2</
its1
:TermId>
</
tem
:request>
</
tem
:ReadCourseGradebookAssessments>
</
soapenv
:Body>
</
soapenv
:Envelope>
Output parameters
Name | Description | Type |
---|---|---|
PersonId | Identifier of the person this assessment is for. | Integer |
PersonSyncKey | Synckey of the person this assessment is for. NOTE: Not all persons have a synckey | String |
Assessments | Array of all assessments for this person | Assessment[] |
Assessment.GradebookItemId | Identifier of the gradebook item this assessment is for. | Integer |
Assessment.AssessmentId | Identifier of the assessment scale used in this assessment. | Integer |
Assessment.AssessmentItemId | Identifier of the assessment scale value used for the grade. | Integer |
Assessment.AssessmentItemTitle | Description of the assessment scale value. | String |
Assessment.TermId | The term this assessment is associated with (if any). | Integer |
Assessment.CategoryId | The category this assessment is associated with (if any). | Integer |
Assessment.Score | The score given for this assessment (if any). | Double |
Assessment.LastModifiedDateTime | The date and time when this assessment was last modified. | DateTime |
Assessment.LastModifiedPersonId | Identifier of the person who last modified this assessment. | Integer |
Assessment.LastModifiedPersonSyncKey | Sync key of the person who last modified this assessment. | String |
Assessment.Feedback | Comment from teacher to this assessment. | String |
Assessment.Anonymous | Whether assessment was made for anonymous submission | Boolean |
Example response
<
s
:Envelope
xmlns:s
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u
=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
>
<
s
:Header>
<
o
:Security
s:mustUnderstand
=
"1"
xmlns:o
=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
>
<
u
:Timestamp
u:Id
=
"_0"
>
<
u
:Created>2012-12-21T12:35:15.494Z</
u
:Created>
<
u
:Expires>2012-12-21T12:40:15.494Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body>
<
ReadCourseGradebookAssessmentsResponse
xmlns
=
"http://tempuri.org/"
>
<
ReadCourseGradebookAssessmentsResult
xmlns:a
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CourseGradebook.Assessments"
xmlns:i
=
"http://www.w3.org/2001/XMLSchema-instance"
>
<
CurrentPageIndex
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>0</
CurrentPageIndex
>
<
PageSize
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>100</
PageSize
>
<
Total
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>1</
Total
>
<
a
:AssessmentRecords>
<
a
:AssessmentRecord>
<
a
:Assessments>
<
a
:Assessment>
<
a
:Anonymous>true</
a
:Anonymous>
<
a
:AssessmentId>3</
a
:AssessmentId>
<
a
:AssessmentItemId>19</
a
:AssessmentItemId>
<
a
:AssessmentItemTitle>9,0</
a
:AssessmentItemTitle>
<
a
:CategoryId
i:nil
=
"true"
/>
<
a
:Feedback>Well done!</
a
:Feedback>
<
a
:GradebookItemId>1</
a
:GradebookItemId>
<
a
:LastModifiedDateTime>2020-08-13T16:18:04</
a
:LastModifiedDateTime>
<
a
:LastModifiedPersonId>1</
a
:LastModifiedPersonId>
<
a
:LastModifiedPersonSyncKey>user_sync</
a
:LastModifiedPersonSyncKey>
<
a
:Score
i:nil
=
"true"
/>
<
a
:TermId>2</
a
:TermId>
</
a
:Assessment>
<
a
:Assessment>
<
a
:Anonymous>false</
a
:Anonymous>
<
a
:AssessmentId>1</
a
:AssessmentId>
<
a
:AssessmentItemId>4</
a
:AssessmentItemId>
<
a
:AssessmentItemTitle>D</
a
:AssessmentItemTitle>
<
a
:CategoryId>1</
a
:CategoryId>
<
a
:Feedback
i:nil
=
"true"
/>
<
a
:GradebookItemId>2</
a
:GradebookItemId>
<
a
:LastModifiedDateTime>2020-07-13T16:18:04</
a
:LastModifiedDateTime>
<
a
:LastModifiedPersonId>1</
a
:LastModifiedPersonId>
<
a
:LastModifiedPersonSyncKey>user_sync</
a
:LastModifiedPersonSyncKey>
<
a
:Score
i:nil
=
"true"
/>
<
a
:TermId>2</
a
:TermId>
</
a
:Assessment>
</
a
:Assessments>
<
a
:PersonId>5</
a
:PersonId>
<
a
:PersonSyncKey/>
</
a
:AssessmentRecord>
</
a
:AssessmentRecords>
</
ReadCourseGradebookAssessmentsResult
>
</
ReadCourseGradebookAssessmentsResponse
>
</
s
:Body>
</
s
:Envelope>
Error states
In the following cases it will return an error:
- The requested course does not exist.
- The requested course has been deleted.
- The requested course exists, but belongs to an organisation the requester does not have access to.
- The requester supplied both a CourseId and CourseSyncKey.
- The requested course does not use assessment record.
- The specified category does not exist.
- The specified category is not a category in the requested course.
- The specified term does not exist.
- The specified term is deleted.
- The specified term is not connected to the requested course.
- One of the specified gradebook items does not exist.
- One of the specified gradebook items is deleted.
- One of the specified gradebook items is not connected to the requested course.
- The requester supplied both a PersonId and PersonSyncKey.
- The specified person does not exist.
- The specified person is deleted.
- The specified person is not a course member.