Web service Apogée

Les notes et résultats affichés dans MonDossierWeb proviennent du web service "Pédagogique" des webservices Apogée.

Données

Vue Desktop

Vue mobile

Méthode du service "Pédagogique"

Notes aux diplômes et aux VET

Menu "Notes & résultats"

Onglet "Résultats"

recupererContratPedagogiqueResultatVdiVet

Notes des éléments constitutifs d'une VET

pop-up "Détail des notes"

après avoir cliqué sur une VET

2nd vue de l'onglet "Résultats"

après avoir cliqué sur une VET

recupererContratPedagogiqueResultatElpEpr

Le web service "Pédagogique" se base sur plusieurs paramètres clés :

Nom du paramètre	Définition
Source de résultat	"Paramètre permettant de choisir entre les résultats extraits directement depuis Apogée, les résultats extraits depuis les tables d’extractions des résultats d’Apogée ou aucun résultat (hormis les validations ou les résultats antérieurs). Pour ce dernier cas, le connecteur retourne le contrat pédagogique."
État de délibération	"Paramètre permettant, dans le cas d’un choix de source de résultat « Directement dans Apogée », de définir quel doit être l’état d’avancement des délibérations pour remonter les résultats."
Session	"Paramètre permettant, dans le cas d’un choix de source de résultat « Directement dans Apogée », de définir de quelle session vont être récupérées les données résultats."
Type de résultat	"Paramètre permettant, dans le cas d’un choix de source de résultat « Directement dans Apogée » ou « extraction Apogée », de définir le type de résultat (admission et/ou admissibilité) des données résultats qui vont être récupérées."
État IAE	"Paramètre permettant de définir l’état des inscriptions administratives aux étapes qui vont être récupérées."

Notes aux diplômes et aux VET

Dans le cas où le paramètre "sourceResultats" du fichier context.xml est paramétré sur "Apogee", la méthode recupererContratPedagogiqueResultatVdiVet du web service "Pédagogique" est appelée avec les paramètres suivant :

Paramètre	Valeur
code étudiant	code de l'étudiant dont le dossier est en consultation
code année	"toutes"
source de résultat	"Apogee"
état de délibération	En fonction du profil de l'utilisateur, valeur du paramètre correspondant (onglet "Notes et résultats" de l'adminView) : temoinNotesEtudiant temoinNotesEnseignant
session	"toutes"
type de résultat	"tous"
État IAE	En fonction du profil de l'utilisateur, valeur du paramètre correspondant (onglet "Notes et résultats" de l'adminView) : temoinEtatIaeNotesEtudiant temoinEtatIaeNotesEnseignant

Dans le cas où le paramètre "sourceResultats" du fichier context.xml est paramétré sur "Apogee-Extraction", le retour de l'appel si dessus est fusionné avec le retour de l'appel suivant :

Paramètre	Valeur
code étudiant	code de l'étudiant dont le dossier est en consultation
code année	"toutes"
source de résultat	"Apogee-Extraction"
état de délibération	null
session	"toutes"
type de résultat	"tous"
État IAE	En fonction du profil de l'utilisateur, valeur du paramètre correspondant (onglet "Notes et résultats" de l'adminView) : temoinEtatIaeNotesEtudiant temoinEtatIaeNotesEnseignant

La fusion est effectuée de la manière suivante :

Pour les années non couvertes par l'extraction on prend le résultat provenant du 1er appel ("Apogee").
Pour les années couvertes par l'extraction on prend le résultat provenant du 2ème appel ("Apogee-Extraction").

Pour savoir si une année est couverte par l'extraction, l'application se base sur les paramètres suivants (onglet Notes et Résultats" de l'adminView) :

notesAnneeOuverteResExtractionApogee : Utiliser l'extraction pour la dernière année ouverte aux résultats
- L'année du résultat est couverte par l'extraction s'il s’agit de la dernière année ouverte aux résultats, qui est récupérée par la requête SQL suivante : select max(cod_anu) from annee_uni where eta_anu_res = 'O'
notesAnneePivotExtractionApogee : Utiliser les extractions à partir d'une année précise, indiquer la première année utilisant les extractions
- Toutes les années supérieures ou égales à l'année pivot seront considérées comme couvertes par l'extraction.
notesNombreAnneesExtractionApogee : Indique le nombre x d'années couvertes par l'extraction Apogée. Utile uniquement si "sourceResultats"="Apogee-extraction"
- Si l'année du résultat est comprise dans les x années précédentes (dont l’année en cours).

Les données récupérées sont ensuite filtrées en vérifiant les conditions suivantes en adéquation avec les paramètres de l'onglet "Notes et résultats" de l'adminView :

Le rang lié au résultat d'un diplôme est affiché si le paramètre afficherRangEtudiant est activé.
Le rang lié au résultat d'une VET est affiché si le paramètre afficherRangEtudiant est activé ou si le code de l'étape fait partie des codes étapes listés dans le paramètre codesEtapeAffichageRang
Si le résultat d'un diplôme ou d'une VET est un résultat d'admissibilité, on l'indique à la place de la note.

Notes aux EC d'une VET

La méthode recupererContratPedagogiqueResultatElpEpr du web service "Pédagogique" est appelée avec les paramètres suivant :

Paramètre	Valeur
code étudiant	code de l'étudiant dont le dossier est en consultation
code année	année de la VET sélectionnée
code étape	code de la VET sélectionnée
version VET	version de la VET sélectionnée
source de résultat	En fonction du paramètre "sourceResultats" du fichier context.xml : "Apogee" "Apogee-Extraction"
état de délibération	En fonction du paramètre "sourceResultats" du fichier context.xml : Si "sourceResultats" ="Apogee" => "AET" récupération de tous les résultats (le trie sera effectué à postériori) pour contourner à un comportement du webservice, Si "sourceResultats" = "Apogee-Extraction" => null
session	"toutes"
type de résultat	"tous"
État IAE	En fonction du profil de l'utilisateur, valeur du paramètre correspondant (onglet "Notes et résultats" de l'adminView) : temoinEtatIaeNotesEtudiant temoinEtatIaeNotesEnseignant

Les données récupérées sont ensuite filtrées en vérifiant les conditions suivantes en adéquation avec les paramètres de l'onglet "Notes et résultats" de l'adminView :

Si le paramètre temoinFictif est renseigné, seuls les éléments dont le tem_fictif correspond seront affichés dans l'écran du détail des notes.
Si le paramètre temNotesEtuSem est actif et que "sourceResultats" n'est pas égale à "Apogee-Extraction"
- suppression des ELP de type semestre (et de leurs ELP fils) si leur état de délibération n'est pas à "T"
Récupération des notes d'un ELP si son témoin de délibération correspond à :
- Si "sourceResultats" = "Apogee-Extraction" => "AET" (aucun filtre sur la délibération)
- Si "sourceResultats" ="Apogee", en fonction du profil de l'utilisateur et du paramètre correspondant :
  - temoinNotesEtudiant
  - temoinNotesEnseignant
Si l'ELP possède des résultats pour 2 MCC différentes (session unique + session double)
- La session des résultat aux ELP doit correspondre au témoin de session unique de la VET (ex : si VET en session unique, prise en compte des résultats de l'ELP en session unique uniquement)
Affichage des résultats d'admissibilité uniquement si le paramètre affResultatsAdmissibilite l'autorise
Si un résultat d'ELP indique une année de PRC, récupération de ce résultat uniquement si l'année est valide pour la durée de conservation indiquée au niveau de l'ELP
Récupération des épreuves qui ont une note ou un résultat (si on veut afficher les résultats via le paramètre affResultatsEpreuves)
Récupération des notes aux épreuves si l'une des conditions suivantes est remplie :
- "sourceResultats" = "Apogee-Extraction"
- le type de l'épreuve fait partie de la liste des types épreuve à afficher (paramètre typesEpreuveAffichageNote)
- le témoin de délibération de l'épreuve fait partie de la liste des témoins paramétrés (temoinNotesEtudiant ou temoinNotesEnseignant)
- le témoin de délibération de l'elp père fait partie de la liste des témoins paramétrés (temoinNotesEtudiant ou temoinNotesEnseignant)
- le témoin CtlValCadEpr de l'épreuve est égal au paramètre temoinCtlValCadEpr
Non affichage des épreuves seules sous leur ELP père si elles ont la même note que ce dernier.

Tester les WebServices Apogée avec SoapUI

Lorsqu'une anomalie est constatée dans l'affichage des notes et résultats proposé par MonDossierWeb interroger directement les web services Apogée est souvent nécessaire.

Recouper le retour avec la documentation ci-dessus permet de cibler l'origine du problème : Apogée (et ses web services) ou MonDossierWeb.

Un outil couramment utilisé pour tester des web services SOAP est SoapUI : https://www.soapui.org/tools/soapui/

Voici un exemple d'utilisation pour tester un appel à la méthode recupererContratPedagogiqueResultatElpEpr du web service "Pédagogique" d'Apogée :

Créer un nouveau projet SOAP : File > New SOAP Project

Projet MonDossierWeb > Notes & Résultats > sp0.png

Dans la pop-up de création de projet s'ouvre. Indiquer un nom de projet, l'url vers le WSDL du web service à tester, cocher "Create Requests" puis cliquer sur OK.

Projet MonDossierWeb > Notes & Résultats > sp1.png

Le projet est créé avec des requêtes d'exemple pour chaque méthode du service. Modifier la requête automatiquement créée pour recupererContratPedagogiqueResultatElpEpr en double-cliquant sur cette dernière

Projet MonDossierWeb > Notes & Résultats > sp2.png

L'enveloppe SOAP de la requête s'affiche. Il suffit de renseigner les paramètres dans le XML à la place de chaque "?", de vérifier que l'url du service est correcte et de cliquer sur l’icône verte "submit" pour exécuter la requête

Projet MonDossierWeb > Notes & Résultats > sp4.png

Le retour est affiché dans la partie droite de la fenêtre. Penser à activer le formatage en XML pour faciliter sa lecture

Projet MonDossierWeb > Notes & Résultats > sp3.png