{ "module": { "method": { "description": "Test de l'API", "permissions": [], "parameters": {} }, "phpunitParams": { "description": "Méthode utile à phpunit pour le test des paramètres.", "permissions": [], "parameters": { "p1": { "description": "Texte", "type": "text" }, "p2": { "description": "Entier positif", "type": "id" } } }, "phpunitOptionalParams": { "description": "Méthode utile à phpunit pour le test des paramètres optionnels.", "permissions": [], "parameters": { "p1": { "description": "Texte", "type": "text" }, "p2": { "description": "Texte", "type": "text", "optional": false }, "p3": { "description": "Entier positif (optionnel)", "type": "id", "optional": true } } }, "phpunitPermissions": { "description": "Méthode utile à phpunit pour le test des permissions.", "permissions": ["a", "b"], "parameters": {} } }, "user": { "login": { "description": "Connexion avec un login (identifiant ou adresse mail) et un mot de passe.", "permissions": [], "parameters": { "login": { "description": "Identifiant ou adresse mail", "type": "varchar(3,50)" }, "password": { "description": "Mot de passe", "type": "text" } } }, "logout": { "description": "Deconnexion", "permissions": [], "parameters": {} }, "getById": { "description": "Retourne les informations d'un utilisateur.", "permissions": ["admin"], "parameters": { "id_user": { "description": "UID de l'utilisateur recherche.", "type": "id" } } }, "getAll": { "description": "Retourne les informations de tous les utilisateurs.", "permissions": ["admin"], "parameters": {} }, "create": { "description": "Creation d'un nouvel utilisateur.", "permissions": ["admin"], "parameters": { "login" : { "description": "Login de l'utilisateur, 30 caracteres maximum.", "type": "varchar(3,30)" }, "password" : { "description": "Mot de passe de l'utilisateur.", "type": "text" }, "mail" : { "description": "Adresse mail de l'utilisateur.", "type": "mail" }, "reference" : { "description": "UID d'une personne d'un sondage, peut etre vide.", "type": "text" }, "permissions": { "description": "Liste des permissions de l'utilisateur.", "type": "text" } } }, "remove": { "description": "Suppression d'un utilisateur.", "permissions": ["admin"], "parameters": { "id_user": { "description": "UID de l'utilisateur", "type": "id" } } } }, "call_log": { "unserialize": { "description": "Recupere le contenu d'un fichier XML de journal d'appel.", "permissions": [], "parameters": { "file_content": { "description": "Contenu du fichier XML", "type": "text" }, "phone_number": { "description": "Numéro de téléphone de l'interrogé.", "type": "phone_number" } } } }, "charts": { "network_data": { "description": "Renvoie un jeu de donnees fictif pour un graphique de type #network.", "permissions": [], "parameters": {} }, "network_render": { "description": "Renvoie le contenu du svg representant un graphique de type #network avec les donnees recues.", "permissions": [], "parameters": { "dataset": { "description": "Dataset au bon format pour un graphique de type #network." } } } }, "token": { "remove": { "description": "Suppression d'un token d'id donne.", "permissions": ["admin"], "parameters": { "token_id": { "description": "UID du token a supprimer", "type": "id" } } }, "generate": { "description": "Creation d'un token de nom et de duree donnee", "permissions": ["admin"], "parameters": { "name" : { "description": "Nom attribue au token", "type": "varchar(3,50)" }, "duration": { "description": "Duree du token en nombre de jours", "type": "numeric" } } } }, "subject": { "getById": { "description": "Retourne les informations d'un sujet.", "permissions": ["admin"], "parameters": { "id_user": { "description": "UID du sujet recherche.", "type": "id" } } }, "getAll": { "description": "Retourne les informations de tous les sujets.", "permissions": ["admin"], "parameters": {} }, "create": { "description": "Creation d'un nouveau sujet.", "permissions": ["admin"], "parameters": { "username" : { "description": "Pseudo du sujet, 30 caracteres maximum.", "type": "varchar(3,30)" }, "firstname" : { "description": "Prénom du sujet, 30 caracteres maximum.", "type": "varchar(3,30)" }, "lastname" : { "description": "Nom du sujet, 30 caracteres maximum.", "type": "varchar(3,30)" }, "id_facebook": { "description": "Id facebook du sujet (optionnel).", "type": "id", "optional": true }, "number" : { "description": "Numéro de téléphone du sujet (optionnel).", "type": "text" } } }, "remove": { "description": "Suppression d'un utilisateur.", "permissions": ["admin"], "parameters": { "id_user": { "description": "UID de l'utilisateur", "type": "id" } } } } }