RETOUR 

LES RESULTATS

Lexique des différents resultats. Le résultat d'une requête varie en fonction de l'action qui a été éffectuée.
Les retours sont toujours envoyé en JSON. Dans les exemples ci-dessous l'entité contact est utilisée. Voici la liste des différent retour possible :

LISTE

Retour lors d'une demande de listing d'une entité.
PROTOTYPE 
 
                     
{
    'result'     : 1,
    'data'       : [
                    {
                       'idcontact'   : {'title' : 'idcontact', 'value' : 2000}, 
                       'nom_contact' : {'title' : 'Nom', 'value' : 'Cornet'}, ... 
                    }, 
                    {
                       'idcontact'   : {'title' : 'idcontact', 'value' : 2001}, 
                       'nom_contact' : {'title' : 'Nom', 'value' : 'Dupont'}, ... 
                    },
                        ... 
                   ], 
    'nbpage'     : 438, 
    'nbelements' : 21884
}
EXPLICATION Le retour est un objet contenant 4 élements principaux :

result : qui est la booléenne du résultat. 1 signifiant que tout à eu lieux correctement.
Si la valeur est à 0 merci de consulter erreur en bas de cette page.

data : qui va contenir un tableaux numérique contenants les différents éléments retourné.
Celui çi dépendra donc de l'entité appellée.
Pour chacun des champs de l'entité, le titre du champs et sa valeur seront retourné.

nbpage : le nombre de page totale pour la requêtes éffectuée.
La pagination commençant à 0 dans l'api, il y aura des éléments jusque nbpage - 1 .

nbelements : le nombre d'élement total disponible pour la requêtes.
CAS SPÉCIAUX
  • La liste des champs variant en fonction de l'entité, merci de vous référencer à la partie 'champs' de l'entité correspondante dans le menu à gauche.
  • Si la page (pagination) demandée n'existe pas, un result 1 est retourné, avec un tableau de data vide. nbpage et nbelements restent inchangés
  • Si l'entité est vide, le comportement est le même que pour une page qui n'existe pas. Il retournera un nbelement et un nbpage à 0.

DÉTAILS

Retour lors d'une demande de details d'un élément d'une entité.
PROTOTYPE 
 
                     
{
    'result' : 1, 
	'data' : 
            {
                'idcontact' : {'title' : 'idcontact', 'value' : 2005}, 
                'nom_contact' : {'title' : 'Nom', 'value' : 'DAMIEN'}
            }
}
EXPLICATION Le retour est un objet contenant 2 élements principaux :

result : qui est la booléenne du résultat. 1 signifiant que tout à eu lieux correctement.
Si la valeur est à 0 merci de consulter erreur en bas de cette page.

data : qui va contenir l'élément retourné.
Celui çi dépendra donc de l'entité appellée.
CAS SPÉCIAUX
  • Si l'élément n'existe pas dans l'entité, un result 0 est retourné. Voir erreur plus bas.

AJOUTER

Retour lors qu'un élément a été ajouté à une entité.
PROTOTYPE 
 
                     
{
    'result'    : 1,
    'idcontact' : 2664
}
EXPLICATION Deux champs sont retournés, result à 1.
Un id, qui représente l'élement qui a été créé, le nom du champs variera en fonction de l'entité.
Il faut donc se référencer aux champs de l'entité en question.
CAS SPÉCIAUX
  • Si l'ajout n'as pas fonctionné, un result 0 est retourné. Voir erreur plus bas.

EDITER

Retour lors qu'un élément d'une entité a été modifié.
PROTOTYPE 
 
                     
{
        'result'  : 1, 
	'message' : 'Le contact a bien été mis à jours' 
}
EXPLICATION Deux champs sont retourné, result à 1 et message qui signale qu'un élément d'une entité a été mis à jour correctement .
CAS SPÉCIAUX
  • Si la modification n'as pas fonctionné, un result 0 est retourné. Voir erreur plus bas.

SUPPRIMER

Retour lors qu'un élément est supprimé d'une entité.
PROTOTYPE 
 
                     
{
        'result'  : 1,
	'message' : 'Le contact a bien été archivé.'
}
EXPLICATION Deux champs sont retourné, result à 1 et message qui signale qu'un élément d'une entité a été 'supprimer'/'archiver' .
CAS SPÉCIAUX
  • Si la suppression n'as pas fonctionné, un result 0 est retourné. Voir erreur plus bas.

ERREUR

Retour lors qu'il y a une erreur.
PROTOTYPE 
 
                     
{
        'result'      : 0, 
	'err_code'    : 'ELEM_UNEXIST_INSUFFICIENT_RIGHT' , 
	'err_message' : 'L'element n'existe pas ou vous n'avez pas les droits. (id: 10000)' 
}
EXPLICATION 3 élément sont retourné lors d'une erreur. Le result à 0.
L'err_code qui est le code d'erreur de l'erreur qui a eu lieux et err_message qui est le message d'erreur expliqué.
Tout les err_code ainsi que leur err_message sont disponible sur la LISTE DES MESSAGES dans le sous menu general.
CAS SPÉCIAUX
  • Si une autre erreur que le JSON vous est retournée, merci de contacter le support.
  • Consultez l'ensemble des codes et messages sur la page LISTE DES MESSAGES, sous catégorie du menu GENERAL.