Read.Course.Gradebook.Items

Reads the gradebook items for the specified course. The course setting ("Use assessment record") must be enabled for this method to work.. The results can be filtered using the specified input parameters 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 items.

NOTE: You are not allowed to enter both CourseId and CourseSyncKey.

Integer

M/O

CourseSyncKey

SyncKey of the course to get the gradebook items for.

NOTE: You are not allowed to enter both CourseId and CourseSyncKey.

String

M/O

TermId

Term identifier to filter the results on.

NOTE: If you set this to 0 you will get all items not related to a specific term. If you omit this parameter you will get all items 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 items not related to a specific category. If you omit this parameter you will get all items regardless of their relation to a category.

Integer

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.Items">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadCourseGradebookItems>
<tem:request>
<its1:CourseId>13</its1:CourseId>
<its1:TermId>5</its1:TermId>
<its1:CategoryId>3</its1:CategoryId>
</tem:request>
</tem:ReadCourseGradebookItems>
</soapenv:Body>
</soapenv:Envelope>

Output parameters

Name

Description

Type

GradebookItemId

Identifier for the gradebook item.

Integer

ElementId

Identifier if connected to an element otherwise null.

Integer

GradebookItemTitle

Title of the gradebook item

String

Weight

The weighting for this gradebook item.

Integer

AssessmentId

Identifier of the assessment scale used in this assessment.

Integer

IsFinalAssessment

Whether final assessment is used.

Boolean

TermId

The term this assessment is associated with (if any).

Integer

CategoryId

The category this assessment is associated with (if any).

Integer

MaxScore

The maximum score.

Double

DueDate

The gradebook item due date. Can be NULL.

Date/Time

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>2013-01-09T11:16:57.984Z</u:Created>
<u:Expires>2013-01-09T11:21:57.984Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<ReadCourseGradebookItemsResponse xmlns="http://tempuri.org/">
<ReadCourseGradebookItemsResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CourseGradebook.Items" 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">2</Total>
<a:GradebookItems>
<a:CourseGradebookItem>
<a:AssessmentId>0</a:AssessmentId>
<a:CategoryId i:nil="true"/>
<a:ElementId>0</a:ElementId>
<a:GradebookItemId>178</a:GradebookItemId>
<a:IsFinalAssessment>false</a:IsFinalAssessment>
<a:MaxScore>0</a:MaxScore>
<a:TermId>5</a:TermId>
<a:GradebookItemTitle>Maths</a:GradebookItemTitle>
<a:Weight>0</a:Weight>
<a:DueDate i:nil="true"/>
</a:CourseGradebookItem>
<a:CourseGradebookItem>
<a:AssessmentId>4</a:AssessmentId>
<a:CategoryId>3</a:CategoryId>
<a:ElementId>414</a:ElementId>
<a:GradebookItemId>181</a:GradebookItemId>
<a:IsFinalAssessment>false</a:IsFinalAssessment>
<a:MaxScore>0</a:MaxScore>
<a:TermId>5</a:TermId>
<a:GradebookItemTitle>Write about holidays</a:GradebookItemTitle>
<a:Weight>0</a:Weight>
<a:DueDate>2017-03-22T16:00:00</a:DueDate>
</a:CourseGradebookItem>
</a:GradebookItems>
</ReadCourseGradebookItemsResult>
</ReadCourseGradebookItemsResponse>
</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.