API service web accès sécurité
Guide concernant les organismes receveurs (GCOR)
Sommaire:
Les utilisateurs autorisés peuvent utiliser ce service Web pour obtenir les données à jour des étudiants ayant besoin d'un accès informatique dans le cadre de leur stage à venir pour leur site. En plus des noms des étudiants et des dates et lieux de stage, la liste comprendra les adresses courriel des étudiants si les adresses courriel attribués par l'établissement ont été divulguées aux organismes receveurs.
Généralités
Avec son consentement, le nom d'un étudiant est divulgué aux organismes receveurs, en général une fois que le stage a été accepté par le site et confirmé par l'organisme demandeur (établissement d'enseignement). L'adresse courriel attribuée à l'étudiant par l'établissement d'enseignement sera également divulguée si :
- l'étudiant a un compte HSPnet et entre son consentement à la divulgation de son adresse courriel aux personnes-ressource du site; ou
- l'organisme demandeur a activé la fonctionnalité de divulguer l'adresse courriel de l'étudiant automatiquement par le biais de l'assistant de rapport « Liste d'accès/sécurité » qui est disponible pour les organismes receveurs. Veuillez vous référer au guide de consultation rapide intitulé Divulgation de l'adresse courriel pour l'accès informatique pour activer cette fonctionnalité.
Une interface de programmation d'application (API) spécifie comment 2 systèmes d'informations peuvent échanger des données. HSPnet offre une API service web aux organismes receveurs qui souhaitent automatiser l'obtention des données disponibles par le biais de leur assistant de rapport « Liste d'accès/sécurité », par un fichier XML.
Autorisation d'un utilisateur
Une personne désignée devra posséder un compte utilisateur actif ayant un niveau d'accès administrateur local et pourra ainsi accéder au service web et sera responsable de l'utilisation de celui-ci. Les comptes utilisateurs partagés ne sont pas autorisés conformément aux politiques nationales de HSPnet. Chaque compte utilisateur doit avoir une adresse courriel non partagée pour la livraison sécurisée de mots de passe ou la communication venant du centre d'assistance.
Le compte devra être autorisé par un cadre supérieur de l'organisme receveur avec un rôle organisationnel incluant les stages aux site(s) demandé(s). Typiquement, cette personne est déjà identifiée dans HSPnet comme étant la personne-ressource pour le département afin d'autoriser de nouveaux comptes utilisateurs de niveau d'accès administrateur local.
Toute demande d'accès devra se faire auprès du centre d'assistance de HSPnet à assistance@hspcanada.net. Merci d'inclure les informations suivantes :
- Nom, rôle et adresse courriel de la personne-ressource pour le département ou le directeur autorisant l'accès au service web
- Nom du service web devant être utilisé – par ex. « API-001 Liste d'accès/sécurité »
- Nom, rôle et adresse courriel de la personne
- Sites, services, destinations et disciplines devant être incluses dans le fichier XML
- Date de démarrage souhaitée – prévoir au minimum 5 jours ouvrés
- Une demande pour un mot de passe sans expiration si la connexion sera automatisée
Les utilisateurs autorisés obtiendront l'URL pour leur province, leur service web, et leur nom d'utilisateur :
https://serveurlocal/HSPnetxx/WebServices/PlacementService.asmx/SecurityAccess?user=VOTRENOMDUTILISATEUR&pw=VOTREMOTDEPASSE&RAList=n/a&Start=2020/Jul/01&End=2020/Aug/31
Les variables ci-dessous doivent être spécifiées lors de chaque connexion par le service web :
serveurlocal |
Sera fourni par le centre d'assistance pour chaque nouveau compte de service web |
HSPnetxx |
|
VOTRENOMDUTILISATEUR |
Nom d'utilisateur HSPnet envoyé par courriel à la création du compte |
VOTREMOTDEPASSE |
Mot de passe permanent choisi par l'utilisateur à la première connexion |
2020/Jul/01 |
Première date de la période à inclure (en anglais) |
2020/Aug/31 |
Dernière date de la période à inclure (en anglais) |
Données en sortie du service web
Le service web produira un fichier XML de tous les stages HSPnet qui sont actifs dans l'intervalle de temps spécifié, si un étudiant y a été affecté ET que son nom a été divulgué à l'organisme receveur. Un stage sera considéré comme actif dans l'intervalle de temps spécifié si l'une des dates du stage est comprise dans cet intervalle (voir le diagramme).
Les conditions pour la divulgation du nom d'un étudiant sont les suivantes :
-
La demande de stage a le statut d'Accepté (par l'organisme receveur) ou Confirmé (par l'organisme demandeur);
-
Un étudiant est affecté au stage par l'organisme demandeur;
-
Le consentement de l'étudiant à divulguer ses informations personnelles n'a pas expiré;
-
Le nom de l'étudiant est divulgué à l'organisme receveur :
- de manière automatique lorsque le stage est confirmé;
- avant la confirmation du stage si le nom de l'étudiant est divulgué en avance par l'organisme demandeur conformément aux politiques de HSPnet.
Le fichier XML est constitué d'un ou plusieurs éléments <PlacementSecurityAccess> contenant chacun les champs de données tels que définis dans l'annexe 1. Les catégories de données sont les suivantes (en anglais dans le document XML) :
- Organisme demandeur (Placing Agency) – Organisme, corps enseignant ou département, programme d'études et discipline
- Informations sur le stage (Placement Information) – numéro de référence unique. Pour un stage de groupe (2 étudiants ou plus), la même référence sera utilisée pour chaque étudiant affecté, type de stage et dates de début et de fin pour chaque étudiant.
- Enseignant (Instructor) – nom et coordonnées de la personne qui supervise les étudiants dans le cas d'un groupe mené par un enseignant. Typiquement, l'enseignant dirigeant le groupe a aussi besoin d'un accès informatique. Au Québec, quelques programmes d'études peuvent demander à l'organisme receveur d'affecter un moniteur qui est un employé du site, ou qui est affecté en tant que facilitateur ou personne-ressource pour un stage individuel.
- Étudiant (Student) – nom de l'étudiant affecté au stage, et adresse courriel si elle est divulguée par l'organisme demandeur.
Voici un exemple des données XML en sortie affichées dans un navigateur :
Messages d'erreur
Le service Web peut donner les messages d'erreur suivants (en anglais) :
Message d'erreur |
Cause de l'erreur |
User ID or password is invalid. You have xx login attempts remaining before this user account is locked out. |
Nom d'utilisateur et/ou mot de passe invalide |
Your account has been disabled. To reactivate your account, contact your HSPnet Local Administrator for your organization or contact support@hspcanada.net |
Nom d'utilisateur et/ou mot de passe invalide |
Access Denied |
L'utilisateur n'est pas autorisé à accéder au service web |
Le numéro d’identification HSPnet est un numéro unique suivi dans HSPnet pour les personnes avec un rôle d’étudiant ou de personnel (enseignant). Les systèmes locaux utilisant ces numéros doivent différencier ces rôles afin d’éviter les doublons – par exemple pour assurer que l’étudiant HSP555 et l’enseignant HSP555 ne causent pas un conflit. Nous recommandons l’utilisation d’un préfixe (ex. « E » et « P ») pour différencier les étudiants et le personnel respectivement.
InstructorEmail | Adresse courriel de l'enseignant | gabriel.tremblay@umontreal.ca | Utilisateurs |
DestinationContactEmail | Adresse courriel de la personne-ressource de la destination pour la discipline | jeanne.gagnon@chum.ca | Utilisateurs |
SupervisorEmail | Adresse courriel du superviseur | mylene.duval@chum.ca | Utilisateurs |
StudentEmail [3] | Adresse courriel principale de l'étudiant | 24795@umontreal.ca | Utilisateurs |
ProgramYear | Année du programme | 3 | Utilisateurs |
SubDisciplineShortName | Code de sous-discipline du programme d'études | NurBacc | DBA |
PRStartDate | Date de début du stage | Jan 1/20 | Utilisateurs |
PREndDate | Date de fin du stage | Jan 31/20 | Utilisateurs |
ProgramEndDate | Date de fin prévue du programme, pour fins administratives (ex. expiration d'accès aux systèmes informatiques) | Jun 30/20 | Utilisateurs |
InstructorMiddleName | Deuxième prénom ou initiale de l'enseignant | Jean ou J | Utilisateurs |
StudentMiddleName | Deuxième prénom ou initiale de l'étudiant | T | Utilisateurs |
Discipline | Discipline du programme d'études | Soins infirmiers | DBA |
PlacementAtWork | Indicateur de stage en milieu de travail (étudiant employé du site de stage) | false | Utilisateurs |
PlcAgencyShortName | Nom court de l'organisme demandeur | UdeMtréal | Centre d'assistance |
RcvAgencyShortName | Nom court de l'organisme receveur | RégMtl | Centre d'assistance |
DestinationShortName | Nom court de la destination | 5Est/Ouest | Utilisateurs |
CourseShortName | Nom court du cours | SOI2723 | Utilisateurs |
DepartmentShortName | Nom court du département (corps enseignant) | ScienceInf | Utilisateurs |
ProgramShortName | Nom court du programme d'études | SI/Bac | Centre d'assistance |
ServiceShortName | Nom court du service | OB/PériGén | Centre d'assistance |
SiteShortName | Nom court du site | CHUM/HôpSL | Utilisateurs |
InstructorLastName | Nom de famille de l'enseignant affecté par l'organisme demandeur | Tremblay | Utilisateurs |
StudentLastName | Nom de famille de l'étudiant | Dupont | Utilisateurs |
PlcAgencyName | Nom de l'organisme demandeur | Université de Montréal | Centre d'assistance |
StudentRegBody [2] | Nom de l'organisme qui émet le numéro d'enregistrement de l'étudiant | Ordre des infirmières de XXX | Utilisateurs |
RcvAgencyName | Nom de l'organisme receveur | Région Montréal | Centre d'assistance |
DestinationName | Nom de la destination | 5ème Est/Ouest | Utilisateurs |
CourseName | Nom du cours | Pratique de soins - situations critiques | Utilisateurs |
DepartmentName | Nom du département (corps enseignant) | Sciences infirmières | Utilisateurs |
ProgramName | Nom du programme d'études | Baccalauréat en sciences infirmières | Centre d'assistance |
ServiceName | Nom du service | OB/Périnat - Général | Centre d'assistance |
SiteName | Nom du site | CHUM Hôpital St-Luc | Utilisateurs |
SupervisorLastName | Nom du superviseur ou précepteur affecté par l'organisme receveur | Duval | Utilisateurs |
DestinationContactName | Nom et prénom de la personne-ressource de la destination pour la discipline | Jeanne Gagnon | Utilisateurs |
StudentNumber [4] | Numéro (code permanent) de l'étudiant | DUPM29427447 | Utilisateurs |
StudentRegID [2] | Numéro d'identification émis par l'organisme d'enregistrement | 938572484 | Utilisateurs |
PRD_ID | Numéro de référence unique de la demande de stage | 25378 | Système |
InstructorPhone | Numéro de téléphone de l'enseignant | 514 555 1234 | Utilisateurs |
StudentID |
Numéro unique dans la base de données de l'étudiant, généré par HSPnet NOTE ce numéro n'est pas le numéro d'étudiant attribué par l'organisme demandeur |
HSP9247 | Système |
InstructorID | Numéro unique dans la base de données pour l'enseignant, généré par HSPnet | HSP5242 | Système |
InstructorFirstName | Prénom de l'enseignant | Gabriel | Utilisateurs |
StudentFirstName | Prénom de l'étudiant | Marie | Utilisateurs |
SupervisorFirstName | Prénom du superviseur | Mylène | Utilisateurs |
SubDiscipline | Sous-discipline du programme d'études | BSc Sciences infirmières (initial) | DBA |
PRType | Type du stage | Groupe supervisé par un enseignant ou Préceptorat | Utilisateurs |
[1] indique que la colonne peut être modifiée par le ou les:
- Utilisateurs - peut changer à tout moment
- Centre d'assistance - changements moins fréquents et en accord avec les standards de données nationaux
- DBA (administrateur de la base de données) - changements rares avec consultation ou notification d'avance pour les utilisateurs du service web
- Système - automatiquement attribué par la base de données et non-modifiable
[2] Cette donnée sera non-vide seulement si l'organisme demandeur a activé la fonction de divulgation du numéro d'enregistrement
[3] Cette donnée sera non-vide seulement si l'organisme demandeur a activé la fonction de divulgation du courriel; si non-divulgué la donnée sera « WITHHELD »
[4] Cette donnée sera non-vide seulement si l'organisme receveur a activé la fonction de demande de divulgation des numéros d'étudiant pour fins de sécurité ou accès et la province a adopté un formulaire de consentement augmenté qui inclut la divulgation du numéro d'étudiant
Information importante sur le numéro d'identification HSPnet pour les étudiants et enseignants Le numéro d'identification HSPnet est un numéro unique suivi dans HSPnet pour les personnes avec un rôle d'étudiant ou de personnel (enseignant). Les systèmes locaux utilisant ces numéros doivent différencier ces rôles afin d'éviter les doublons – par exemple pour assurer que l'étudiant HSP555 et l'enseignant HSP555 ne causent pas un conflit. Nous recommandons l'utilisation d'un préfixe (ex. « E » et « P ») pour différencier les étudiants et le personnel respectivement.
Recevoir de l'assistance
Pour toute question ou demande d'assistance relatives à l'utilisation de ce service web, merci de communiquer avec assistance@hspcanada.net.