Gestion des groupes
Création d'un groupe
Règles
Le nom du groupe ne peut pas être le même qu'un autre groupe de la souscription qui est au même niveau
Le nom du groupe peut être le même qu'un autre groupe d'une autre souscription
Liste des propriétés obligatoires
Name
Liste des propriétés optionnelles
Toutes les propriétés sauf 'Name'
l'ID ne doit pas être obligatoire pour la création
8524: Api Provisionning : Supprimer l'obligation de la propriété Id de l'objet group et user
l'API ne permet de créer que des groupes de niveau 1 (juste en-dessous de la racine)
Si l'id de la page de garde n'existe pas
Retourne la réponse BadRequest
Cas nominal
Création réussie
Conséquences de la création
Le groupe est crée sous le groupe racine de la souscription
Un id est auto-généré
Les paramètres optionnels non renseignés à la création doivent tous avoir des valeurs héritées
valeur 'NULL' dans l'API
Valeur héritée réelle dans Faxbis WEb
Reponse
Code
201 - Created
Body
Les information du groupe créé. Notamment l'id renseigné au format JSON
Trace
Texte
Création du groupe 'xxx' pour la souscription 'xx'
Level
INFO
Cas d'erreur
Modification d'un groupe
Règles
Le nom du groupe ne peut pas être le même qu'un autre groupe de la souscription qui est au même niveau
Le nom du groupe peut être le même qu'un autre groupe d'une autre souscription
Pour la même souscription le nom du groupe peut être le même qu'un groupe de niveau différent (créé via le web)
Liste des propriétés de groupe obligatoires
ID
Nom
Liste des propriétés de groupe optionnelles
Tout sauf l'ID et le nom
8524: Api Provisionning : Supprimer l'obligation de la propriété Id de l'objet group
Un paramètre non spécifié écrasera la valeur actuelle par la valeur par défaut (héritée)
Si l'id de la page de garde n'existe pas
Retourne la réponse BadRequest
Cas nominal
Cas d'erreur
La valeur de l'OADC ne correspond pas aux critères
Le nouveau nom du groupe correspond à un autre groupe de la souscription qui est au même niveau
L'id spécifié correspond à un utilisateur ou un périphérique
L'id spécifié correspond à un groupe d'une autre souscription
Code
404 - Not found
Body
Aucun
Trace
Texte
Groupe 'xxx' existe, mais ne fait pas partie de la souscription 'xxx'
Level
WARN
Mise à jour du groupe racine si au moins 1 paramètre obligatoire ou optionnel manquant
L'id spécifié n'existe pas en BDD
Code
404 - Not found
Body
Aucun
Trace
Texte
Groupe 'xxx' n'existe pas pour la souscription 'xxx'
Level
WARN
Erreur système
Erreur Base de donnée
Authentification incorrecte
Code
401 - Unauthorized
Body
Aucun
Trace
Texte
Echec de l'authentification : l'entité '{username}' n'est pas autorisé à utiliser l'API
ou
Echec de l'authentification : l'entête 'Authorization' est null ou ne correspond pas à du basic
Level
WARN
Requête invalide
Suppression d'un groupe
Règles
La suppression d'un groupe contenant des sous-groupes n'est pas permise
La suppression d'un groupe contenant des admin de groupe ou de souscription n'est pas permise
La suppression d'un groupe contenant des utilisateurs n'est possible que si le paramètre cascadeDelete est à true
La suppression du groupe racine est interdite
Cas nominal
Suppression réussie
Suppression d'un groupe vide
Suppression d'un groupe qui contient des utilisateurs non admin uniquement (cascadeDelete à true)
8533: [Gestion groupes] Suppression d'un groupe contenant un périphérique
Pour tester la suppression des users, Voir "Suppression d'un utilisateur..." dans carte mentale Users v2
Conséquence de la suppression
Groupe vide
Suppression du groupe
Suppression des routages vers le groupe
Groupe avec utilisateurs et paramètre cascadeDelete à true
Suppression du groupe
Suppression des utilisateurs du groupe
Suppression des routages vers les utilisateurs
Suppression des routages vers le groupe
Reponse
Code
200 - Ok
Body
Aucun
Trace
Texte
Le groupe 'xxx' a été supprimé pour la souscription 'xxx'
Level
INFO
Cas d'erreur
Récupération d'un groupe
Règles
Retourne le groupe spécifié
Cas nominal
Cas d'erreur
Récupération de la liste des groupes
Règles
Par défaut, sans ID de groupe spécifié, ne retourne QUE le groupe racine
Possibilité de retourner une liste de sous groupe d'un groupe en donnant l'id
Les éventuels sous-sous-groupes ne doivent pas être retournés
Si ID = groupe racine, retourner tous les groupes juste en-dessous
Si aucun groupe dans la souscription, liste vide
Si ID = groupe directement en-dessous de la racine, retourner tous les sous-groupes juste en-dessous
Si aucun sous-groupe, liste vide
Comment précisera-t-on l'ID
car préciser l'ID dans l'URL /{groupId} renvoie à la récupération d'un seul groupe
en cours d'étude par EC
Cas nominal
Cas d'erreur
Erreur système
Code
503 - Service Unavailable
Body
Aucun
Trace
Texte
Exploit : xxx
Level
ERROR
Authentification incorrecte
Code
401 - Unauthorized
Body
Aucun
Trace
Texte
Echec de l'authentification : l'entité '{username}' n'est pas autorisé à utiliser l'API
ou
Echec de l'authentification : l'entête 'Authorization' est null ou ne correspond pas à du basic
Level
WARN
L'id spécifié n'existe pas
Code
404 - Not Found
Body
Ancun
Trace
Texte
Groupe 'xxx' n'existe pas pour la souscription 'xxx'
Level
WARN
L'id spécifié correspond à un utilisateur d'une autre souscription
L'id spécifié correspond à un groupe d'une autre souscription
Erreur Base de donnée
L'id spécifié correspond à un utilisateur ou un périférique
Légende
A rajouter dans WIKI
Cas non possible
Prêter attention
Règles
Interdiction
Question en suspens
A preciser
Comportement constaté différent du comportement attendu
comportement attendu OK
Comportement attendu NOK
Ticket de bug TFS
Recette
Activation des droits d’émission
Règles
Vérifier que l'héritage fonctionne
On ne peut pas activer les droits pour TOUS les média en une seule requête
Paramètre 'messageType'
Les droits sont activés par MEDIA
On ne peut pas activer les droits pour le Media 'EMAIL', seulement les Fax et SMS
Cas nominal
Conséquence de la modification
Fax
entityrightsuse = 1 dans la table EntityRights pour msg_flow_id = 2, msg_status = -1 et msg_type_id = 0
TOUS Les utilisateurs du groupe peuvent envoyer des Fax (test d'envoi)
Le sous-groupe peut envoyer des Fax
Sms
entityrightsuse = 1 dans la table EntityRights pour msg_flow_id = 2, msg_status = -1 et msg_type_id = 1
Dans la page "Utilisateurs", TOUS les utilisateurs du groupe ont désormais les droits d'émission (édition)
TOUS Les utilisateurs du groupe peuvent envoyer des SMS (test d'envoi)
Le sous-groupe peut envoyer des SMS
Reponse
Code
200 - Ok
Body
Aucun
Trace
Texte
Activation des droits d'émission pour les media 'xxx' pour le groupe 'xxx' pour la souscription 'xxx'
Level
INFO
Activation réussie
Activation des droits pour le groupe racine
Activation des droits pour un groupe sous la racine
Activation des droits pour un sous-groupe
Activation des droits d'émission pour un groupe dont le groupe supérieur n'a pas les droits
Activation des droits FAX
Activation des droits SMS
Cas d'erreur
L'id du groupe spécifié n'existe pas
Code
404 - Not found
Body
Aucun
Trace
Texte
Groupe 'xxx' n’existe pas pour la souscription 'xxx'
Level
WARN
L'id spécifié correspond à un utilisateur ou un périphérique
L'id spécifié correspond à un groupe d'une autre souscription
Code
404 - Not found
Body
Aucun
Trace
Texte
Groupe 'xxx' existe, mais ne fait pas partie de la souscription 'xxx'
Level
WARN
Erreur système
Erreur Base de donnée
Code
503 - Service Unavailable
Body
Aucun
Trace
Texte
Exploit : Problème avec la base de donnée : xxx
Level
ERROR
Authentification incorrecte
Activation des droits d'émission pour le MEDIA email
Requête invalide
Désactivation des droits d’émission
Règles
Vérifier que l'héritage fonctionne
On ne peut pas désactiver les droits pour le Media 'EMAIL', seulement pour le Fax et le SMS
Les droits sont désactivés par MEDIA
On ne peut pas désactiver les droits pour TOUS les média en une seule requête
Paramètre 'messageType'
Cas nominal
Conséquence de la modification
Fax
entityrightsuse = 0 dans la table EntityRights pour msg_flow_id = 2, msg_status = -1 et msg_type_id = 0
AUCUN des utilisateurs du groupe ne peuvent envoyer de Fax (test d'envoi)
Sms
entityrightsuse = 0 dans la table EntityRights pour msg_flow_id = 2, msg_status = -1 et msg_type_id = 1
Dans la page "Utilisateurs", Aucun des utilisateurs du groupe n'ont les droits d'émission (édition)
AUCUN des utilisateurs du groupe ne peuvent envoyer des SMS (test d'envoi)
Reponse
Code
200 - Ok
Body
Aucun
Trace
Texte
Désactivation des droits d'émission pour les media 'xxx' pour le groupe 'xxx' pour la souscription 'xxx'
Level
INFO
Désactivation réussie
Désactivation des droits pour le groupe racine
Désactivation des droits pour un groupe sous la racine
Désactivation des droits pour un sous-groupe
Désactivation des droits d'émission pour un groupe dont le groupe supérieur a les droits
Désactivation des droits FAX
Désactivation des droits SMS
Cas d'erreur
L'id du groupe spécifié n'existe pas
L'id spécifié correspond à un utilisateur ou un périphérique
L'id spécifié correspond à un groupe d'une autre souscription
Erreur système
Authentification incorrecte
Désactivation des droits d'émission pour le MEDIA email
Code
400 - Bad Request
Body
{ "InvalideArgument" : "value" }
Trace
Texte
La requête est invalide pour la souscription 'xxx'. La valeur du paramètre 'xxx' est invalide
Level
WARN
Requête invalide
AU moins 1 paramètre obligatoire manquant
Code
400 - Bad Request
Body
{ "InvalideArgument" : "value" }
Trace
Texte
La requête est invalide pour la souscription 'xxx'. La valeur du paramètre 'xxx' est invalide
La requête est invalide pour la souscription 'xxx'. La valeur du paramètre 'xxx' est invalide
Level
WARN
MessageType manquant
Vu avec EC, le code de réponse ne sera pas nécessairement 400 - Bad request
userId manquant
Vu avec EC, le code de réponse ne sera pas nécessairement 400 - Bad request
Le type de message n'est pas valide
Code
400 - Bad Request
Body
{ "InvalideArgument" : "value" }
Trace
Texte
La requête est invalide pour la souscription 'xxx'. La valeur du paramètre 'xxx' est invalide
Level
WARN
L'id du groupe spécifié n'est pas numérique
Code
400 - Bad Request
Body
{ "InvalideArgument" : "value" }
Trace
Texte
La requête est invalide pour la souscription 'xxx'. La valeur du paramètre 'xxx' est invalide
Level
WARN
Données du groupe
Requêtes
Paramètres obligatoires
Name
Limite BDD: 256 caractères
Le nom doit accepter les caractères spéciaux
?./§µ%£¨ù*=)~#~{#~[|{[|[\`^,;:!+°-_èçà)=('"é&²
Paramètres optionnels
CompanyName
Limite BDD: 256 caractères
CSID
Limite BDD: 20 caractères
billingCode
Limite BDD: 50 caractères
fax
Limite BDD: 20 caractères
culture
Vérifier que la culture est valide
Limite BDD: 50 caractères
backgroundPageId
Vérifier qu'une page de garde existe pour cet id
Vérifier que la page de garde est associée à la souscription de l'utilisateur
phone
Limite BDD: 20 caractères
mobile
Limite BDD: 20 caractères
countryLocalisation
Vérifier que le code pays est valide
Limite BDD: 2 caractères
oadc
Critères
Critère OADC 1: Ne doit pas comporter que des chiffres
Critère OADC 2: <= 11 caractères, pas de minimum
Critère OADC 3: Ne doit pas commencer par un chiffre
Critère OADC 4: certains mots sont interdits (fichier config)
sfr
orange
0range
bouygues
users
Paramètre retiré pour la v2
Attention à la modification : si un paramètre n'est pas spécifié alors sa valeur par défaut est prise en compte et écrasera la valeur en BDD
Réponse
Les valeurs retournées correspondent aux valeurs du groupe. L'héritage n'est pas pris en compte
Données uniquement dans les réponses
Id