GET ims/oneroster/v1p1/GradeBookAssignments

Get array of Gradebook Assignments for class sections filtered by the query string parameters specified.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Get array of Gradebook Assignments for class sections filtered by the query string parameters specified.

Collection of QWebAPIGradeBookAssignmentsResult
NameDescriptionTypeAdditional information
GradeBookAssignmentId

integer

None.
GradeBookSectionId

integer

None.
SectionId

integer

None.
GradeBookCategoryId

integer

None.
Category

string

None.
Title

string

None.
ShortTitle

string

None.
DateAssigned

string

None.
DisplayDate

string

None.
DueDate

string

None.
PointsPossible

integer

None.
Weight

decimal number

None.
isGraded

boolean

None.
isExtraCredit

boolean

None.
CourseName

string

None.
TermDescription

string

None.
TrackCode

string

None.
TrackDescription

string

None.
SchoolCode

string

None.
SchoolName

string

None.
PeriodCode

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "GradeBookAssignmentId": 1,
    "GradeBookSectionId": 2,
    "SectionId": 3,
    "GradeBookCategoryId": 4,
    "Category": "sample string 5",
    "Title": "sample string 6",
    "ShortTitle": "sample string 7",
    "DateAssigned": "sample string 8",
    "DisplayDate": "sample string 9",
    "DueDate": "sample string 10",
    "PointsPossible": 1,
    "Weight": 1.0,
    "isGraded": true,
    "isExtraCredit": true,
    "CourseName": "sample string 13",
    "TermDescription": "sample string 14",
    "TrackCode": "sample string 15",
    "TrackDescription": "sample string 16",
    "SchoolCode": "sample string 17",
    "SchoolName": "sample string 18",
    "PeriodCode": "sample string 19"
  },
  {
    "GradeBookAssignmentId": 1,
    "GradeBookSectionId": 2,
    "SectionId": 3,
    "GradeBookCategoryId": 4,
    "Category": "sample string 5",
    "Title": "sample string 6",
    "ShortTitle": "sample string 7",
    "DateAssigned": "sample string 8",
    "DisplayDate": "sample string 9",
    "DueDate": "sample string 10",
    "PointsPossible": 1,
    "Weight": 1.0,
    "isGraded": true,
    "isExtraCredit": true,
    "CourseName": "sample string 13",
    "TermDescription": "sample string 14",
    "TrackCode": "sample string 15",
    "TrackDescription": "sample string 16",
    "SchoolCode": "sample string 17",
    "SchoolName": "sample string 18",
    "PeriodCode": "sample string 19"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfQWebAPIGradeBookAssignmentsResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QWebAPIGradeBookAssignmentsResult>
    <GradeBookAssignmentId>1</GradeBookAssignmentId>
    <GradeBookSectionId>2</GradeBookSectionId>
    <SectionId>3</SectionId>
    <GradeBookCategoryId>4</GradeBookCategoryId>
    <Category>sample string 5</Category>
    <Title>sample string 6</Title>
    <ShortTitle>sample string 7</ShortTitle>
    <DateAssigned>sample string 8</DateAssigned>
    <DisplayDate>sample string 9</DisplayDate>
    <DueDate>sample string 10</DueDate>
    <PointsPossible>1</PointsPossible>
    <Weight>1</Weight>
    <isGraded>true</isGraded>
    <isExtraCredit>true</isExtraCredit>
    <CourseName>sample string 13</CourseName>
    <TermDescription>sample string 14</TermDescription>
    <TrackCode>sample string 15</TrackCode>
    <TrackDescription>sample string 16</TrackDescription>
    <SchoolCode>sample string 17</SchoolCode>
    <SchoolName>sample string 18</SchoolName>
    <PeriodCode>sample string 19</PeriodCode>
  </QWebAPIGradeBookAssignmentsResult>
  <QWebAPIGradeBookAssignmentsResult>
    <GradeBookAssignmentId>1</GradeBookAssignmentId>
    <GradeBookSectionId>2</GradeBookSectionId>
    <SectionId>3</SectionId>
    <GradeBookCategoryId>4</GradeBookCategoryId>
    <Category>sample string 5</Category>
    <Title>sample string 6</Title>
    <ShortTitle>sample string 7</ShortTitle>
    <DateAssigned>sample string 8</DateAssigned>
    <DisplayDate>sample string 9</DisplayDate>
    <DueDate>sample string 10</DueDate>
    <PointsPossible>1</PointsPossible>
    <Weight>1</Weight>
    <isGraded>true</isGraded>
    <isExtraCredit>true</isExtraCredit>
    <CourseName>sample string 13</CourseName>
    <TermDescription>sample string 14</TermDescription>
    <TrackCode>sample string 15</TrackCode>
    <TrackDescription>sample string 16</TrackDescription>
    <SchoolCode>sample string 17</SchoolCode>
    <SchoolName>sample string 18</SchoolName>
    <PeriodCode>sample string 19</PeriodCode>
  </QWebAPIGradeBookAssignmentsResult>
</ArrayOfQWebAPIGradeBookAssignmentsResult>