/ 
WebService-ScormCloud-0.03
River stage zero No dependents
/ WebService::ScormCloud::Service::Course

NAME

WebService::ScormCloud::Service::Course - ScormCloud API "course" namespace

VERSION

Version 0.03

SYNOPSIS

use WebService::ScormCloud;

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

print "Found a course\n" if $ScormCloud->courseExists('123');

my $course_list = $ScormCloud->getCourseList;

DESCRIPTION

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

METHODS

courseExists ( course_id )

Given a course ID, returns true if that course exists.

getMetadata ( course_id )

Given a course ID, returns course metadata.

getCourseList ( [ filters ] )

Returns an arrayref containing a list of courses. 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 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":

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

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

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::Course

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.