Chamilo
Chamilo 1.11 - English
Chamilo 1.11 - English
  • Introduction
  • Teacher Guide
    • Introduction
    • Getting to know Chamilo
      • What is Chamilo?
      • About this guide
      • Who is this guide for?
      • How to use this guide.
      • General usability
      • Why Chamilo?
        • Learning paradigm
        • Common interface elements
    • The Chamilo homepage
    • Registering on the platform
    • Finding your way in Chamilo
    • Course creation
    • Control course access
    • Organizing courses
      • Personal categories
      • Subscribing to other courses
      • Courses management icons
    • Course administration
    • Course homepage
      • Introductory text
      • Authoring tools
      • Interaction tools
      • Administration tools
    • First Steps: Documents
      • Create a directory
      • Quick-change of directory
      • Importing a document
      • Authoring content in Chamilo
      • Saving documents
      • Deleting a file or a directory
      • Watching course quotas
      • Slideshow
    • Interactivity: Tests
      • Introduction
      • Creating a new test
      • Feedback, score and correct answers
      • Test types
      • Adding questions to the test
      • Recycling existing questions
      • Importing: HotPotatoes, IMS/QTI2, Excel
      • Test results
    • Communication : Forums
      • Using forum views
      • Add forum categories
      • Add forum
      • Manage forum categories
      • Manage forums
      • Start a new topic
      • Manage discussion threads
      • Manage messages
      • Give your learners a score
      • Give a score from a message
      • Add a message to a thread
      • Reply to a specific message
      • Quote a previous message
      • Reply or Reply to this topic
      • Search a forum element
    • Structure: Learning paths
      • Introduction
      • Create a learning path
      • Add Learning Objects and Activities
      • Import AICC and SCORM
      • Managing learning paths
      • Prerequisites
      • Generating certificates
    • Reporting
      • Tracking learners
      • Show individual learner's details
      • Course reporting
      • Resource Reporting
      • Test/exam Reporting
    • Assignments
      • Assignment creation
      • Completion of assignments by students
      • Manage assignments
      • Setting up the assignment evaluation
      • Assignment expiry dates
      • Marking assignments
    • Users
      • Subscribe users
    • Assessments
      • Assessments pre-configuration
      • Sub-assessments
      • Adding classroom activities
      • Adding online activities
      • Weights
      • List view
      • How students generate certificates
      • Students certificates management
      • Linking assessments with skills
      • Linking certificates with learning paths
    • Wiki
      • Starting the wiki
      • Add a new linked page
      • Add a new orphan page
      • Commenting a page
      • Other wiki features
    • Links
      • Links categories
      • Links
      • Manage links
      • Links checker
    • Announcements
      • Add an announcement
      • Announcements management
    • Glossary
      • New term
      • Glossary terms management
    • Attendances
      • Create an attendance sheet
      • Recording attendances
    • Course progress
      • Create a thematic section
      • Define the thematic plan
      • Create steps for the course progress
    • Agenda
      • Adding an event to the course agenda
      • Import and export events
      • Adding an event to the personal Agenda
    • Dropbox
      • Folders
      • Send a file to specific users
      • Managing dropbox files
      • Read and add comments on a file
    • Groups
      • Create a group
      • Groups settings
      • Auto-filling a group
      • Fill a group manually
      • Getting into a group space
      • Overview /Export of group members
      • Groups management
    • Chat
      • Send a message
      • Empty messages
    • Survey
      • Survey creation
      • Add survey questions
      • Survey preview
      • Survey publication
      • Results
      • Surveys management
    • Notebook
      • Notes creation
      • Sort notes
    • Projects
      • Project creation
      • Subscribe learners to a project
      • New article/task
      • Roles management
      • Assign a role to a learner
      • Indicate the execution of a task
      • Learners' task management
    • Course settings
      • Update general course settings
      • Visibility and access
      • E-mail notifications
      • User rights
      • Chat settings
      • Learning path settings
      • Thematic advance settings
    • Backup
      • Create a backup
      • Import backup
      • Copy course
      • Empty this course
    • The Reporting tab
      • Own courses and sessions reporting
    • Social network
      • Profile information
      • Internal messaging
      • “Friends”
      • Social groups
      • My files
    • Session view
      • Courses tab
      • Learning paths tab
      • My MCQ tab
      • My statistics tab
    • Appendix
      • Glossary
      • Frequently asked questions
      • Document license
      • Document history
  • Admin Guide
    • Getting to know Chamilo
      • About this guide
      • Whom is this guide meant for?
      • How to read this guide?
    • Installation and configuration
      • Server
      • Installation wizard
        • Launching the installation wizard
          • Step 1 of 6 : Language
          • Step 2 of 6 : Prerequisites
          • Step 3 of 6: License
          • Step 4 of 6 : MySQL database parameters
          • Step 5 of 6: Configuration settings
          • Step 6 of 6 : Last check before installation
        • Last installation settings
      • Updating Chamilo
        • Download the latest stable version
        • Replace the older version by the new one
    • Backups
      • External backups
        • PhpMyAdmin database backup
        • Command-line backup
        • The Chamilo root directory
      • Saving the Chamilo interface
        • Learning path export
        • Saving a course
      • Recovering a backup
        • Learning paths
        • Courses
        • Complete recovery
    • Platform administration
      • Chamilo configuration settings
        • Portal
        • Training (admin/courses)
        • Sessions
        • Languages
          • Creating a sub-language
          • Defining one's own terms
          • Assigning the new sub-language
        • Users
        • Modules
        • HTML Editor
        • Security
        • Tuning
        • Assessments
        • Time zones
        • Reporting
        • Search
        • Stylesheets
        • Templates
        • Plugins
        • LDAP
        • CAS
        • Shibboleth
        • Facebook
      • Portal news
      • Global agenda
      • Edit portal homepage
      • Setting the registration page
      • Statistics
      • Reports
    • Users management
      • User roles
        • Learner (admin/or student)
        • The course assistant
        • The human resources manager (admin/or supervisor)
        • The course coach
        • The session coach (admin/or session tutor)
        • Teacher (admin/or trainer)
        • Sessions administrator
        • Portal administrator
        • Global administrator
        • Special case: the anonymous user
      • Users list
        • Learner
        • Teacher
        • Administrator
        • Anonymous
      • Add a user
      • Export users list
      • Import users list
      • Add groups
      • Groups list
      • Profiling
    • Courses management
      • Courses list
        • Update course details
        • Tracking and backup
      • Create a course
      • Export courses
      • Import courses list
      • Courses categories
      • Add users to course
      • Import users list
    • Sessions management
      • Use cases
        • The academic year
        • Personal tutoring
        • Corporate induction courses
      • Managing the sessions
      • Add a session
      • Sessions categories (admin/or periods)
      • Export sessions list
      • Copy from course in session to another session
      • Move users results from/to a session
      • Careers and promotions
        • Careers
        • Promotions
        • Copy
        • Use case
      • Classes
    • System
      • Special exports
      • System status
      • Data filler
      • Archive directory clean-up
    • Global features
      • Multi-URL
        • Use case – University faculties
        • Use case – Corporate branding
        • The solution
        • Installation
      • Video-conference
      • Chamilo Rapid
      • Style sheets
      • Templates
      • Web services
      • The Prestashop plugin
      • The Drupal plugin
      • The xAPI plugin
      • Logging in with OpenID
      • Securing your site with SSL / HTTPS
      • Optimization
    • Appendix
      • Frequently asked questions
        • Sending e-mails from the platform doesn't work
        • How do I prevent teachers to subscribe or unsubscribe learners into/from their courses?
        • How do I block access to the course catalog for learners?
        • How much bandwidth does the videoconference tool (admin/BigBlueButton) consume?
      • Security in Chamilo LMS
      • Database structure
      • Accessing the database
      • Configuration settings list
      • Glossary
      • Document license
      • Document history
  • Developer Guide
    • Introduction
      • About this guide
      • Who is this guide for?
      • How to use this guide
      • General usability
    • Why Chamilo?
      • Learning paradigm
      • Common interface elements
    • The Chamilo files & database structure
      • History
      • Database structure : fixed in all minor versions
      • The Chamilo LMS files structure today
      • The Chamilo LMS database structure today
      • General conventions for future database structure
    • Coding conventions
    • Theming through templates
      • Cleaning the cache
      • Structure of a page
      • Usable variables
      • Modifiers
    • Theming through CSS
      • The cascading structure
      • Style files purposes
      • The stylesheets inclusion mechanism
      • Extending the icons set
      • Default course image
      • Example procedure for new design
    • Document templates
      • Structure
    • Theming certificates
    • Customizing the online editor
    • The Chamilo logo
    • Global settings
      • Sub-languages
    • Participating to the development
      • Using Git
      • Updating you code
    • Clear the template cache
    • Fixing bugs
    • System AdministratorsWeb services
      • SOAP, REST and XML-RPC
      • Connection and security key
      • Restriction on calling IP addresses
      • Other methods
    • Extra Chamilo fields
    • Plugins
      • General workflow of plugins
      • General plugins development
      • The Dashboard
      • Language variables
    • System AdministratorsAuthentication methods
      • LDAP
      • CAS
      • Shibboleth
      • Facebook
      • OpenID
      • Custom SSO methods
    • Passwords generation
Powered by GitBook
On this page
Export as PDF
  1. Developer Guide
  2. System AdministratorsWeb services

Other methods

Some of the other methods available, with a small explanation for each:

function WSCreateUsers($params)

Creates users in batches. Password is expected unencrypted (which is alright on HTTPS but not otherwise).

function WSCreateUser($params)

Creates just one user.

function WSCreateUsersPasswordCrypted($params)

Creates users taking into account their passwords might be encrypted. This method expects the following parameters :

$params = array(
    'secret_key' => $finalKey,
    'users' => array(
        0 => array(
            'firstname' => '…',
            'lastname' => '…',
            'status' => 5,
            'email' => '',
            'loginname' => '',
            'password' => '',
            'encrypt_method' => '',
            'language' => '',
            'phone' => '',
            'expiration_date' => '',
            'official_code' => '',
            'original_user_id_name' => '',
            'original_user_id_value'=> '',
            'extra' => ''
        )
    )
);

function WSCreateUserPasswordCrypted($params)

Creates just one user taking into account his password might be encrypted

function WSEditUserCredentials($params)

Edits one user's credentials (username + password)

function WSEditUsers($params)

Edit several users in batch.

function WSEditUser($params)

Edit just one user

function WSEditUsersPasswordCrypted($params)

Edit users, sending encrypted passwords

function WSEditUserPasswordCrypted($params)

Edit one user, sending encrypted password.

Warning : although very discrete, there is an issue in Chamilo LMS 1.9.* whereby WSCreateUserPasswordCrypted expects the username in the form of a « loginname » field, whereas WSEditUserPasswordCrypted expects the username in the form of a « username » field. Make sure you don't fall for this one, as it might be time-costly.

function WSDeleteUsers($params)

Delete users in batch

function WSDisableUsers($params)

Disable users in batch

function WSEnableUsers($params)

Enable users in batch

function WSCreateCourse($params)

Create a course

function WSCreateCourseByTitle($params)

Create a course giving only a title

function WSEditCourse($params)

Edit an existing course

function WSCourseDescription($params)

Get the course description for a given course

function WSEditCourseDescription($params)

Edit a course description

function WSDeleteCourse($params)

Delete a course

function WSCreateSession($params)

Create a session. This method expects the following parameters :

$params = array(
    'secret_key' => $finalKey,
    'sessions' => array(
        'name' => '',
        'year_start' => '',
        'month_start' => '',
        'day_start' => '',
        'year_end' => '',
        'month_end' => '',
        'day_end' => '',
        'nb_days_access_before' => '',
        'nb_days_access_after' => '',
        'nolimit' => '',
        //not used in session creation
        'user_id' => '',
        //the coach id
        'original_session_id_name' => '',
        'original_session_id_value'=> '',
        'extra' => ''
    )
);

function WSEditSession($params)

Edit one (or more) existing session(s) based on the original_session_id_value field. This method expects the following parameters :

$params = array(
    'secret_key' => $finalKey,
    'sessions' => array(
        0 => array(
            'name' => '',
            'year_start' => '',
            'month_start' => '',
            'day_start' => '',
            'year_end' => '',
            'month_end' => '',
            'day_end' => '',
            'nb_days_access_before' => '',
            'nb_days_access_after' => '',
            'original_session_id_name' => '',
            'original_session_id_value'=> '',
            'coach_username' => '',
            'nolimit' => '',
            'user_id' => '',
            //the coach id
            'extra' => ''
        ),
    )
);

function WSDeleteSession($params)

Delete a session

function WSSubscribeUserToCourse($params)

Subscribe a user to a course

function WSSubscribeUserToCourseSimple($params)

Subscribe a user to a course

function WSGetUser($params)

Get user information from a user ID

function WSGetUserFromUsername($params)

Get user information from a username

function WSUnsubscribeUserFromCourse($params)

Unsubscribe a user from a course

function WSSuscribeUsersToSession($params)

WARNING : please note the typing mistake here : the service is called « suscribe » instead of « subscribe ». For backwards compatibility, we left it that way, but make no mistake : you have to type it in an incorrect English to make it work !Subscribe a user to a session. This method expects the following parameters :

$params = array(
    'secret_key' => $finalKey,
    'userssessions' => array(
        0 => array(
            'original_user_id_name' => '',
            'original_user_id_value'=> '',
            'original_session_id_name' => '',
            'original_session_id_value'=> ''
        )
    )
);

function WSSubscribeUserToSessionSimple($params)

Unsubscribe a user from a session

function WSUnsuscribeUsersFromSession($params)

WARNING : See note in WSSuscribeUsersToSession

Unsubscribe several users from a session in batch

function WSSuscribeCoursesToSession($params)

WARNING : See note in WSSuscribeUsersToSession

Subscribe several users to a session in batch. This method expects the following parameters :

$params = array(
    'secret_key' => $finalKey,
    'coursessessions' => array(
        0 => array(
            'original_course_id_name' => '',
            'original_course_id_values' => array(
                0 => array(
                    'course_code' => '',
                    //external course ID (can be int)
                ),
            ),
            'original_session_id_name'=> '',
            'original_session_id_value'=> '',
        )
    )
);

function WSUnsuscribeCoursesFromSession($params)

WARNING : See note in WSSuscribeUsersToSession

Remove a course from a session

function WSListCourses($params)

Gets a list of courses available on the platform

function WSUpdateUserApiKey($params)

Update the API key of a user

function WSListSessions($params)

Lists the sessions available on the platform

PreviousRestriction on calling IP addressesNextExtra Chamilo fields

Last updated 4 years ago