Developer Platform (October 2021)

IPSIS

«  Data Hub and Data Export Framework   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  Users (user data, whoami)  »

Contents

Attributes

Grade

IPSIS.GradeCategoryInfo

Contains all IPSIS details about a grade category.

{
    "ExportToSis": <boolean>
}
IPSIS.GradeObjectDetails

Contains all IPSIS details about a grade object.

{
   "AcademicSessionOrgUnitId": <number:D2LID>,
   "EndOfCourse": <boolean>
}

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>
}

Actions

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
API Versions
  • 1.53+ – Route first appears in LMS v20.21.5.

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
API Versions
  • 1.53+ – Route first appears in LMS v20.21.5.

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
Status Codes
API Versions
  • 1.53+ – Route first appears in LMS v20.21.5.

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
Oauth2 Scopes

grades:gradeobjects:write

Status Codes
API Versions
  • 1.53+ – Route first appears in LMS v20.21.5.

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
Oauth2 Scopes

ipsis:batch:upload

Status Codes
API Versions
  • 1.57+ – Route first appears in LMS v20.21.9.

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.

«  Data Hub and Data Export Framework   ·  [   home  ·   reference  ·   community   |   search  ·   index   ·  routing table   ·  scopes table   ]   ·  Users (user data, whoami)  »