Application Service

This service provides a simple interface to add and manage SCORM Cloud applications along with their secret keys. This interface uniquely requires authorization with your App Management AppId and secret key. The App Management App Id is not created by default. You can find or create the App Management AppId in the Apps tab of SCORM Cloud

getAppList

  • Semantics: Calling this method will return the list of applications associated with your realm.

  • Required Arguments:

  • Example Call:

    http://cloud.scorm.com/api?method=rustici.application.getAppList&appid=myappmanagementappid
    
  • Example response:

    <rsp stat="ok">
        <applicationlist>
            <application>
                <appId>63OT2YDL3L</appId>
                <name>
                    <![CDATA[ Production]]>
                </name>
                <createDate>2013-04-23T20:21:05.644+0000</createDate>
            </application>
            <application>
                <appId>M6DL0KRE3O</appId>
                <name>
                    <![CDATA[ Development ]]>
                </name>
                <createDate>2013-04-24T15:32:58.807+0000</createDate>
            </application>
            <application>
                <appId>3XZBZYRREM</appId>
                <name>
                    <![CDATA[ Forwarding Test Endpoint ]]>
                </name>
                <createDate>2014-02-05T17:50:54.241+0000</createDate>
            </application>
            <application>
                <appId>UUOBZYYC62</appId>
                <name>
                    <![CDATA[ New App ]]>
                </name>
                <createDate>2014-10-09T19:46:41.149+0000</createDate>
            </application>
        </applicationlist>
    </rsp>
    

getAppInfo

  • Semantics: Calling this method will return a detailed document of application information.

  • Required Arguments:

  • Example call:

    http://cloud.scorm.com/api?method=rustici.application.getAppInfo&appid=myappmanagementappid&childappid=myappid
    
  • Example response:

    <appInfo>
        <application>
            <appId>63OT2YDL3L</appId>
            <name>
                <![CDATA[ Appname 2.0 ]]>
            </name>
            <allowDeleteAPI>true</allowDeleteAPI>
            <allowUpdateAPI>true</allowUpdateAPI>
            <createDate>2013-04-23T20:21:05.644+0000</createDate>
            <secretKeys>
                <secretKey id="525e8fd3-6c5d-445b-a957-398ce0447852">
                    <key>uVZig2mFyCUvJg8uPZVTgFZrOFv7DkNObfv4dbLL</key>
                    <pensKey>58064A1B9C28B58C95940BBA8225CAE1</pensKey>
                    <description>
                        <![CDATA[ Second Test Key ]]>
                    </description>
                    <active>false</active>
                    <createDate>2014-10-06T20:50:50.721+0000</createDate>
                </secretKey>
                <secretKey id="3771289a-6a3e-4ecc-b1dd-8ea9b105ae6d">
                    <key>BZoLEbbwSrNVuiShE5dz7XK2aMuAjZJarCmlWAkE</key>
                    <pensKey>86F09D04CEDD592DD99079AA9E12016B</pensKey>
                    <description>
                        <![CDATA[ For testing ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-13T19:39:24.999+0000</createDate>
                </secretKey>
            </secretKeys>
        </application>
    </appInfo>
    

createApplication

  • Semantics: A call to this method will create a new SCORM Cloud Application and return the appId.

  • Required Arguments:

  • Example call:

    https://cloud.scorm.com/EngineWebServices/api?method=rustici.application.createApplication&appid=myappmanagementappid&name=App+for+Learning+Client
    
  • Example response:

    <appInfo>
        <application>
            <appId>CKHT7MJ7CG</appId>
            <name>
                <![CDATA[ App for Learning Client ]]>
            </name>
            <allowDeleteAPI>false</allowDeleteAPI>
            <allowUpdateAPI>true</allowUpdateAPI>
            <createDate>2014-10-22T17:56:28.301+0000</createDate>
            <secretKeys>
                <secretKey id="2b8e61c3-30db-4a32-ac54-fb4e256df04a">
                    <key>Mxs2wlnvcWnyPKHtvYM573cDCFPPWJlpQxH91arL</key>
                    <pensKey>38AC7E9E3E7B1E7C313675901C8B1EE9</pensKey>
                    <description>
                        <![CDATA[ First Secret Key ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-22T17:56:28.301+0000</createDate>
                </secretKey>
            </secretKeys>
        </application>
    </appInfo>
    

updateApplication

  • Semantics: Calling this method allows you to update the name and/or registration deletion permissions for an application..

  • Required Arguments:

  • Optional Arguments:

    • name– A name or description for the new application
    • allowdelete : ‘true’ or ‘false’. Sets whether deleteRegistration can be used with this app.
  • Example call:

    http://cloud.scorm.com/api?method=rustici.application.updateApplication&appid=myappmanagementappid&childappid=myappid&name=New+Name&allowdelete=true
    
  • Example response:

    <appInfo>
        <application>
            <appId>Z7BVISEQ50</appId>
            <name>
                <![CDATA[ New Name ]]>
            </name>
            <allowDeleteAPI>false</allowDeleteAPI>
            <allowUpdateAPI>true</allowUpdateAPI>
            <createDate>2014-10-22T18:12:50.832+0000</createDate>
            <secretKeys>
                <secretKey id="1c95a4a0-17d6-4827-98d7-2f6ce3b469f8">
                    <key>GE7YmU5nDrJRn0BIrdanuzaO0yxgqUlFEMis2hpj</key>
                    <pensKey>94EF674BEE0AE8F50C3D071B1BF53C79</pensKey>
                    <description>
                        <![CDATA[ First Secret Key ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-22T18:12:50.832+0000</createDate>
                </secretKey>
            </secretKeys>
        </application>
    </appInfo>
    

addSecretKey

  • Semantics: Calling this method creates a new secret key associated with the given child appId.

  • Required Arguments:

    • appid– Your app management app id
    • childappid– Non-privileged app id. Call getAppList for a complete list of app id’s associated with your realm.
    • description– A string describing this secret key.
  • Example call:

    http://cloud.scorm.com/api?method=rustici.application.addSecretKey&appid=myappmanagementappid&childappid=myappid&description=Key+For+Learning+Group+B&allowdelete=true
    
  • Example response:

    <appInfo>
        <application>
            <appId>CKHT7MJ7CG</appId>
            <name>
                <![CDATA[ App for Learning Client ]]>
            </name>
            <allowDeleteAPI>false</allowDeleteAPI>
            <allowUpdateAPI>true</allowUpdateAPI>
            <createDate>2014-10-22T17:56:28.301+0000</createDate>
            <secretKeys>
                <secretKey id="2b8e61c3-30db-4a32-ac54-fb4e256df04a">
                    <key>Mxs2wlnvcWnyPKHtvYM573cDCFPPWJlpQxH91arL</key>
                    <pensKey>38AC7E9E3E7B1E7C313675901C8B1EE9</pensKey>
                    <description>
                        <![CDATA[ First Secret Key ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-22T17:56:28.301+0000</createDate>
                </secretKey>
                <secretKey id="074f533f-6886-479e-8672-431cd9872cf1">
                    <key>S5yhb9TXjGcdLAllNGRR4S9rTxSMg4UCcBiw7mWi</key>
                    <pensKey>EED93FB6370726AF6D4EF94F5C91594F</pensKey>
                    <description>
                        <![CDATA[ Key For Learning Group B ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-22T18:21:41.953+0000</createDate>
                </secretKey>
            </secretKeys>
        </application>
    </appInfo>
    

updateSecretKey

  • Semantics: Calling this method updates a secret key associated with the given keyId.

  • Required Arguments:

    • appid– Your app management app id
    • childappid– Non-privileged app id. Call getAppList for a complete list of app id’s associated with your realm.
    • secretkeyid– The secretKeyId associated with the key to be updated. Key ID’s can be retrieved by calling getAppInfo.
  • Optional Arguments:

    • description– A string describing this secret key.
    • active : ‘true’ or ‘false’. Enables or disables this secret key for use.
  • Example call:

    http://cloud.scorm.com/api?method=rustici.application.updateSecretKey&appid=myappmanagementappid&childappid=myappid&secretkeyid=mysecretkeyid&description=Key+For+Learning+Group+Z&active=false
    
  • Example response:

    <appInfo>
        <application>
            <appId>CKHT7MJ7CG</appId>
            <name>
                <![CDATA[ App for Learning Client ]]>
            </name>
            <allowDeleteAPI>false</allowDeleteAPI>
            <allowUpdateAPI>true</allowUpdateAPI>
            <createDate>2014-10-22T17:56:28.301+0000</createDate>
            <secretKeys>
                <secretKey id="2b8e61c3-30db-4a32-ac54-fb4e256df04a">
                    <key>Mxs2wlnvcWnyPKHtvYM573cDCFPPWJlpQxH91arL</key>
                    <pensKey>38AC7E9E3E7B1E7C313675901C8B1EE9</pensKey>
                    <description>
                        <![CDATA[ First Secret Key ]]>
                    </description>
                    <active>true</active>
                    <createDate>2014-10-22T17:56:28.301+0000</createDate>
                </secretKey>
                <secretKey id="074f533f-6886-479e-8672-431cd9872cf1">
                    <key>S5yhb9TXjGcdLAllNGRR4S9rTxSMg4UCcBiw7mWi</key>
                    <pensKey>EED93FB6370726AF6D4EF94F5C91594F</pensKey>
                    <description>
                        <![CDATA[ Key For Learning Group Z ]]>
                    </description>
                    <active>false</active>
                    <createDate>2014-10-22T18:21:41.953+0000</createDate>
                </secretKey>
            </secretKeys>
        </application>
    </appInfo>
    

deleteSecretKey

  • Semantics: Calling this method deletes a secret key associated with the given keyId.

  • Required Arguments:

    • appid– Your app management app id
    • childappid– Non-privileged app id. Call getAppList for a complete list of app id’s associated with your realm.
    • secretkeyid– The secretKeyId associated with the key to be deleted. Key ID’s can be retrieved by calling getAppInfo.
  • Example call:

    http://cloud.scorm.com/api?method=rustici.application.deleteSecretKey&appid=myappmanagementappid&childappid=myappid&secretkeyid=mysecretkeyid
    
  • Example response:

    <appInfo>
        <application>
        <appId>CKHT7MJ7CG</appId>
        <name>
            <![CDATA[ App for Learning Client ]]>
        </name>
        <allowDeleteAPI>false</allowDeleteAPI>
        <allowUpdateAPI>true</allowUpdateAPI>
        <createDate>2014-10-22T17:56:28.301+0000</createDate>
        <secretKeys>
            <secretKey id="2b8e61c3-30db-4a32-ac54-fb4e256df04a">
                <key>Mxs2wlnvcWnyPKHtvYM573cDCFPPWJlpQxH91arL</key>
                <pensKey>38AC7E9E3E7B1E7C313675901C8B1EE9</pensKey>
                <description>
                    <![CDATA[ First Secret Key ]]>
                </description>
                <active>true</active>
                <createDate>2014-10-22T17:56:28.301+0000</createDate>
            </secretKey>
        </secretKeys>
        </application>
    </appInfo>