Grade¶

IPSIS.GradeCategoryInfo¶

Contains all IPSIS details about a grade category.

{
    "ExportToSIS": <boolean>,
    "AcademicSessionOrgUnitId": <number:D2LID>|null  // Added with LE API v1.62
}

IPSIS.GradeObjectDetails¶

Contains all IPSIS details about a grade object.

{
   "AcademicSessionOrgUnitId": <number:D2LID>|null,
   "EndOfCourse": <boolean>,
   "PowerSchoolGradeType": <number:POWERSCHOOL_GRADE_TYPE_T>|null,  // Added with LE API v1.62
   "SectionOrgUnitId": <number:D2LID>|null  // Added with LE API v1.62
}

Signed URL¶

IPSIS.FileNameData¶

When a client requests a signed URL, it should provide the original file name in a structure like this:

{
    "FileName": <string>
}

IPSIS.SignedUrlData¶

When a signed URL is generated, it will be returned in a structure like this:

{
    "SignedUrl": <string>
}

IPSIS Grade¶

GET /d2l/api/le/(version)/(orgUnitId)/grades/categories/(categoryId)/ipsis¶

Retrieve the IPSIS details for a grade category.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• categoryId (D2LID) – Grade category ID.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – The return body may contain further details.

• 403 Forbidden – No permission to manage grades.

• 404 Not Found – Grade category not found, or org unit not found.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns the updated IPSIS details in a GradeCategoryInfo JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/ipsis¶

Retrieve the IPSIS details for a grade object.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• gradeObjectId (D2LID) – Grade object ID.

Oauth2 Scopes:

grades:gradeobjects:read

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – The return body may contain further details.

• 403 Forbidden – No permission to manage grades.

• 404 Not Found – Grade object not found, or org unit not found.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns the updated IPSIS details in a GradeObjectDetails JSON block.

PUT /d2l/api/le/(version)/(orgUnitId)/grades/categories/(categoryId)/ipsis¶

Update the IPSIS details for a grade category.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• categoryId (D2LID) – Grade category ID.

JSON Parameters:

• GradeCategoryInfo (IPSIS.GradeCategoryInfo) – Updated data for IPSIS grade category details.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – The return body may contain further details.

• 403 Forbidden – No permission to manage grades.

• 404 Not Found – Grade category not found, or org unit not found.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns the updated IPSIS details in a GradeCategoryInfo JSON block.

PUT /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/ipsis¶

Update IPSIS details for a grade object.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• gradeObjectId (D2LID) – Grade object ID.

JSON Parameters:

• GradeObjectDetails (IPSIS.GradeObjectDetails) – Updated data for IPSIS grade object details.

Oauth2 Scopes:

grades:gradeobjects:write

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – The return body may contain further details.

• 403 Forbidden – No permission to manage grades.

• 404 Not Found – Grade object not found, or org unit not found.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. This action returns the updated IPSIS details in a GradeObjectDetails JSON block.

Signed URL¶

POST /d2l/api/le/{version}/ipsis/upload/{sourceSystemId}/signedurl¶

Generate a signed URL for uploading batch file to IPSIS.

Parameters:

• version (D2LVERSION) – API version.

• sourceSystemId (D2LID) – Source System ID.

JSON Parameters:

• FileNameData (IPSIS.FileNameData) – Data for the original file name.

Oauth2 Scopes:

ipsis:batch:upload

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Bad file name, invalid system configuration, or unsupported source system.

• 403 Forbidden – No permission to manage IPSIS bulk operations.

• 404 Not Found – No such source system found.

• 409 Conflict – Source system is disabled.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Return. If successful, this action returns a SignedUrlData JSON data block containing the signed URL.

Note

When uploading a batch file through the returned signed URL, make sure to set the Content-Type request header to binary/octet-stream.