Documentación Web Services
Enviado por Harold Perez Cardenas • 19 de Noviembre de 2015 • Tutoriales • 13.429 Palabras (54 Páginas) • 145 Visitas
Documentación Web Services.
Documentación de los Web Services disponibles en Moodle.
Para utilizar un Web Service de moodle existen tres protocolos diferentes, XML-RPC protocol, SOAP protocol y REST protocol. Cada uno de estos tres protocolos tiene dos maneras de autenticar a los usuarios. Por autenticación simple o por token. A continuación se explica en que consiste cada uno de los protocolos disponibles en android.
moodle_group_create_groups
Este servicio web permite la creación de un nuevo grupo en moodle. Para crear un nuevo grupo es necesario pasar al web service una serie de parámetros de entrada. Estos parámetros son token, courseid, name, description, enrolmentkey.
- Token: permite la autenticación del usuario en el servicio y comprobar que el usuario que está consumiendo el servicio tiene privilegios para ellos.
- Courseid: identificador del curso en el cual querempos crear el grupo
- name: nombre del grupo que vamos a crear, debe ser único.
- Enrolmentkey: frase secreta para inscribirse en un grupo.
Para poder utilizar dicho web service podemos utilizar cada uno de los tres protocolos que hemos explicado anteriormete y ademas tenemos dos manera de autenticación. Si elegimos la opción de autenticarnos por token, unicamente debemos pasar al web service como entrada el token del usuario y una matriz con el usuario/s que queremos consultar. Si todo funciona bien, el web service nos devolverá una lista de objetos con todos los datos pertenecientes al usuario (id, username, firstname...).
En caso de producirse un error (el usuario no tiene los suficientes permisos para consumir este web service, no existe este usuario en la base de datos, no hay usuarios con los ids que se han pasado como parámetros), el web service devolverá una estructura con el siguiente error: “Invalid parameter value detected, execution can not continue.”
Los parámetros de entrada que hemos descrito anteriormente, se pasan al web service en forma de un array de elementos.
A continuación se describe la entrada del web service con los diferentes protocolos:
- Parámetros de entrada
Parámetro obligatorio | Courseid, name, description, enrolmentkey |
Estructura general | list of ( int //user ID )//List of group object. A group has a courseid, a name, a description and an enrolment key. list of ( object { courseid int //id of course name string //multilang compatible name, course unique description string //group description text enrolmentkey string //group enrol secret phrase } ) |
XML-RPC | XML-RPC (PHP structure) [groups] => Array ( [0] => Array ( [courseid] => int [name] => string [description] => string [enrolmentkey] => string ) ) |
REST (post parameters) | userids[0]= int groups[0][courseid]= int groups[0][name]= string groups[0][description]= string groups[0][enrolmentkey]= string |
- Respuesta
Una lista de objetos. Un grupo tiene un id, courseid, un nombre, y un enrolmentkey
Estructura general | //List of group object. A group has an id, a courseid, a name, a description and an enrolment key. list of ( object { id int //group record id courseid int //id of course name string //multilang compatible name, course unique description string //group description text enrolmentkey string //group enrol secret phrase } ) |
XML-RPC | Array ( [0] => Array ( [id] => double [username] => string [firstname] => string [lastname] => string [email] => string [auth] => string [confirmed] => double [idnumber] => string [emailstop] => double [lang] => string [theme] => string [timezone] => string [mailformat] => int [description] => string [city] => string [country] => string [customfields] => Array ( [0] => Array ( [type] => string [value] => string ) ) ) ) Array ( [0] => Array ( [id] => int [courseid] => int [name] => string [description] => string [enrolmentkey] => string ) ) Array ( [0] => Array ( [id] => int [courseid] => int [name] => string [description] => string [enrolmentkey] => string ) ) |
REST (post parameters) |
|
- Mensaje de error
REST (post parameters) | |
moodle_group_add_groupmembers
Web service diseñado para implemetar la funcionalidad de poder añadir nuevos miebros al grupo. Ese grupo puede ser uno creado mediante una “vía” normal o utilizando el web service especificado anteriormente. Para añadir nuevos miembros al grupo es necesario pasar al web service una serie de parámetros de entrada. Estos parámetros son token, userid, groupid.
...