Reporting Service

API V1 reference

This page applies to SCORM Cloud API V1. You can check out the API V2 reference here.

Reporting Service

This service provides a set of methods for accessing information about or owned by the account designated by the appid, and ties in with the Reportage reporting application. For more information about accessing Reportage, check out the Reportage Integration Documentation.



getAccountInfo

  • Semantics: This method returns information about the account specified by the given appid

  • Required Arguments:

    • appid-- Your application id

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.reporting.getAccountInfo&appid=myappid

  • Example response:

    <account>
   <email>email@example.com</email>
   <firstname>Test</firstname>
   <lastname>Man</lastname>
   <company>Test Company, Inc.</company>
   <accounttype>little</accounttype>
   <reglimit>50</reglimit>
   <strictlimit>false</strictlimit>
   <createdate>2009-10-22T08:55:08-0500</createdate>
   <usage>
     <monthstart>2009-10-22T08:55:08-0500</monthstart>
     <regcount>23</regcount>
     <totalregistrations>89</totalregistrations>
     <totalcourses>8</totalcourses>
   </usage>
</account>



getReportageAuth

  • Semantics: This method serves as the first step for entry into the Reportage application. It returns a session authentication that can be used in subsequent calls to launchReport. The parameters given affect the rights session, like navigation permissions, and access to admin privileges. For more information about accessing Reportage, check out the Reportage Integration Documentation

  • Required Arguments:

    • appid-- Your application id
    • navpermission-- The navigation permissions for the session. This can be one of three values: NONAV, DOWNONLY, or FREENAV. NONAV will cause the Reportage session to prevent any navigation away from the original report or widget. DOWNONLY will allow the user to drill down to detailed subsections of the report. FREENAV will allow the user to use full navigation in Reportage, and the ability to change any reporting parameters they wish.

  • Optional Arguments:

    • admin-- A boolean (“true” or “false” only) parameter specifying whether or not to grant admin privileges to the launching Reportage session. See Reportage documentation for more info.

  • Example call:

    http://cloud.scorm.com/api?method=rustici.reporting.getReportageAuth&appid=myappid&navpermission=NONAV(&admin=true)

  • Example response :

        <auth enabled="true">appId=myappid&ts=20101026223117&admin=true&navPermission=NONAV&sig=66F16D0903D9D6D953E7EB5DE914620F</auth>



launchReport

  • Semantics: This method serves as the entry for the Reportage application. The desired Reportage URL is passed through the reporturl parameter. The authentication and permissions for the session are passed using the auth parameter, which should match the authentication token retrieve from a previous call to getReportageAuth. For more information about accessing Reportage, check out the Reportage Integration Documentation

  • Required Arguments:

    • appid-- Your application id
    • auth-- The reportage authentication token retrieved from a previous call to getReportageAuth
    • reporturl-- The plain text Reportage URL that you want to access. This would typically either be the Reportage homepage “Reportage/reportage.php?appId=[your appid here]” or a URL pointing to a specific report within Reportage. The latter type of URL includes lots of parameters of the report, such as the date range, demographic (via tags), specific course or learner, and so on. These URLs can be found in the Reportage UI as an administrative user, see Reportage user documentation for more info (and screenshots).

  • Example call:

    http://cloud.scorm.com/api?method=rustici.reporting.launchReport&appid=myappid&auth=appId%3Dmyappid%26ts%3D20101026223117%26admin%3Dtrue%26navPermission%3DNONAV%26sig%3D66F16D0903D9D6D953E7EB5DE914620F&reporturl=http%3A//cloud.scorm.com/Reportage/reportage.php%3FappId%3Dmyappid

(note that the Reportage URL in this case is http://cloud.scorm.com/Reportage/reportage.php?appId=myappid)

  • Example response : Redirect browser to requested Reportage URL. (In this case, to the Reportage home page.)