NxTIC/config/modules.json

{
	"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": {}
		},


		"markdown": {
			"description": "Retourne une description en markdown des différents modules de l'API",
			"permissions": [],
			"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"          },
				"permission": { "description": "Permissions de l'utilisateur : 'admin' ou 'subject'", "type": "varchar(5,7)"  }
			}
		},


		"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": {
				"phone_number": { "description": "Numéro de téléphone de l'interrogé.", "type": "number" }
			}
		}
	},

	"chart": {

		"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": "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": {

		"getById": {
			"description": "Retourne les informations d'un sujet.",
			"permissions": ["admin"],
			"parameters": {
				"id_subject": { "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(0,30)"                  },
				"firstname"  : { "description": "Prénom du sujet, 30 caracteres maximum.",   "type": "varchar(0,30)"                  },
				"lastname"   : { "description": "Nom du sujet, 30 caracteres maximum.",      "type": "varchar(0,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": "number",       "optional": true }
			}
		},


		"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>" }

			}
		}
	},


	"upload": {

		"call_log": {
			"description": "Upload d'un journal d'appel au format .xml.",
			"permissions": ["admin"],
			"parameters": {
				"phone_number": { "description": "Numéro de téléphone de l'interrogé.", "type": "number" },
				"file":         { "description": "Fichier du journal d'appel.",         "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": {

		"phone": {
			"description": "Download des données relatives à une enquête téléphonique.",
			"permissions": ["admin"],
			"options": { "download": true },
			"parameters": {
				"subjects": { "description": "Identifiants des sujets à intégrer.", "type": "array<id>" }
			}
		}
	}
}