Outils pour utilisateurs
dev:api:ezforms
Documentation API EzForms wrapper:
Transformes les données de ezforms/recupData.php en json et les parse pour l'application copieur / desktop. base url du Webservice: ezformsapp
1) ezformsapp/getapps
Paramètre du Webservice: identifiant
identifiant => correspond a l'id de l'utilisateur (secusr_id)
Retour du Webservice: liste des applications pour cet utilisateur
exemple: {
"errorcode": 0,
"errormsg": "ok",
"count": 2,
"rows": [
{
"EZFORMS_APP_DESC": "test",
"EZFORMS_APP_ID": "1",
"EZFORMS_APP_HISTO": "1",
"EZFORMS_APP_TYPHISTO": "1"
},
{
"EZFORMS_APP_DESC": "rara",
"EZFORMS_APP_ID": "3",
"EZFORMS_APP_HISTO": "0",
"EZFORMS_APP_TYPHISTO": "0"
}
]
}
2) ezformsapp/getcustomparams
Retour du Webservice: Paramètres de configuration visuel pour l'application
exemple : {
"errorcode": 0,
"errormsg": "ok",
"count": 8,
"rows": {
"EZFORMS_PARAMS_LOGOPNG": "logo.png",
"EZFORMS_PARAMS_COLORSBANDEAU": "255,255,255",
"EZFORMS_PARAMS_POLICEBANDEAU": "140,159,176",
"EZFORMS_PARAMS_COLORSFONDBTN": "255,255,255",
"EZFORMS_PARAMS_COLORSBORDUREBTN": "174,209,125",
"EZFORMS_PARAMS_COLORSPOLICEBTN": "174,209,125",
"EZFORMS_PARAMS_COLORSFONDLOGO": "255,255,255",
"EZFORMS_PARAMS_TXTBANDEAU": "GED haute performance"
}
}
3) ezformsapp/gethistoric
Paramètre du Webservice: applie, id
applie => id de l'application
id => id de l'utilisateur (secusr_id)
Retour du Webservice: Nom de l'application, compteur de validation, compteur d'attente, compteur de refus,
liste d'historique contenant la date, l'etat et l'rsid
exemple : {
"errorcode": 0,
"errormsg": "ok",
"count": 3,
"rows": [
{
"EZFORMS_APP_DESC": "test",
"VALIDE_COUNT": "0",
"WAITING_COUNT": "3",
"REFUSAL_COUNT": "0",
"historic": [
{
"EZFORMS_RESPONSEDATA_DATE": "25/05/2021",
"EZFORMS_RESPONSEDATA_ETAT": "0",
"EZFORMS_RESPONSEDATA_ID": "3"
},
{
"EZFORMS_RESPONSEDATA_DATE": "18/05/2021",
"EZFORMS_RESPONSEDATA_ETAT": "0",
"EZFORMS_RESPONSEDATA_ID": "2"
},
{
"EZFORMS_RESPONSEDATA_DATE": "03/04/2021",
"EZFORMS_RESPONSEDATA_ETAT": "0",
"EZFORMS_RESPONSEDATA_ID": "4"
}
]
}
]
}
4) ezformsapp/gethistoriclistdate
Paramètre du Webservice: applie, id
applie => id de l'application
id => id de l'utilisateur (secusr_id)
Retour du Webservice: nom de l'application, liste d'historique par mois-année
exemple: {
"errorcode": 0,
"errormsg": "ok",
"count": 2,
"rows": {
"EZFORMS_APP_DESC": "test",
"historic": [
{
"FULLDATE": "Mai 2021",
"MONTH": "Mai",
"YEAR": "2021"
},
{
"FULLDATE": "Avril 2021",
"MONTH": "Avril",
"YEAR": "2021"
}
]
}
}
5) ezformsapp/gethistoricbydate
Paramètre du Webservice: applie, id, mois, annee
applie => id de l'application
id => id de l'utilisateur (secusr_id)
mois => nom du mois (ex: Mai or mai)
annee => 4 chiffre (ex: 2021)
Retour du Webservice: nom de l'application, compteur de validation, compteur d'attente, compteur de refus,
liste d'historique contenant la date, l'etat et l'rsid. Filtré par les parametres mois et année
exemple : {
errorcode": 0,
"errormsg": "ok",
"count": 2,
"rows": [
{
"EZFORMS_APP_DESC": "test",
"VALIDE_COUNT": "0",
"WAITING_COUNT": "2",
"REFUSAL_COUNT": "0",
"historic": [
{
"EZFORMS_RESPONSEDATA_DATE": "25/05/2021",
"EZFORMS_RESPONSEDATA_ETAT": "0",
"EZFORMS_RESPONSEDATA_ID": "3"
},
{
"EZFORMS_RESPONSEDATA_DATE": "18/05/2021",
"EZFORMS_RESPONSEDATA_ETAT": "0",
"EZFORMS_RESPONSEDATA_ID": "2"
}
]
}
]
}
6) ezformsapp/formulaire
parametres du Webservice: applie, page, id, pageprecedente
applie => id de l'application
page => numero de la page
id => id de l'utilisateur (secusr_id)
pageprecedente => numero de la page page precedente
Retour du Webservice: rsid de responsedata, nom de la page, type de la page, numero de page suivante,
nombre de widget sur la page (exclu widget_type_id: 4 - 5 - 6).
widget = liste des champs pour creer le formulaire:
widget type id, nom du champ, nom du champ dans la bdd, nombre de caractères max, champ requis,
valeur du champ par défautut
exemple: {
errorcode": 0,
"errormsg": "ok",
"count": 3,
"rows": [
{
"EZFORMS_RESPONSEDATA_ID": "7",
"EZFORMS_PAGE_DESC": "PageOne",
"EZFORMS_PAGE_TYPE": "1",
"EZFORMS_PAGE_SUIVANTE": "2",
"NUMBER_WIDGET": "2",
"widget": [
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "1",
"EZFORMS_WIDGET_DESC": "test",
"EZFORMS_WIDGET_VARNAME": "STATS_KM",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "test"
},
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "4",
"EZFORMS_WIDGET_DESC": "photo",
"EZFORMS_WIDGET_VARNAME": "",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "0"
},
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "1",
"EZFORMS_WIDGET_DESC": "desc",
"EZFORMS_WIDGET_VARNAME": "STATS_LIB",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "0"
}
]
}
]
}
7) ezformsapi/getpagesbyappid
parametres du Webservice: appid, id
appid => id de l'application
id => id de l'utilisateur (secusr_id)
Retour du Webservice: liste de pages contenant les informations des widget
exemple: {
"errorcode": 0,
"errormsg": "ok",
"count": 2,
"rows": [
{
"EZFORMS_RESPONSEDATA_ID": "24",
"EZFORMS_PAGE_DESC": "Page One",
"EZFORMS_PAGE_TYPE": "1",
"EZFORMS_PAGE_SUIVANTE": "2",
"NUMBER_WIDGET": "1",
"widget": [
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "1",
"EZFORMS_WIDGET_DESC": "Lib",
"EZFORMS_WIDGET_VARNAME": "STATS_LIB",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "0"
}
]
},
{
"EZFORMS_RESPONSEDATA_ID": "24",
"EZFORMS_PAGE_DESC": "Page Two",
"EZFORMS_PAGE_TYPE": "1",
"EZFORMS_PAGE_SUIVANTE": "0",
"NUMBER_WIDGET": "2",
"widget": [
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "1",
"EZFORMS_WIDGET_DESC": "Page T - Lib",
"EZFORMS_WIDGET_VARNAME": "STATS_LIB",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "0"
},
{
"EZFORMS_WIDGET_EZFORMS_WIDGET_TYPEID": "2",
"EZFORMS_WIDGET_DESC": "Date",
"EZFORMS_WIDGET_VARNAME": "STATS_LIB",
"EZFORMS_WIDGET_LIMITLENGTH": "0",
"EZFORMS_WIDGET_REQUIRED": "0",
"EZFORMS_WIDGET_DEFAULTVALUE": "0"
}
]
}
]
}
8) ezformsapi/setdata:
parametres du Webservice: identifiant, applie, idligne, data
identifiant => id de l'utilisateur (secusr_id)
applie => id de l'application
idligne => rsid de _ezforms_responsedata correspondante
data => json string des données a enregistrer dans la table _ezforms_responsedata
Retour du Webservice:
exemple: {
"errorcode": 0,
"errormsg": "ok",
"count": 0,
"rows": []
}
dev/api/ezforms.txt · Dernière modification: 2023/03/17 09:56 (modification externe)
Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : CC Attribution-Share Alike 4.0 International
