Post Back Schema

API V2 reference

This page applies to SCORM Cloud API V2. If you're looking for our V1 api reference see here

PostBackSchema

Fields

Name Required Description Schema
url false String
authType false Optional parameter to specify how to authorize against the given postbackurl, can be 'form' or 'httpbasic'. If form authentication, the username and password for authentication are submitted as form fields 'username' and 'password', and the registration data as the form field 'data'. If httpbasic authentication is used, the username and password are placed in the standard Authorization HTTP header, and the registration data is the body of the message (sent as text/xml content type). This field is set to 'form' by default. String
userName false The user name to be used in authorizing the postback of data to the URL specified by postback url. String
password false The password to be used in authorizing the postback of data to the URL specified by postback url. String
resultsFormat false This parameter allows you to specify a level of detail in the information that is posted back while the course is being taken. It may be one of three values: 'course' (course summary), 'activity' (activity summary, or 'full' (full detail), and is set to 'course' by default. The information will be posted as xml, and the format of that xml is specified below under the method 'getRegistrationResult' String
legacy false This paramenter is ONLY used for backwards compatibility with XML postback implementations. You probably shouldn't need to use this unless you're currently transitioning from the V1 api to the V2 api and already have existing XML postback logic in your application, but have not yet built out JSON postback logic. If a registration is created with the V2 api we will assume that you're expecting JSON results unless otherwise specified. Boolean