Web services / API¶

• Table of contents
• Web services / API
  • Introduction
  • Chamilo > 1.8.8.4
    • WSUser.EditUserCredentials
      • Input
      • Output
  • Chamilo > 1.8.7
    • External identifiers
    • WSUser.DisableUser
      • Input
      • Output
    • WSUser.DisableUsers
      • Input
      • Output
    • WSUser.EnableUser
      • Input
      • Output
    • WSUser.EnableUsers
      • Input
      • Output
    • WSUser.DeleteUser
      • Input
      • Output
    • WSUser.DeleteUsers
      • Input
      • Output
    • WSUser.CreateUser
      • Input
      • Output
    • WSUser.CreateUsers
      • Input
      • Output
    • WSUser.EditUser
      • Input
      • Output
    • WSUser.EditUsers
      • Input
      • Output
    • WSCourse.DeleteCourse
      • Input
      • Output
    • WSCourse.DeleteCourses
      • Input
      • Output
    • WSCourse.CreateCourse
      • Input
      • Output
    • WSCourse.CreateCourses
      • Input
      • Output
    • WSCourse.EditCourse
      • Input
      • Output
    • WSCourse.ListCourses
      • Input
      • Output
    • WSCourse.SubscribeUserToCourse
      • Input
      • Output
    • WSCourse.UnsubscribeUserFromCourse
      • Input
      • Output
    • WSCourse.GetCourseDescriptions
      • Input
      • Output
    • WSCourse.EditCourseDescription
      • Input
      • Output
    • WSSession.CreateSession
      • Input
      • Output
    • WSSession.DeleteSession
      • Input
      • Output
    • WSSession.EditSession
      • Input
      • Output
    • WSSession.SubscribeUserToSession
      • Input
      • Output
    • WSSession.UnsubscribeUserFromSession
      • Input
      • Output
    • WSSession.SubscribeCourseToSession
      • Input
      • Output
    • WSSession.UnsubscribeCourseFromSession
      • Input
      • Output
  • Chamilo <= 1.8.7: registration.soap.php

Introduction¶

The following documentation gives a description (although somewhat outdated) of the behaviour of the Chamilo Web Services.
We use SOAP as a Web Service application protocol (although it would be easy to extend to other protocols). As such, all communication should be sent using SOAP headers and received using a SOAP parser.

To use Chamilo's webservices from systems written in python, you can use web2py as described in this link.

If you want to know about more Chamilo web services, please check the main/webservices/ folder in Chamilo. Many scripts are available there for your use as API.

Chamilo > 1.8.8.4¶

Please check the introduction to Chamilo > 1.8.7 first

WSUser.EditUserCredentials¶

Edits the username and/or (unencrypted) password

Input¶

array(
 'secret_key' => 'abcdef1234567890',
 'user_id_field_name' => 'external_user',
 'user_id_value' => '1504',
 'username' => 'slee',
 'password' => 'abcdef'
);

Output¶

1 (or -1 on failure)

Chamilo > 1.8.7¶

The 'secret_key' is a mandatory parameter to connect to the web services. It is composed of the $_configuration['secret_key'] value inside of the LMS's main/inc/conf/configuration.php file (which can be changed, it is only used for web services at the time of writing) and the IP address of the caller.

For example, if I am calling the webservice from an IP address of 134.23.25.34, I will have to generate an SHA1 encrypted string from this IP addess with the secret key. This can be done for example, in PHP, through the command:

$security_key = 'abcdef1234567890';
$ip_address = '134.23.25.34';
$secret_key = sha1($ip_address.$security_key);

The $secret_key variable must then be added to the Web Service call.

Calling the SOAP web services scripts is generally done through a URL of this kind:
http://campus.chamilo.org/main/webservices/soap.php. You can check the list of available functions through a call to http://campus.chamilo.org/main/webservices/soap.php?wsdl

You can check how your IP is detected by the server, calling the http://campus.chamilo.org/main/webservices/testip.php script. The first line can be cut
and used as the IP address to put in the $ip_address variable above (just remove the end-of-line character at the end of the first line).

External identifiers¶

For most Web Services provided, an identifier and a value are expected by Chamilo. For example, if you import your users from an Oracle database, you might use a unique ID coming from the LUSERID field and worth 1504. When calling Chamilo, we assume you will give us the user ID as you know it in your system. That is, we expect you'll give us LUSERID as the user_id_field_name parameter, and 1504 as the user_id_value.

When you do that, Chamilo is able to find, inside its database, which user you are referencing, because Chamilo kept this reference at the time of calling.

WSUser.DisableUser¶

Disables one user

Input¶

array(
 'secret_key' => 'abcdef1234567890',
 'user_id_field_name' => 'external_user',
 'user_id_value' => '1504',
);

Output¶

nothing (or error message)

WSUser.DisableUsers¶

Disables several users in one call.

Input¶

array(
'secret_key' => 'abcdef1234567890',
 array( 
  0=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1504'),
  1=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1582'),
 )
);

Output¶

array(
  0=>array('code'=>0,'message'=>'Operation was successful'),
  1=>array('code'=>0,'message'=>'Operation was successful'),
);

WSUser.EnableUser¶

Enables one user

Input¶

array(
 'secret_key' => 'abcdef1234567890',
 'user_id_field_name' => 'external_user',
 'user_id_value' => '1504',
);

Output¶

nothing (or error message)

WSUser.EnableUsers¶

Enables several users in one call.

Input¶

array(
'secret_key' => 'abcdef1234567890',
 array( 
  0=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1504'),
  1=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1582'),
 )
);

Output¶

array(
  0=>array('code'=>0,'message'=>'Operation was successful'),
  1=>array('code'=>0,'message'=>'Operation was successful'),
);

WSUser.DeleteUser¶

Deletes one user

Input¶

array(
 'secret_key' => 'abcdef1234567890',
 'user_id_field_name' => 'external_user',
 'user_id_value' => '1504',
);

Output¶

nothing (or error message)

WSUser.DeleteUsers¶

Deletes several users in one call

Input¶

array(
'secret_key' => 'abcdef1234567890',
 array( 
  0=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1504'),
  1=>array('user_id_field_name' => 'external_user', 'user_id_value' => '1582'),
 )
);

Output¶

array(
  0=>array('code'=>0,'message'=>'Operation was successful'),
  1=>array('code'=>0,'message'=>'Operation was successful'),
);

WSUser.CreateUser¶

Creates one user

Input¶

array(
'secret_key' => 'xsd:string',
'firstname' => 'xsd:string',
'lastname' => 'xsd:string',
'status' => 'xsd:int',
'loginname' => 'xsd:string',
'password' => 'xsd:string',
'encrypt_method' => 'xsd:string',
'user_id_field_name' => 'xsd:string',
'user_id_value' => 'xsd:string',
'visibility' => 'xsd:int',
'email' => 'xsd:string',
'language' => 'xsd:string',
'phone' => 'xsd:string',
'expiration_date' => 'xsd:string',
'extras' => 'tns:extra_field[]'
);

Output¶

int new_user_id

WSUser.CreateUsers¶

Creates several users in one call.

Input¶

array(
 'secret_key' => 'xsd:string',
 array(
  0 => array(
   'firstname' => 'xsd:string',
   'lastname' => 'xsd:string',
   'status' => 'xsd:int',
   'loginname' => 'xsd:string',
   'password' => 'xsd:string',
   'encrypt_method' => 'xsd:string',
   'user_id_field_name' => 'xsd:string',
   'user_id_value' => 'xsd:string',
   'visibility' => 'xsd:int',
   'email' => 'xsd:string',
   'language' => 'xsd:string',
   'phone' => 'xsd:string',
   'expiration_date' => 'xsd:string',
   'extras' => 'tns:extra_field[]'
  ),
  1 => array(
   'firstname' => 'xsd:string',
   'lastname' => 'xsd:string',
   'status' => 'xsd:int',
   'loginname' => 'xsd:string',
   'password' => 'xsd:string',
   'encrypt_method' => 'xsd:string',
   'user_id_field_name' => 'xsd:string',
   'user_id_value' => 'xsd:string',
   'visibility' => 'xsd:int',
   'email' => 'xsd:string',
   'language' => 'xsd:string',
   'phone' => 'xsd:string',
   'expiration_date' => 'xsd:string',
   'extras' => 'tns:extra_field[]'
  )
 )
);

Output¶

array(
 0 => array(
  'result' => 'xxx',
  'user_id_value' => 1504,
  'user_id_generated' => 1
 ),
 1 => array(
  'result' => 'xxx',
  'user_id_value' => 1504,
  'user_id_generated' => 1
 ),
);

WSUser.EditUser¶

Edits one user

Input¶

Output¶

WSUser.EditUsers¶

Edits several users in one call.

Input¶

Output¶

WSCourse.DeleteCourse¶

Deletes one course

Input¶

Output¶

WSCourse.DeleteCourses¶

Deletes several courses in one call.

Input¶

Output¶

WSCourse.CreateCourse¶

Creates one course

Input¶

Output¶

WSCourse.CreateCourses¶

Creates several courses in one call.

Input¶

Output¶

WSCourse.EditCourse¶

Edits one course

Input¶

Output¶

WSCourse.ListCourses¶

Lists courses

Input¶

Output¶

WSCourse.SubscribeUserToCourse¶

Subscribes one user to one course

Input¶

Output¶

WSCourse.UnsubscribeUserFromCourse¶

Unsubscribes one user from one course.

Input¶

Output¶

WSCourse.GetCourseDescriptions¶

Gets the list of course descriptions.

Input¶

Output¶

WSCourse.EditCourseDescription¶

Edits one description of one course.

Input¶

Output¶

WSSession.CreateSession¶

Creates one session.

Input¶

Output¶

WSSession.DeleteSession¶

Deletes one session.

Input¶

Output¶

WSSession.EditSession¶

Edits one session.

Input¶

Output¶

WSSession.SubscribeUserToSession¶

Subscribes one user to one session.

Input¶

Output¶

WSSession.UnsubscribeUserFromSession¶

Unsubscribes one user from one session

Input¶

Output¶

WSSession.SubscribeCourseToSession¶

Subscribes one course to one session.

Input¶

Output¶

WSSession.UnsubscribeCourseFromSession¶

Unsubscribes one course from one session

Input¶

Output¶

Chamilo <= 1.8.7: registration.soap.php¶

The following documentation gives a complete description of the behaviour of the Chamilo Web Services. These