Debug Service

API V1 reference

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

Debug Service

This service provides a very basic set of simple method calls to check the status of a running web service instance.



ping

  • Semantics: This method simply responds to the user. Its purpose is to have a simple way of testing the underlying mechanisms for delivering the web services (i.e. the web service \“core\“) and making sure the instance is up and running

  • Required Arguments: none

  • Optional Arguments: none

  • Example call:

    http://cloud.scorm.com/api?method=rustici.debug.ping

  • Example response:

    <pong />



authPing

  • Semantics: This method simply responds to the user. Its purpose is to have a simple way of testing the underlying mechanisms for delivering the web services (i.e. the web service “core”) and making sure the instance is up and running, as well as providing the simplest test for ensuring that the credentials for signing (and the signing process) are valid.

  • Required Arguments:

    • appid-- Your application id

  • Optional Arguments: none

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.debug.authPing&appid=myappid

  • Example response:

    <pong />



getTime

  • Semantics: This method returns the time on the running instance, in (UTC/GMT) timezone in the form ‘yyyyMMddHHmmss’. This format is used for the timestamp that is part of the security mechanism.

  • Required Arguments: none

  • Optional Arguments: none

  • Example call:

    http://cloud.scorm.com/api?method=rustici.debug.getTime

  • Example response:

    <currenttime  tz="UTC">20081217152345</currenttime>