Breaking Change

In pre 4.9.0 releases PageInfo in endpoints were recommended but not mandatory. The 4.9.0 release requires any endpoint supporting PageInfo to have a PageInfo passed in with a PageSize within a configurated range. See https://rippleops.atlassian.net/wiki/spaces/MLSPS/pages/5440507798 for details.

If you already use PageInfo, this should not impact your integrations. All that’s needed is to inform the support team of the minimum and maximum PageSize values you’re using, so they can adjust the system configuration accordingly.

Affected API Endpoints

The following endpoints are affected and require using PageInfo:

• ExternalRegistration/GetDefaultOfferingsByPath

• ExternalRegistration/GetActiveRegistrationData

• ExternalRegistration/GetCompletedRegistrationData

• ExternalRegistration/GetActiveRegistrationsWithDetails

• ExternalRegistration/GetCompletedRegistrationsWithDetails

• ExternalRegistration/GetCompletedRegistrationsWithDetailsForUser

• ExternalUser/GetOrgUsers

• ExternalUser/GetAllVesselUsers

• ExternalUser/GetSkillGraderLoginUsers (new in 4.9.0)

Related tasks:

• https://rippleops.atlassian.net/browse/PSDEV-1254

• https://rippleops.atlassian.net/browse/COREDEV-5785

New CompletionLocation on Registration in ExternalRegistration API Endpoints

A completed registration JSON object as an additional property CompletionLocation. Once the registration is complete (i.e. all required grades have been met) the various grade locations are analyzed to determine the registration completion location. This will usually be the last grade submitted on the registration. However, LMS Evaluations and Attendances take precedent over Exams and SCORM grades as these are most likely to represent a physical location that needs to be recorded. Here are some example course setups and how the registration completion location would be set:

• SCORM course and exam > registration completion location will be set to the grade location of most recent one taken by the student

• Exam and an attendance > registration completion location will be set to the Attendance location

• SCORM and an evaluation >  registration completion location will be set to the Evaluation location

• SCORM, Evaluation and Attendance > registration completion location will be set to the location of the most recent Attendance or Evaluation grade.

Any API endpoint returning completed registrations will have the CompletionLocation property set.

Related tasks:

• https://rippleops.atlassian.net/browse/COREDEV-6451

New API Endpoints

• Post /Services/api/ExternalUser/ImportCsvUsers(string externalId, string userCsv, string dataSourceId = null)
  Related tasks:

  • https://rippleops.atlassian.net/browse/PSDEV-1260
    

  • https://rippleops.atlassian.net/browse/PSDEV-1186

• /Services/api/ExternalRegistration/GetCourseOfferingsByPath

• /Services/api/ExternalUser/GetSkillGraderLoginUsers

Discontinued API Endpoints

• /Services/api/ExternalRegistration/RecordTrainingEvent
  Related task: https://rippleops.atlassian.net/browse/COREDEV-6450

Extended Json Objects

The following endpoints returning user Grades will contain