247 lines
5.3 KiB
JSON
Executable File
247 lines
5.3 KiB
JSON
Executable File
{
|
|
|
|
|
|
"machineDefault" :[
|
|
"create",
|
|
|
|
"link",
|
|
"unlink",
|
|
|
|
"search",
|
|
|
|
"getAll",
|
|
"getById",
|
|
"getByCode",
|
|
"getByName",
|
|
|
|
"getClusters",
|
|
|
|
"edit",
|
|
|
|
"delete"
|
|
]
|
|
|
|
}
|
|
|
|
|
|
{
|
|
|
|
"userDefault": {
|
|
"create": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
"code": { "description": "Code RFID de l'utilisateur.", "type": "rfid" },
|
|
"username": { "description": "Identifiant de l'utilisateur.", "type": "varchar(1,30)" },
|
|
"firstname": { "description": "Prénom de l'utilisateur.", "type": "varchar(3,30)" },
|
|
"lastname": { "description": "Nom de l'utilisateur.", "type": "varchar(3,30)" },
|
|
"mail": { "description": "Adresse mail de l'utilisateur.", "type": "mail" },
|
|
"password": { "description": "Mot de passe de l'utilisateur.", "type": "text" },
|
|
"status": { "description": "Status de l'utilisateur.", "type": "status" }
|
|
},
|
|
"output": {
|
|
"id_user": { "description": "UID de l'utilisateur créé.", "type": "id" },
|
|
"id_group": { "description": "UID du groupe de l'utilisateur.", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"link": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"unlink": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"search": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"getAll": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"getById": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"getByCode": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"getByUsername": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"getClusters": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"edit": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
},
|
|
|
|
"delete": {
|
|
"description": "blablabla",
|
|
"permissions": [],
|
|
"parameters": {
|
|
|
|
},
|
|
"output": {
|
|
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
"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": {}
|
|
}
|
|
},
|
|
|
|
|
|
"upload": {
|
|
|
|
"call_log": {
|
|
"description": "Upload d'un journal d'appel au format .xml. Retour des données de call_log/unserialize",
|
|
"permissions": ["admin"],
|
|
"parameters": {
|
|
"file": { "description": "Fichier du journal d'appel.", "type": "FILE" }
|
|
},
|
|
"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>" }
|
|
}
|
|
}
|
|
},
|
|
|
|
|
|
"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 }
|
|
}
|
|
}
|
|
}
|
|
}
|