Follow

Registration Postback APIs

Avatar

It is crucial for Learning Management Systems to stay current with the state of learner progress, as this can affect everything from reporting to learner menus. One inefficient method to stay up-to-date on registration state would be to regularly poll rustici.registration.getRegistrationResult while a learner is taking training (or, worse, all the time). This unfocused, brute force approach is taxing on network resources. A better approach is SCORM Cloud’s postback feature. SCORM Cloud can optionally post a registration report to a listening endpoint you designate. This report is the same as that returned by rustici.registration.getRegistrationResult. SCORM Cloud issues this post when synchronizing registration state, which makes registration postbacks a great way to keep your LMS as up-to-date as SCORM Cloud without having to poll.

About

You can setup a postback right in the rustici.registration.createRegistration API call . We supply several options for authtype, allowing you to securely authenticate the requests posted to your listening endpoint. Since postbackurl is associated with a registration, you can specify a postback url per registration and include any necessary query string elements you desire. We also offer the same registration report format options as those provided with getRegistrationResult.

We also supply a rustici.registration.testRegistrationPostUrl API which will allow you to verify SCORM Cloud can successfully reach your endpoint with its post request. Make sure your postback endpoint is using http/https default ports (80 or 443) and returning a 200 OK response to post requests, as SCORM Cloud will retry failed post attempts. You can read more about using the testRegistrationPostUrl here.

If you want to enable registration postbacks on your existing registrations, you should use rustici.registration.updatePostbackInfo API Call to enable the postback on an existing registration. You may wish to do a one-time batch operation by calling rustici.registration.getRegistrationList and looping through your registrations, calling updatePostbackInfo on each.

Our postback APIs are rounded out by rustici.registration.getPostbackInfo and rustici.registration.deletePostbackInfo, providing a full suite of CRUD operations with which to manage your postback settings.

Context

Postbacks are not intended to wholly replace rustici.registration.getRegistrationResult. Calling rustici.registration.launch with a redirecturl and issuing a getRegistrationResult call when your learners view that page is still the recommended model. But this should be done in tandem with postbacks, as postbacks provides a mechanism for SCORM Cloud to issue updates about your learners while they’re viewing content in the SCORM Cloud player.

Conclusion

Registration postbacks are an elegant solution for reporting user registration state as updates occur. As always, if you have any questions please don’t hesitate to contact support@rusticisoftware.com.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk