438 lines
17 KiB
JSON
Executable File
438 lines
17 KiB
JSON
Executable File
{
|
|
"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" }
|
|
},
|
|
"output": {
|
|
"receivedArguments": { "description": "Liste des arguments reçus par la méthode", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"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": {}
|
|
},
|
|
|
|
|
|
"markdown": {
|
|
"description": "Retourne une description en markdown des différents modules de l'API",
|
|
"permissions": [],
|
|
"options": { "download": true },
|
|
"parameters": {}
|
|
},
|
|
|
|
|
|
"apiBlueprint": {
|
|
"description": "Retourne une documentation de l'API au format API Blueprint.",
|
|
"permissions": [],
|
|
"options": { "download": true },
|
|
"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" }
|
|
},
|
|
"output": {
|
|
"id_user": { "description": "Identifiant de l'utilisateur connecté", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"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" }
|
|
},
|
|
"output": {
|
|
"user": { "description": "Propriétés de l'utilisateur en question.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
|
|
"getAll": {
|
|
"description": "Retourne les informations de tous les utilisateurs.",
|
|
"permissions": ["admin"],
|
|
"parameters": {},
|
|
"output": {
|
|
"users": { "description": "Propriétés de tous les utilisateurs existants.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
|
|
"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" },
|
|
"permission": { "description": "Permissions de l'utilisateur : 'admin' ou 'subject'", "type": "varchar(5,7)" }
|
|
},
|
|
"output": {
|
|
"id_user": { "description": "Identifiant de l'utilisateur créé", "type": "id" }
|
|
}
|
|
},
|
|
|
|
|
|
"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 s'il a été importé au préalable.",
|
|
"permissions": [],
|
|
"parameters": {},
|
|
"output": {
|
|
"tmp_id": { "description": "Identifiant temporaire du journal d'appel", "type": "varchar(40,40)" },
|
|
"directory": { "description": "Annuaire des contacts trouvés", "type": "array<array<mixed>>" },
|
|
"call": { "description": "Liste des identifiants des contacts triés par nombre d'appels", "type": "array<id>" },
|
|
"sms": { "description": "Liste des identifiants des contacts triés par nombre de sms", "type": "array<id>" }
|
|
}
|
|
}
|
|
},
|
|
|
|
"chart": {
|
|
|
|
"direction": {
|
|
"description": "Renvoie les données pour un graphique sur les sens de communications",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"type": {
|
|
"description": "Renvoie les données pour un graphique sur les types de communications",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"sexe": {
|
|
"description": "Renvoie les données pour un graphique sur le sexe des contacts",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"ages": {
|
|
"description": "Renvoie les données pour un graphique sur les ages des contacts",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"xlabels": { "description": "Labels des abscisses", "type": "array<text>" },
|
|
"zoom": { "description": "Paramètres du zoom", "type": "varchar(1,1)" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"ytitle": { "description": "Titre des ordonnées", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"relations": {
|
|
"description": "Renvoie les données pour un graphique sur les types de relations des contacts",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"xlabels": { "description": "Labels des abscisses", "type": "array<text>" },
|
|
"ytitle": { "description": "Titre des ordonnées", "type": "text" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"weekdays": {
|
|
"description": "Renvoie les données pour un graphique sur les communication parmi les jours de la semaine",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"xlabels": { "description": "Labels des abscisses", "type": "array<text>" },
|
|
"ytitle": { "description": "Titre des ordonnées", "type": "text" },
|
|
"pointFormat": { "description": "Format des labels des graphiques", "type": "text" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"duration": {
|
|
"description": "Renvoie les données pour un graphique sur les temps de communication",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"xaxis": { "description": "Paramètres des abscisses", "type": "array<mixed>" },
|
|
"ytitle": { "description": "Titre des ordonnées", "type": "text" },
|
|
"zoom": { "description": "Paramètres du zoom", "type": "varchar(1,1)" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"timeofday": {
|
|
"description": "Renvoie les données pour un graphique sur les heures de communication",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"type": { "description": "Type de graphique", "type": "text" },
|
|
"title": { "description": "Titre du graphique", "type": "text" },
|
|
"xlabels": { "description": "Labels des abscisses", "type": "array<text>" },
|
|
"zoom": { "description": "Paramètres du zoom", "type": "varchar(1,1)" },
|
|
"series": { "description": "Séries de données et paramètres", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"network": {
|
|
"description": "Renvoie les données pour un graphique relationnel de type 'réseau'",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Identifiant du sujet à étudier,", "type": "id" }
|
|
},
|
|
"output": {
|
|
"nodes": { "description": "Liste des noeuds du graphe (contacts)", "type": "array<array<mixed>>" },
|
|
"edges": { "description": "Liste des liens du graphe", "type": "array<array<mixed>" }
|
|
}
|
|
}
|
|
},
|
|
|
|
"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": "Création d'un token de nom et de durée donnée",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"name": { "description": "Nom attribué au token", "type": "varchar(3,50)" },
|
|
"duration": { "description": "Durée du token en nombre de jours", "type": "id" }
|
|
}
|
|
}
|
|
},
|
|
|
|
"subject": {
|
|
|
|
"search": {
|
|
"description": "Recherche d'un sujet par nom",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"name": { "description": "Le nom du sujet", "type": "varchar(1,50)" }
|
|
}
|
|
},
|
|
|
|
"getFriends": {
|
|
"description": "Retourne les informations de tous les contacts renseignés par un sujet d'enquête.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject_id": { "description": "Identifiant du sujet duquel on veut les amis.", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"getAll": {
|
|
"description": "Retourne les informations de tous les sujets.",
|
|
"permissions": ["admin"],
|
|
"parameters": {}
|
|
},
|
|
|
|
|
|
"create": {
|
|
"description": "Creation d'un nouveau sujet.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"name" : { "description": "Pseudo du sujet, 50 caracteres maximum.", "type": "varchar(1,50)" }
|
|
}
|
|
},
|
|
|
|
|
|
"merge": {
|
|
"description": "Fusion de 2 sujets qui sont en fait la même personne.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"id_source": { "description": "UID de l'utilisateur doublon", "type": "id" },
|
|
"id_target": { "description": "UID de l'utilisateur déjà existant", "type": "id" }
|
|
}
|
|
},
|
|
|
|
|
|
"remove": {
|
|
"description": "Suppression d'un sujet d'id donné.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"id_subject": { "description": "UID du sujet à supprimer.", "type": "id" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
"input": {
|
|
|
|
"phone": {
|
|
"description": "Enregistre les données d'une enquête téléphonique.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Données sur le sujet de l'enquête.", "type": "array" },
|
|
"contacts": { "description": "Données des contacts de l'enquête.", "type": "array<array>" },
|
|
"mini": { "description": "Mini fiches relations sur les contacts de l'enquête.", "type": "array<array>" },
|
|
"fiches": { "description": "Fiches relation sur les plus proches contacts de l'enquête.", "type": "array<array>" },
|
|
"matrice": { "description": "Matrice contenant les relations entre les plus proches contacts", "type": "array<array>", "optional": true }
|
|
|
|
}
|
|
},
|
|
|
|
"facebook": {
|
|
"description": "Enregistre les données d'une enquête facebook.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"subject": { "description": "Données sur le sujet de l'enquête.", "type": "array" },
|
|
"contacts": { "description": "Données des contacts de l'enquête.", "type": "array<array>" },
|
|
"mini": { "description": "Mini fiches relations sur les contacts de l'enquête.", "type": "array<array>" },
|
|
"fiches": { "description": "Fiches relation sur les plus proches contacts de l'enquête.", "type": "array<array>" },
|
|
"matrice": { "description": "Matrice contenant les relations entre les plus proches contacts", "type": "array<array>", "optional": true }
|
|
|
|
}
|
|
}
|
|
},
|
|
|
|
|
|
"upload": {
|
|
|
|
"call_log": {
|
|
"description": "Upload d'un journal d'appel au format .xml.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"file": { "description": "Fichier du journal d'appel.", "type": "FILE" }
|
|
}
|
|
},
|
|
|
|
|
|
"iexplorer_convert": {
|
|
"description": "Convertisseur .txt (iExplorer) vers .xml (Call Log)",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"file": { "description": "Fichier exporté de iExplorer", "type": "FILE" }
|
|
}
|
|
},
|
|
|
|
|
|
"local_data": {
|
|
"description": "Upload d'une sauvegarde de formulaire local au format .json.",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"file": { "description": "Fichier du de sauvegarde de formulaire local.", "type": "FILE" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
"download": {
|
|
|
|
"multiple": {
|
|
"description": "Download des données relatives aux sujets donnés.",
|
|
"permissions": ["admin"],
|
|
"options": { "download": true },
|
|
"parameters": {
|
|
"subjects": { "description": "Identifiants des sujets d'enquêtes à intégrer.", "type": "array<id>", "optional": true },
|
|
"phone": { "description": "Si vaut TRUE, renvoie les sujets cellulaires.", "type": "boolean", "optional": true },
|
|
"facebook": { "description": "Si vaut TRUE, renvoie les sujet facebook.", "type": "boolean", "optional": true },
|
|
"survey": { "description": "Si vaut TRUE, renvoie les sujets ResTIC.", "type": "boolean", "optional": true },
|
|
"all": { "description": "Si vaut TRUE, renvoie tous les sujets enregistrés.", "type": "boolean", "optional": true }
|
|
}
|
|
},
|
|
|
|
"chart": {
|
|
"description": "Download des données relatives aux sujets donnés sur le principe noeuds+liens.",
|
|
"permissions": ["admin"],
|
|
"options": { "download": true },
|
|
"parameters": {
|
|
"subjects": { "description": "Identifiants des sujets d'enquêtes à intégrer.", "type": "array<id>", "optional": true },
|
|
"phone": { "description": "Si vaut TRUE, renvoie les sujets cellulaires.", "type": "boolean", "optional": true },
|
|
"facebook": { "description": "Si vaut TRUE, renvoie les sujet facebook.", "type": "boolean", "optional": true },
|
|
"survey": { "description": "Si vaut TRUE, renvoie les sujets ResTIC.", "type": "boolean", "optional": true },
|
|
"all": { "description": "Si vaut TRUE, renvoie tous les sujets enregistrés.", "type": "boolean", "optional": true }
|
|
}
|
|
}
|
|
}
|
|
}
|