Progress API: Gradebooks

Retrieves one specific gradebook

get
Authorizations
BearerstringRequired
Path parameters
gradebookstring · uuidRequired
Responses
chevron-right
200

OK

achievementIdstring · uuid · nullableOptional
eventIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
gradebookIdstring · uuidOptional
organizationIdstring · uuidOptional
periodIdstring · uuid · nullableOptional
isLockedbooleanOptional
gradebookTitlestring · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
gradebookCreatedstring · date-timeOptional
lastChangeTimestring · date-timeOptional
achievementTitlestring · nullableOptional
classInstructorsstring · nullableOptional
classScheduledStartDatestring · nullableOptional
classScheduledEndDatestring · nullableOptional
classTitlestring · nullableOptional
get
/api/progress/gradebooks/{gradebook}
200

OK

Checks for the existence of one specific gradebook

head
Authorizations
BearerstringRequired
Path parameters
gradebookstring · uuidRequired
Responses
chevron-right
200

OK

booleanOptional
head
/api/progress/gradebooks/{gradebook}
200

OK

Collects the list of gradebooks that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
achievementIdstring · uuid · nullableOptional
classIdstring · uuid · nullableOptional
classInstructorIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
isLockedboolean · nullableOptional
classTitlestring · nullableOptional
gradebookTitlestring · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
classStartedSincestring · date-time · nullableOptional
classStartedBeforestring · date-time · nullableOptional
gradebookCreatedSincestring · date-time · nullableOptional
gradebookCreatedBeforestring · date-time · nullableOptional
lastChangeSincestring · date-time · nullableOptional
lastChangeBeforestring · date-time · nullableOptional
Responses
chevron-right
200

OK

achievementIdstring · uuid · nullableOptional
eventIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
gradebookIdstring · uuidOptional
organizationIdstring · uuidOptional
periodIdstring · uuid · nullableOptional
isLockedbooleanOptional
gradebookTitlestring · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
gradebookCreatedstring · date-timeOptional
lastChangeTimestring · date-timeOptional
achievementTitlestring · nullableOptional
classInstructorsstring · nullableOptional
classScheduledStartDatestring · nullableOptional
classScheduledEndDatestring · nullableOptional
classTitlestring · nullableOptional
post
/api/progress/gradebooks/collect
200

OK

Counts the gradebooks that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
achievementIdstring · uuid · nullableOptional
classIdstring · uuid · nullableOptional
classInstructorIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
isLockedboolean · nullableOptional
classTitlestring · nullableOptional
gradebookTitlestring · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
classStartedSincestring · date-time · nullableOptional
classStartedBeforestring · date-time · nullableOptional
gradebookCreatedSincestring · date-time · nullableOptional
gradebookCreatedBeforestring · date-time · nullableOptional
lastChangeSincestring · date-time · nullableOptional
lastChangeBeforestring · date-time · nullableOptional
Responses
chevron-right
200

OK

countinteger · int32Optional
summarystring · nullableOptional
post
/api/progress/gradebooks/count
200

OK

Downloads the list of gradebooks that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
achievementIdstring · uuid · nullableOptional
classIdstring · uuid · nullableOptional
classInstructorIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
isLockedboolean · nullableOptional
classTitlestring · nullableOptional
gradebookTitlestring · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
classStartedSincestring · date-time · nullableOptional
classStartedBeforestring · date-time · nullableOptional
gradebookCreatedSincestring · date-time · nullableOptional
gradebookCreatedBeforestring · date-time · nullableOptional
lastChangeSincestring · date-time · nullableOptional
lastChangeBeforestring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/progress/gradebooks/download
200

OK

No content

Searches for the list of gradebooks that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
gradebookTitlestring · nullableOptional
gradebookCreatedSincestring · date-time · nullableOptional
gradebookCreatedBeforestring · date-time · nullableOptional
periodIdstring · uuid · nullableOptional
achievementIdstring · uuid · nullableOptional
frameworkIdstring · uuid · nullableOptional
isLockedboolean · nullableOptional
classTitlestring · nullableOptional
classStartedSincestring · date-time · nullableOptional
classStartedBeforestring · date-time · nullableOptional
classInstructorIdstring · uuid · nullableOptional
classIdstring · uuid · nullableOptional
gradebookTypestring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
referencestring · nullableOptional
lastChangeSincestring · date-time · nullableOptional
lastChangeBeforestring · date-time · nullableOptional
Responses
chevron-right
200

OK

gradebookIdstring · uuidOptional
gradebookTitlestring · nullableOptional
gradebookCreatedstring · date-timeOptional
gradebookEnrollmentCountinteger · int32Optional
classIdstring · uuid · nullableOptional
classTitlestring · nullableOptional
classStartedstring · date-time · nullableOptional
classEndedstring · date-time · nullableOptional
achievementIdstring · uuid · nullableOptional
achievementTitlestring · nullableOptional
achievementCountGrantedinteger · int32Optional
isLockedbooleanOptional
post
/api/progress/gradebooks/search
200

OK

get

DO NOT use allow this endpoint to be used in live Production environments. When time and budget permit, we will design and implement a fire-and-forget strategy managing a queue of large exports, reports, etc.

Authorizations
BearerstringRequired
Query parameters
AchievementIdstring · uuidOptional
ClassIdstring · uuidOptional
ClassInstructorIdstring · uuidOptional
FrameworkIdstring · uuidOptional
OrganizationIdstring · uuidOptional
PeriodIdstring · uuidOptional
IsLockedbooleanOptional
ClassTitlestringOptional
GradebookTitlestringOptional
GradebookTypestringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
ReferencestringOptional
ClassStartedSincestring · date-timeOptional
ClassStartedBeforestring · date-timeOptional
GradebookCreatedSincestring · date-timeOptional
GradebookCreatedBeforestring · date-timeOptional
LastChangeSincestring · date-timeOptional
LastChangeBeforestring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
chevron-right
200

OK

downloadUrlstring · nullableOptional
exportFormatstring · nullableOptional
exportKeystring · nullableOptional
expirystring · date-timeOptional
get
/api/progress/gradebooks/export
200

OK

get
Authorizations
BearerstringRequired
Path parameters
keystringRequired
Responses
chevron-right
200

OK

No content

get
/api/progress/gradebooks/exports/{key}
200

OK

No content

Last updated

Was this helpful?