Skip to end of banner
Go to start of banner

4.9.0 Web API Updates

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current Restore this Version View Version History

Version 1 Next »

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 Marine LMS Web API Documentation 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:

New API Endpoints

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

  • /Services/api/ExternalRegistration/GetCourseOfferingsByPath

  • /Services/api/ExternalUser/GetSkillGraderLoginUsers

Discontinued API Endpoints

  • /Services/api/ExternalRegistration/RecordTrainingEvent
    Related task: COREDEV-6450 - Getting issue details... STATUS

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.