Read.Course.Gradebook.Categories

Reads the gradebook categories for a specific course that the requester has access to.

Input parameters

Name

Description

Type

Mandatory/Optional

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

CourseId

Identifier of the course to get the gradebook categories for.

Integer

Mandatory, when CourseSyncKey is not specified

CourseSyncKey

SyncKey of the course to get the gradebook categories for.

String

Mandatory, when CourseId is not specified

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.CourseGradebookCategories">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ReadCourseGradebookCategories>
         <tem:request>
            <its:CourseId>1</its:CourseId>
          </tem:request>
      </tem:ReadCourseGradebookCategories>
   </soapenv:Body>
</soapenv:Envelope>

Output parameters

Name

Description

Type

Comments

CategoryID

Identifier of the category

Integer

Title

Title of the category

String

Weight

Weight of the category

Double

Values will only be returned If

  • customer setting 'EnableGradebookCategoriesWeight' is enable

  • gradebook category setting 'Use weighting' = ''Yes'

Otherwise null will be returned

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-10T13:39:27.404Z</u:Created>
            <u:Expires>2012-12-10T13:44:27.404Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <ReadCourseGradebookCategoriesResponse xmlns="http://tempuri.org/">
         <ReadCourseGradebookCategoriesResult>
            <CourseGradebookCategories>
               <CourseGradebookCategory>
                  <CategoryId>10</CategoryId>
                  <Title>Category 1</Title>
                  <Weight>70.6</Weight>
               </CourseGradebookCategory>
               <CourseGradebookCategory>
                  <CategoryId>11</CategoryId>
                  <Title>Category 2</Title>
                  <Weight>10.6</Weight>
               </CourseGradebookCategory>
               <CourseGradebookCategory>
                  <CategoryId>12</CategoryId>
                  <Title>Category 3</Title>
                  <Weight>18.8</Weight>
               </CourseGradebookCategory>
            </CourseGradebookCategories>
         </ReadCourseGradebookCategoriesResult>
      </ReadCourseGradebookCategoriesResponse>
   </s:Body>
</s:Envelope>

Error states

In the following cases the service will return an error:

  • CourseId nor CourseSynckey is specified in the request.

  • Both CourseId and CourseSyncKey specified in the request

  • Course does not exist.

  • Course is deleted.

  • Course does not have activated “Use assessment record” settings

  • Requester does not have access to the course.