esup-multi

Arborescence des pages

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

  • host : adresse du serveur
  • uri : chemin éventuel vers le service
  • username : identifiant (login) de l'utilisateur pour lequel on souhaite les informations
  • et les rôles, c'est à dire
  • , soit l'utilisateur qui se connecte.
  • Le login sera celui retourné par le serveur CAS après authentification.

Pas de paramètres ou headers particuliers

...

Bloc de code
languagejson
{
	"lastname": string;,
  	"firstname": string;,
  	"birthdate?": string;,
  	"gender?": string;,
  	"title": string;,
  	"subtitle?": string;,
  	"ine?": string;,
  	"csn?": string;,
  	"photo": string;,
  	"affiliation": string;,
  	"idNumber": string;,
  	"endDate": number;,
  	"qrCode?": {
    	"type": string;,
    	"value": string;
  	};,
  	"errors?": [];
}
  • lastname : nom de l’utilisateur

  • firstname : prénom de l’utilisateur

  • birthdate (nullable) : date de naissance de l'utilisateur
  • gender (nullable) : genre de l’utilisateur

  • titlte : titre du document
  • subtitle (nullable) : complément du titre
  • ine (nullable) : code INE de l’utilisateur (dans le cas où l’utilisateur est un étudiant)
  • csn (nullable) : numéro de série de la carte
  • photo : photo de l’utilisateur encodée en base64
  • affiliation : type d’utilisateur (student | staff) - permet d'identifier le template SVG à utiliser

  • idNumber : identifiant de l'utilisateur au sein de l'établissement

  • endDate : année de fin de validation de l'inscription en cours

  • qrCode (nullable) : 
    • type : type d’action au scan du QRCode (text|url)

    • value : la valeur du QRCode à générer (texte pour un QR de type text ou une url pour un QR de type url)

...

user_not_found (code 404) : L’utilisateur dont le login est passé en paramètre lors de l’appel n’a pas pu être trouvé dans le SI de l’Université

Exemple :

Bloc de code
languagejson
{
    "error": "user_not_found_in_ldap",
    "error_description": "L'utilisateur avec pour uidNumber or login 'bidule' n'a pas pu être trouvé dans le LDAP ou est sursitaire"
}

...

Info

L’application capte donc 2 types d’erreur :

  • celles dont le code HTTP n’est pas 200

  • celles pour lesquelles l’attribut errors est renseigné dans la réponse

Exemple

Bloc de code
languagejson
{
    	"lastname": "Dupont",
    "firstname": "Alice",
    "gender": null,
    "birthdate": "01/01/2000",
    "affiliation": "staff",
    "ine": null,
    "errors": [],
    "photo": "data:image/jpeg;base64,/9j/4AA..."
    "ine": null,
    "title": "Carte professionnelle",
    "subtitle": "Enseignant chercheur",
    "csn": null,
    "endDate": "2026",
    "idNumber": "AA1234567890",
    "qrCode": {
        "type": "text",
        "value": "00000@ul"
     }
    "errors": [],
}