Skip to content
roddet edited this page Jan 21, 2013 · 12 revisions

JCertif Facade est le back-end des applications JCertif (Android, Web, etc...).

En cours de construction**

Objets

Login

Champ Type Format Obligatoire Unique Commentaire
email String [email protected] X X Adresse email du participant
password String X Mot de passe du participant

Referentiel

Champ Type Format Obligatoire Unique Commentaire
code String X X Code
label String X Libellé

Participant

Champ Type Format Obligatoire Unique Commentaire
email String [email protected] X X Adresse email du participant
password String X Ce champ est valorisé uniquement lors de la création d'un participant.
title String (referentiel) X
lastname String X Nom de famille
firstname String X Prénom
website String Site web, blog
city String X Ville
country String X Pays
company String Entreprise du participant
phone String Numéro de téléphone
photo String url complète vers la photo du participant
biography String Biographie du participant

Speaker

Champ Type Format Obligatoire Unique Commentaire
email String [email protected] X X Adresse email du participant
password String X Ce champ est valorisé uniquement lors de la création d'un présentateur.
title String (référentiel) X
lastname String X Nom de famille
firstname String X Prénom
website String Site web, blog
city String X Ville
country String X Pays
company String Entreprise du participant
phone String Numéro de téléphone
photo String url complète vers la photo du participant
biography String Biographie du participant

Sponsor

Champ Type Format Obligatoire Unique Commentaire
email String [email protected] X X Adresse email du sponsor
name String X Nom du sponsor
logo String X URL vers le logo
level String (voir référentiel) X Niveau de partenariat
website String X Site web, blog
city String X Ville
country String X Pays
phone String Numéro de téléphone
about String Présentation de l'entreprise

Session

Champ Type Format Obligatoire Unique Commentaire
id Entier X Identifiant de la session
title String X Titre de la session
summary String X Résumé
description String X Descriptif du déroulement
status String (voir référentiel) X Statut de la session
keyword String X Mots clés
category List X Liste d'identifiants de categorie. Exemple : {12,25,44}
start Date-Heure X Date/Heure de début
end Date-Heure X Date/heure de fin
speakers List Liste des adresses email des présentateurs. Exemple : {[email protected], [email protected]}

Services REST

Version

Service REST HTTP URL Données en requête Données en réponse
Obtenir la version des données sponsors GET /version/sponsor Plusieurs réponses possibles :
  • Si OK => HTTP 200 : Numéro. Exemple : 1256
  • Si erreur technique => HTTP 500 : 'message'
Obtenir la version des données sessions GET /version/session Réponses possibles :
  • Si OK => HTTP 200 : Numéro. Exemple : 1256
  • Si erreur technique => HTTP 500 : 'message'
Obtenir la version des données d'un participant GET /version/{email} Réponses possibles :
  • Si OK => HTTP 200 : Numéro. Exemple : 1256
  • Si erreur technique => HTTP 500 : 'message'

Participant

Service REST HTTP URL Données en requête Données en réponse
Créer un participant POST /participant/register un objet Participant au format JSON.
Exemple : {email : '[email protected]', lastname : 'Gates', fistname : 'Bill' }
Veuillez à valoriser tous les champs obligatoires.
Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si requête invalide => HTTP 400 : 'lastname,firstname' (liste des champs en erreurs)
  • Si erreur technique => HTTP 500 : 'message'
Mettre à jour un participant POST /participant/update un objet Participant au format JSON.
Exemple : {email : '[email protected]', lastname : 'Gates', fistname : 'Bill' }
Veuillez à valoriser tous les champs obligatoires.
Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si requête invalide => HTTP 400 : 'lastname,firstname' (liste des champs en erreurs)
  • Si erreur technique => HTTP 500 : 'message'
Vérifier les informations de connexion d'un participant POST /participant/login un objet Login au format JSON.
Exemple : {email : '[email protected]', password : 'Blabla'}
Plusieurs réponses possibles :
  • Si OK => HTTP 200 : objet Participant
  • Si requête invalide => HTTP 400 : 'login,password' (les deux champs sont toujours retournés
  • Si erreur technique => HTTP 500 : 'message'
Récupérer les informations d'un participant GET /participant/get/{email} Les réponses possibles :
  • Si OK => HTTP 200 : objet Participant
  • Si requête invalide => HTTP 400 : 'email'
  • Si erreur technique => HTTP 500 : 'message'
Inscrire un participant à une session POST /participant/{email}/session/add/{idsession} Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si erreur technique => HTTP 500 : 'message'
Désinscrire un participant à une session POST /participant/{email}/session/remove/{idsession} Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si erreur technique => HTTP 500 : 'message'
Récupérer la liste des sessions d'un participant GET /participant/{email}/session/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : Liste des identifiants de session
  • Si erreur technique => HTTP 500 : 'message'
Réinitialiser le mot de passe POST /participant/{email}/lostpassword Plusieurs réponses possibles :
  • Si OK => HTTP 200 : Liste des identifiants de session
  • Si erreur technique => HTTP 500 : 'message'
Changer de mot de passe POST /participant/{email}/changepassword Objet JSON : {oldpassword : 'blabvl', newpassword : 'jjj'} Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si erreur technique => HTTP 500 : 'message'

Sponsor

Service REST HTTP URL Données en requête Données en réponse
Liste des sponsors GET /sponsor/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Sponsor au format JSON.
    Exemple : {{email : '[email protected]', name : 'Android2ee'},{email : '[email protected]', name : 'Objis'}}
    Veuillez à valoriser tous les champs obligatoires.
  • Si erreur technique => HTTP 500 : 'message'

Speaker

Service REST HTTP URL Données en requête Données en réponse
Liste des présentateurs GET /speaker/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Speaker au format JSON.
    Exemple : {{email : '[email protected]', lastname : 'Gates'},{email : '[email protected]', lastname : 'Mbiandou'}}
  • Si erreur technique => HTTP 500 : 'message'
Inscrire un présentateur POST /speaker/register un objet Speaker au format JSON.
Exemple : {email : '[email protected]', lastname : 'Gates', fistname : 'Bill' }
Veuillez à valoriser tous les champs obligatoires.
Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si erreur technique => HTTP 500 : 'message'

Session

Service REST HTTP URL Données en requête Données en réponse
Liste des sessions GET /session/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Session au format JSON.
    Exemple : {{email : '[email protected]', lastname : 'Gates'},{email : '[email protected]', lastname : 'Mbiandou'}}
  • Si erreur technique => HTTP 500 : 'message'
Proposer une session POST /session/new un objet Session au format JSON.
Exemple : {title : 'Blu blu', summary : 'Bla bla'}
Veuillez à valoriser tous les champs obligatoires.
Plusieurs réponses possibles :
  • Si OK => HTTP 200 : OK
  • Si erreur technique => HTTP 500 : 'message'

Référentiel

Service REST HTTP URL Données en requête Données en réponse
Liste des niveaux de partenariat GET /ref/sponsorlevel/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Referentiel au format JSON.
    Exemple : {{code : 'REF_01', label : 'Diamant'},{code : 'REF_02', label : 'Or'}}
  • Si erreur technique => HTTP 500 : 'message'
Liste des statuts des sessions GET /ref/sessionstatus/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Referentiel au format JSON.
    Exemple : {{code : 'REF_01', label : 'Approuvé'},{code : 'REF_02', label : 'Brouillon'}}
  • Si erreur technique => HTTP 500 : 'message'
Liste des civilités GET /ref/title/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Referentiel au format JSON.
    Exemple : {{code : 'REF_01', label : 'Mr'},{code : 'REF_02', label : 'Mlle'}}
  • Si erreur technique => HTTP 500 : 'message'
Liste des catégories GET /ref/category/list Plusieurs réponses possibles :
  • Si OK => HTTP 200 : liste d'objet Referentiel au format JSON.
    Exemple : {{code : 'REF_01', label : 'HTML 5'},{code : 'REF_02', label : 'Java'}}
  • Si erreur technique => HTTP 500 : 'message'