GET restapi/personal/course/{courseId}/assessmentrecord/assessmentrecordelements/v1?termId={termId}

Gets the elements for the gradebook

Request Information

URI Parameters

NameDescriptionTypeAdditional information
courseId

The identifier of a course to get assessment record elements from.

 integer

Required
termId

[optional] Used for filtering assessment record elements by term.

 integer

None.

Body Parameters

None.

Response Information

Resource Description

Itslearning.RestApi.Entities.AssessmentRecord.AssessmentRecordElements
NameDescriptionTypeAdditional information
AssessmentRecordItems

Returns the assessment record items

 Collection of Itslearning.RestApi.Entities.AssessmentRecord.AssessmentRecordItem

None.
AssessmentRecordItemsCount

Returns the assessment record items' count

 integer

None.
FinalAssessmentRecordItems

Returns the final assessment record items

 Collection of Itslearning.RestApi.Entities.AssessmentRecord.AssessmentRecordItem

None.
AssessmentScales

Returns the assessment scales

 Collection of Itslearning.RestApi.Entities.AssessmentRecord.AssessmentScale

None.
IsScoreInUse

Returns true if any asessment record items uses score

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "AssessmentRecordItems": [
    {
      "GradeBookItemId": 1,
      "Title": "sample string 2",
      "Weight": 3.1,
      "WhenToShowResult": 0,
      "AssessmentId": 4,
      "IsFinal": true,
      "IsPassedDeadline": true,
      "TermId": 7,
      "CategoryId": 8,
      "ElementType": "sample string 9",
      "ElementId": 1,
      "MaxScore": 10.1,
      "UseScore": true,
      "IsActive": true,
      "IsAssessmentVisible": true,
      "IsCustomAssessmentVisible": true,
      "IsReadOnly": true,
      "LearningToolId": 16,
      "Deadline": "2025-06-24T05:28:54Z",
      "FormattedDeadline": "sample string 17",
      "IsLearningPathSubElement": true
    },
    {
      "GradeBookItemId": 1,
      "Title": "sample string 2",
      "Weight": 3.1,
      "WhenToShowResult": 0,
      "AssessmentId": 4,
      "IsFinal": true,
      "IsPassedDeadline": true,
      "TermId": 7,
      "CategoryId": 8,
      "ElementType": "sample string 9",
      "ElementId": 1,
      "MaxScore": 10.1,
      "UseScore": true,
      "IsActive": true,
      "IsAssessmentVisible": true,
      "IsCustomAssessmentVisible": true,
      "IsReadOnly": true,
      "LearningToolId": 16,
      "Deadline": "2025-06-24T05:28:54Z",
      "FormattedDeadline": "sample string 17",
      "IsLearningPathSubElement": true
    }
  ],
  "AssessmentRecordItemsCount": 1,
  "FinalAssessmentRecordItems": [
    {
      "GradeBookItemId": 1,
      "Title": "sample string 2",
      "Weight": 3.1,
      "WhenToShowResult": 0,
      "AssessmentId": 4,
      "IsFinal": true,
      "IsPassedDeadline": true,
      "TermId": 7,
      "CategoryId": 8,
      "ElementType": "sample string 9",
      "ElementId": 1,
      "MaxScore": 10.1,
      "UseScore": true,
      "IsActive": true,
      "IsAssessmentVisible": true,
      "IsCustomAssessmentVisible": true,
      "IsReadOnly": true,
      "LearningToolId": 16,
      "Deadline": "2025-06-24T05:28:54Z",
      "FormattedDeadline": "sample string 17",
      "IsLearningPathSubElement": true
    },
    {
      "GradeBookItemId": 1,
      "Title": "sample string 2",
      "Weight": 3.1,
      "WhenToShowResult": 0,
      "AssessmentId": 4,
      "IsFinal": true,
      "IsPassedDeadline": true,
      "TermId": 7,
      "CategoryId": 8,
      "ElementType": "sample string 9",
      "ElementId": 1,
      "MaxScore": 10.1,
      "UseScore": true,
      "IsActive": true,
      "IsAssessmentVisible": true,
      "IsCustomAssessmentVisible": true,
      "IsReadOnly": true,
      "LearningToolId": 16,
      "Deadline": "2025-06-24T05:28:54Z",
      "FormattedDeadline": "sample string 17",
      "IsLearningPathSubElement": true
    }
  ],
  "AssessmentScales": [
    {
      "AssessmentScaleId": 1,
      "Title": "sample string 2",
      "AssessmentTotals": 3,
      "Values": [
        {
          "AssessmentItemId": 1,
          "Title": "sample string 2",
          "OrderPosition": 3,
          "PercentFrom": 4.1,
          "PercentTo": 5.1
        },
        {
          "AssessmentItemId": 1,
          "Title": "sample string 2",
          "OrderPosition": 3,
          "PercentFrom": 4.1,
          "PercentTo": 5.1
        }
      ]
    },
    {
      "AssessmentScaleId": 1,
      "Title": "sample string 2",
      "AssessmentTotals": 3,
      "Values": [
        {
          "AssessmentItemId": 1,
          "Title": "sample string 2",
          "OrderPosition": 3,
          "PercentFrom": 4.1,
          "PercentTo": 5.1
        },
        {
          "AssessmentItemId": 1,
          "Title": "sample string 2",
          "OrderPosition": 3,
          "PercentFrom": 4.1,
          "PercentTo": 5.1
        }
      ]
    }
  ],
  "IsScoreInUse": true
}

application/xml, text/xml

Sample: 
<AssessmentRecordElements xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssessmentRecordItems>
    <AssessmentRecordItem>
      <AssessmentId>4</AssessmentId>
      <CategoryId>8</CategoryId>
      <Deadline>2025-06-24T05:28:54Z</Deadline>
      <ElementId>1</ElementId>
      <ElementType>sample string 9</ElementType>
      <FormattedDeadline>sample string 17</FormattedDeadline>
      <GradeBookItemId>1</GradeBookItemId>
      <IsActive>true</IsActive>
      <IsAssessmentVisible>true</IsAssessmentVisible>
      <IsCustomAssessmentVisible>true</IsCustomAssessmentVisible>
      <IsFinal>true</IsFinal>
      <IsLearningPathSubElement>true</IsLearningPathSubElement>
      <IsPassedDeadline>true</IsPassedDeadline>
      <IsReadOnly>true</IsReadOnly>
      <LearningToolId>16</LearningToolId>
      <MaxScore>10.1</MaxScore>
      <TermId>7</TermId>
      <Title>sample string 2</Title>
      <UseScore>true</UseScore>
      <Weight>3.1</Weight>
      <WhenToShowResult>Undefined</WhenToShowResult>
    </AssessmentRecordItem>
    <AssessmentRecordItem>
      <AssessmentId>4</AssessmentId>
      <CategoryId>8</CategoryId>
      <Deadline>2025-06-24T05:28:54Z</Deadline>
      <ElementId>1</ElementId>
      <ElementType>sample string 9</ElementType>
      <FormattedDeadline>sample string 17</FormattedDeadline>
      <GradeBookItemId>1</GradeBookItemId>
      <IsActive>true</IsActive>
      <IsAssessmentVisible>true</IsAssessmentVisible>
      <IsCustomAssessmentVisible>true</IsCustomAssessmentVisible>
      <IsFinal>true</IsFinal>
      <IsLearningPathSubElement>true</IsLearningPathSubElement>
      <IsPassedDeadline>true</IsPassedDeadline>
      <IsReadOnly>true</IsReadOnly>
      <LearningToolId>16</LearningToolId>
      <MaxScore>10.1</MaxScore>
      <TermId>7</TermId>
      <Title>sample string 2</Title>
      <UseScore>true</UseScore>
      <Weight>3.1</Weight>
      <WhenToShowResult>Undefined</WhenToShowResult>
    </AssessmentRecordItem>
  </AssessmentRecordItems>
  <AssessmentRecordItemsCount>1</AssessmentRecordItemsCount>
  <AssessmentScales>
    <AssessmentScale>
      <AssessmentScaleId>1</AssessmentScaleId>
      <AssessmentTotals>3</AssessmentTotals>
      <Title>sample string 2</Title>
      <Values>
        <AssessmentScaleValue>
          <AssessmentItemId>1</AssessmentItemId>
          <OrderPosition>3</OrderPosition>
          <PercentFrom>4.1</PercentFrom>
          <PercentTo>5.1</PercentTo>
          <Title>sample string 2</Title>
        </AssessmentScaleValue>
        <AssessmentScaleValue>
          <AssessmentItemId>1</AssessmentItemId>
          <OrderPosition>3</OrderPosition>
          <PercentFrom>4.1</PercentFrom>
          <PercentTo>5.1</PercentTo>
          <Title>sample string 2</Title>
        </AssessmentScaleValue>
      </Values>
    </AssessmentScale>
    <AssessmentScale>
      <AssessmentScaleId>1</AssessmentScaleId>
      <AssessmentTotals>3</AssessmentTotals>
      <Title>sample string 2</Title>
      <Values>
        <AssessmentScaleValue>
          <AssessmentItemId>1</AssessmentItemId>
          <OrderPosition>3</OrderPosition>
          <PercentFrom>4.1</PercentFrom>
          <PercentTo>5.1</PercentTo>
          <Title>sample string 2</Title>
        </AssessmentScaleValue>
        <AssessmentScaleValue>
          <AssessmentItemId>1</AssessmentItemId>
          <OrderPosition>3</OrderPosition>
          <PercentFrom>4.1</PercentFrom>
          <PercentTo>5.1</PercentTo>
          <Title>sample string 2</Title>
        </AssessmentScaleValue>
      </Values>
    </AssessmentScale>
  </AssessmentScales>
  <FinalAssessmentRecordItems>
    <AssessmentRecordItem>
      <AssessmentId>4</AssessmentId>
      <CategoryId>8</CategoryId>
      <Deadline>2025-06-24T05:28:54Z</Deadline>
      <ElementId>1</ElementId>
      <ElementType>sample string 9</ElementType>
      <FormattedDeadline>sample string 17</FormattedDeadline>
      <GradeBookItemId>1</GradeBookItemId>
      <IsActive>true</IsActive>
      <IsAssessmentVisible>true</IsAssessmentVisible>
      <IsCustomAssessmentVisible>true</IsCustomAssessmentVisible>
      <IsFinal>true</IsFinal>
      <IsLearningPathSubElement>true</IsLearningPathSubElement>
      <IsPassedDeadline>true</IsPassedDeadline>
      <IsReadOnly>true</IsReadOnly>
      <LearningToolId>16</LearningToolId>
      <MaxScore>10.1</MaxScore>
      <TermId>7</TermId>
      <Title>sample string 2</Title>
      <UseScore>true</UseScore>
      <Weight>3.1</Weight>
      <WhenToShowResult>Undefined</WhenToShowResult>
    </AssessmentRecordItem>
    <AssessmentRecordItem>
      <AssessmentId>4</AssessmentId>
      <CategoryId>8</CategoryId>
      <Deadline>2025-06-24T05:28:54Z</Deadline>
      <ElementId>1</ElementId>
      <ElementType>sample string 9</ElementType>
      <FormattedDeadline>sample string 17</FormattedDeadline>
      <GradeBookItemId>1</GradeBookItemId>
      <IsActive>true</IsActive>
      <IsAssessmentVisible>true</IsAssessmentVisible>
      <IsCustomAssessmentVisible>true</IsCustomAssessmentVisible>
      <IsFinal>true</IsFinal>
      <IsLearningPathSubElement>true</IsLearningPathSubElement>
      <IsPassedDeadline>true</IsPassedDeadline>
      <IsReadOnly>true</IsReadOnly>
      <LearningToolId>16</LearningToolId>
      <MaxScore>10.1</MaxScore>
      <TermId>7</TermId>
      <Title>sample string 2</Title>
      <UseScore>true</UseScore>
      <Weight>3.1</Weight>
      <WhenToShowResult>Undefined</WhenToShowResult>
    </AssessmentRecordItem>
  </FinalAssessmentRecordItems>
  <IsScoreInUse>true</IsScoreInUse>
</AssessmentRecordElements>