Réponse des points d'entrée (Endpoint)
Réponses du verbe GET
Dans le cas d'une réponse avec un code HTTP en 2xx, le WebService retourne un corps en JSON correspondant à la définition de la structure du point d'entrée.
Dans le cas d'une réponse avec un code HTTP en 4xx ou 5xx, le WebService retourne un corps en JSON correspondant à la définition de réponse générique.
Réponse des verbes POST, PATCH et DEL
Sauf indication contraire, les verbes POST, PATCH et DEL retournent un corps en JSON correspondant à la définition de réponse générique.
Réponse générique
|
Nom de la rubrique |
Type de rubrique |
Détail |
|
Code |
Chaîne(*) |
Code de la réponse. |
|
Description |
Chaîne(*) |
Description de la réponse. |
|
Rubrique |
Chaîne(*) |
Si l'information est disponible, la rubrique sur laquelle porte la réponse. |
Listing des codes réponses
Ci dessous la liste des codes réponses par code HTTP.
A noter les descriptions ci-dessous sont standard et peuvent changer lors de la réponse du WebService afin d'apporter des précisions.
Listing des codes réponses pour un code HTTP en 2xx
|
Code |
Description |
|
Succes |
Dans le cas d'un verbe POST,PATCH ou DEL la description contient la clé de l’élément créé, modifié, ou supprimé. |
Listing des codes réponses pour un code HTTP en 4xx
|
Code |
Description |
|
Compte_Inexistant |
Aucun compte correspondant n'a été trouvé. |
|
Ressource_Refusee |
Vous n'êtes pas autorisé à accéder à cette ressource. |
|
Token_Erreur |
Erreur d'authentification, le token n'est pas valide. |
|
Token_Expire |
Erreur d'authentification, le token a expiré. |
|
Token_Max |
Maximum de token simultané atteint |
|
Parametre_Obligatoire |
La saisie d'une valeur ou d'une requête valide est obligatoire. |
|
Valeur_Obligatoire |
La saisie d'une valeur est obligatoire. |
|
Valeur_Format |
Le format de la valeur n'est pas conforme. |
|
Valeur_Erreur |
La valeur n'existe pas. |
|
IP_Bloque |
L'adresse IP xxx.xxx.xxx.xxx est bloquée. Connexion refusée |
|
Requete_Format |
Le format du paramètre requête n'est pas reconnu. |
|
Requete_Composant |
Aucun composant valable n'a été trouvé dans les composants de la requête. |
|
Requete_Operateur |
L'opérateur n'existe pas. |
|
Requete_Rubrique |
La rubrique n'existe pas. |
|
Requete_Valeur |
La valeur n'est pas valide. |
|
Requete_NonDisponible |
Les requêtes ne sont pas disponibles sur ce type de rubrique. |
|
Body_Format |
Erreur dans le format du Body. |
|
Body_Controle |
Erreur dans les contrôles du Body. |
Listing des codes réponses pour un code HTTP en 5xx
|
Code |
Description |
|
Erreur_Execution_SQL |
Erreur interne d’exécution de la requête SQL. L'anomalie à été enregistrée. |
|
Erreur_Connexion_BDD |
Erreur de connexion à la base de données. |
|
Token_Affectation |
Erreur d'affectation d'un Token. |
Pagination et limite des réponses
Depuis Wipsos il est possible de limiter le nombre de lignes contenues dans le tableau JSON.
Pour connaître cette limite il est donc nécessaire de se référer au paramétrage Wipsos du WebService.
Afin de paginer la réponse du WebService il est possible de spécifier un paramètre "Page"
Exemple : /V1/SAV?Page=1
La page 1 étant la première page de la pagination.