easyClean

Explication de l'api pour les codeurs.
Sera utile pour le rapport de stage de Hugues.

API

Il ne s'agit pas de l'explication finale pour les utilisateurs de l'api.

API

Plans

Comment ca marche ?

Les plans sont divisé en 2 grandes catégorie : 

Bibliothéque :

Quand on veut insérer un plan pour la bibliothéque :

Il faut les respecter certaines condition :

Quand on insère dans la bibliothéque, il faut aussi passer la bibliothéque a true pour les enfants (zone, surface, procédure) 

Client : 

Quand on veut insérer un plan pour un client :

Il faut les respecter certaines condition : 

Question :
API

Zones

Question : 

API

Surfaces

Question 

API

Procédures

Comment ca fonctionne :

Les procédures sont divisé en 3 grandes catégorie : 

Client:

La procédures fait partie d'un plan d'un client. 

Bibliothéque :

La procédures fait partie d'un plan qui est dans la bibliothéque. 

Défaut :

La procédures fait partie des bibliothéque de procédures. Elle sera visible dans le panier du client. 

Doit avoir true sur la variable bibliothèque et défaut en même temps.

 

Lors de la création d'un plan bibliothéque seuls zone surface et procédures sont avec le champs bibliothèque a true. Les enfants de procédures n'ont pas le champs bibliothéque a true. (dosage, temperature, frequences, taches...)

Question :

API

Tâches

Comment ca marche ?

Client:

La taches fait partie d'un plan d'un client. 

Bibliothéque :

La taches fait partie des bibliothéque de taches.

Cependant, ceci est un vieux code donc ignorer et deprecated 

Question :

API

Fréquences

Comment ca fonctionne ?

Cela fonctionne comme les tâches ou les surfaces, c'est un sous-objet de procédures. On va donc créer une fréquence associée à la procédure, et compléter l'ID dans la colonne correspondante dans la table des procédures. Attention, coté API, il faut générer la fréquences avant la génération de la procédures, afin de pouvoir avoir l'ID de la procédures. 

FUTUR : Deviendra surement comme les dosage, cela deviendra un champs texte, et dans la table plan_frequences de la BDD, il y aura plus que les fréquences de la bibliothèque

API : Quand on utilisera l'API sur la collection de fréquences, cela sera uniquement pour les fréquences de la bibliothèque. Cela signifie que nous devrons fournir les données des fréquences dans l'API des procédures afin de pouvoir créer ou mettre à jour une fréquence. Par exemple, avec le champ frequences_designation.

FUTUR API coté user : Rien ne changera, il devra fournir les informations de la fréquence comme s'il voulait fournir les informations du dosage.

Attention : Le fonctionnement du système de bibliothèque est différent de celui des zones ou des surfaces, il est plutôt similaire au système de dosage. Les fréquences associées au champ bibliothèque font partie des fréquences disponibles sur la page suivante : https://plan.paris.ecare.pro/Bibliotheques/Frequences.

Question : 
API

Images

Comment ca marche ?

Elles sont appelées par une autre BDD et par une autre API

De mon côté, je n'attends que l'ID de l'image. Je vérifie uniquement si c'est un entier qui m'est envoyé, je ne vérifie pas si l'image existe.

Question :

API

Documents

Comment ca marche ?

L'API des documents ne sert qu'a lister des documents de leur bibliothéque. C'est sur l'api plan qu'on gère les liaison et les ajout / suppression / update des liaison plan documents.

 


Question :