Larry Leszczynski > WebService-ScormCloud > WebService::ScormCloud::Service::Registration

Download:
WebService-ScormCloud-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

WebService::ScormCloud::Service::Registration - ScormCloud API "registration" namespace

VERSION ^

Version 0.03

SYNOPSIS ^

    use WebService::ScormCloud;

    my $ScormCloud = WebService::ScormCloud->new(
                        app_id      => '12345678',
                        secret_key  => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
    );

    my $registration_list = $ScormCloud->getRegistrationList;

DESCRIPTION ^

This module defines WebService::ScormCloud API methods in the "registration" namespace. See WebService::ScormCloud for more info.

METHODS ^

createRegistration ( course_id, registration_id, first_name, last_name, learner_id [ , options_hashref ] )

Creates a new registration.

Required arguments are:

course_id
registration_id
first_name
last_name
learner_id

Valid options include:

email
postbackurl
authtype
urlname
urlpass
resultsformat
disableTracking

deleteRegistration ( registration_id )

Given a registration ID, delete the corresponding registration.

resetRegistration ( registration_id )

Given a registration ID, reset the corresponding registration.

getRegistrationList ( [ filters ] )

Returns an arrayref containing a list of registrations. The returned list might be empty.

The optional filters hashref can contain any of these entries to filter the returned list of registrations:

filter

A regular expression for matching the registration ID

coursefilter

A regular expression for matching the course ID

Note that any filter regular expressions must match the entire string. (There seems to be an implied ^...$ around the supplied pattern.) So to match e.g. any courses that begin with "ABC":

    {coursefilter => '^ABC'}    # THIS WILL NOT WORK

    {coursefilter => 'ABC.*'}   # This will work

getRegistrationResult ( registration_id [ , results_format ] )

Given a registration ID, returns registration results.

Optional results_format can be "course" (the default), "activity", or "full".

getRegistrationListResults ( )

Effectively, runs getRegistrationList to get all the registrations, and then runs getRegistrationResult on each of them.

Not implemented yet.

launchURL ( registration_id , $redirect_url [ , options_hashref ] )

Given a registration ID and redirect URL, returns a URL that can be used in the browser to launch the test at cloud.scorm.com.

Valid options include:

cssurl
learnerTags
courseTags
registrationTags
disableTracking

resetGlobalObjectives ( registration_id )

Given a registration ID, reset any global objectives associated with the corresponding registration.

updateLearnerInfo ( learner_id, fname, lname [ , new_id ] )

Reset learner info previously given during registration creation.

Not implemented yet.

SEE ALSO ^

WebService::ScormCloud

AUTHOR ^

Larry Leszczynski, <larryl at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-scormcloud at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-ScormCloud. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Patches more than welcome, especially via GitHub: https://github.com/larryl/ScormCloud

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc WebService::ScormCloud::Service::Registration

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2010 Larry Leszczynski.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: