Groupes

Liste des groupes

URL à appeler

https://www.spot-hit.fr/api/groupe/lister

Paramètres

Paramètre	Description
key	Votre clé API d'identification

Résultats

[
  {"id":"1","commercant":"1","groupe":"Groupe 1","total":"10"},
  {"id":"2","commercant":"1","groupe":"Groupe 2","total":"25"}
]  

Ajouter un groupe

URL à appeler

https://www.spot-hit.fr/api/groupe/creer

Paramètres

Paramètre	Description
key	Votre clé API d'identification
nom	Nom du groupe (100 caractères max)

Résultats

Résultat	Description
{resultat: 1, id: 45498}	resultat = 1 = Elément ajouté avec succès id = Identifiant unique de l'élément
{resultat: 0, erreurs: "1,2"}	resultat = 0 = Erreur lors de l'ajout erreurs = Liste des erreurs rencontrées

Tableau des erreurs

Numéro	Description
1	Impossible de créer le groupe / Vérifier que le groupe soit unique
2	Le nom est vide ou contient plus de 100 caractères

Renommer un groupe

URL à appeler

https://www.spot-hit.fr/api/groupe/renommer

Paramètres

Paramètre	Description
key	Votre clé API d'identification
nom	Nom du groupe (100 caractères max)
id	Identifiant du groupe à modifier

Résultats

Résultat	Description
{resultat: 1}	resultat = 1 = Elément modifié avec succès
{resultat: 0, erreurs: "1,2"}	resultat = 0 = Erreur lors de la modification erreurs = Liste des erreurs rencontrées

Tableau des erreurs

Numéro	Description
1	Impossible de renommer le groupe
2	Le nom est vide ou contient plus de 100 caractères
3	ID groupe non renseigné ou inexistant

Supprimer un groupe

URL à appeler

https://www.spot-hit.fr/api/groupe/supprimer

Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	Identifiant du groupe à supprimer

Résultats

Résultat	Description
{resultat: 1}	resultat = 1 = Elément supprimé avec succès
{resultat: 0, erreurs: "1,2"}	resultat = 0 = Erreur lors de la suppression erreurs = Liste des erreurs rencontrées

Tableau des erreurs

Numéro	Description
1	Erreur lors de la suppression du groupe
2	ID groupe non renseigné ou inexistant