Appearance
Référence
L’API d’AIMAIRA est organisée autour des concepts de REST. Notre API possède des URLs normalisées et orientées ressources, accepte des corps de requêtes form-encoded
, retourne des réponses encodées au format JSON et utilise des codes de réponse HTTP, des mécanismes d’authentification et des verbes HTTP standard.
Univers
Les ressources mises à disposition par l’API AIMAIRA sont listées dans la présente documentation de référence. Elles sont organisées par univers, en respectant le menu de navigation présent dans Manage.
L’univers Core
est un univers virtuel qui contient toutes les ressources transverses à plusieurs Univers.
Référence
Core
File
Académie
Admission
Finance
Inscription
- Apprenant
- Inscription
- Issue / État d’inscription
- Origine
- Parcours
- Régime de l’apprenant
- Tuteur
- Voie d’entrée
Pédagogie
Planification
Relation entreprise
Correspondance des noms d’entités hérités
À plusieurs occasions lors de l’interfaçage avec le logiciel, il vous sera nécessaire de pouvoir faire correspondre le nom hérité de l’entité, de la forme univers.T_NOM_ENTITE
avec le point de terminaison correspondant dans l’API.
Une page de la présente documentation liste les correspondances afin de vous faciliter cette tâche.