L'interface ITranslateMembershipResponse sert à traduire un résultat de lecture d'inscription IPSIS en un enregistrement d'abonnement LIS.
L'interface d'intégration est D2L.IM.IPSIS.LIS.MMS.ITranslateMembershipResponse.
La liste de configuration suivante offre un point de départ pour toute mise en œuvre LIS :
Template (Modèle), IPSIS
- ReadMembershipResponseSourcedGuidRequiredTranslator (Sort Order = 10)
- ReadMembershipResponseMembershipIdTypeOrgUnitTypeRequiredTranslator (Sort Order = 20)
- ReadMembershipResponseCollectionSourcedIdOrgUnitRequiredTranslator (Sort Order = 30)
- ReadMembershipResponsePersonSourcedIdRequiredTranslator (Sort Order = 40)
- ReadMembershipResponseRoleTypeRequiredTranslator (Sort Order = 50)
ReadMembershipResponseSourcedGuidRequiredTranslator
Le traducteur ReadMembershipResponseSourcedGuidRequiredTranslator ajoute l'Id source d'inscription dans la réponse.
Mise en œuvre
D2L.IM.IPSIS.LIS.ResultAdapters.MMS.Default.ReadMembershipResponseSourcedGuidRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit le champ sourcedId dans la réponse à l'identifiant d'inscription IM donné.
- Le traitement passe aux traducteurs suivants.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Identificateur d'inscription du SIS
|
result.sourcedGUID.sourcedId
|
request.SISMapping.IMEnrollmentIdentifier
|
Comportement en cas d'erreur
Si des objets de requête nécessaires sont nuls, le traducteur génère une exception ArgumentNullException. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
ReadMembershipResponseMembershipIdTypeOrgUnitTypeRequiredTranslator
Le traducteur ReadMembershipResponseMembershipIdTypeOrgUnitTypeRequiredTranslator prend l'UO vers lequel pointe l'inscription et place son type dans la réponse.
Mise en œuvre
D2L.IM.IPSIS.LIS.ResultAdapters.MMS.Default.ReadMembershipResponseMembershipIdTypeOrgUnitTypeRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Réglez le champ membershipIdType dans la réponse à l'une des correspondances suivantes en fonction de l'UO fournie :
- Group (Groupe)
- courseOffering
- courseSection
- sectionAssociation
- courseTemplate
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Type d’unité organisationnelle
|
result.membership.membershipIdType
|
request.OrgUnitMapping.IMExternalInfo.OrgUnitTypeMapping.IMOrgUnitTypeId
|
Comportement en cas d'erreur
Si le traducteur ne peut pas traduire l'ID de type d'UO dans les demandes dans l'un des types énumérés, une exception InvalidOrgUnitTypeException est générée. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Si des objets de requête nécessaires sont nuls, le traducteur génère une exception ArgumentNullException. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
ReadMembershipResponseCollectionSourcedIdOrgUnitRequiredTranslator
Le traducteur ReadMembershipResponseCollectionSourcedIdOrgUnitRequiredTranslator intègre l'ID de l'UO du SIS dans la réponse.
Mise en œuvre
D2L.IM.IPSIS.LIS.ResultAdapters.MMS.Default.ReadMembershipResponseCollectionSourcedIdOrgUnitRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit la collectionSourcedId de la réponse pour l'IMOrgUnitIdentifier dans la requête donnée.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Identificateur d'unité organisationnelle SIS
|
result.membership.collectionSourcedId
|
request.OrgUnitMapping.IMExternalInfo.IMOrgUnitIdentifier
|
Comportement en cas d'erreur
Si des objets de requête nécessaires sont nuls, le traducteur génère une exception ArgumentNullException. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
ReadMembershipResponsePersonSourcedIdRequiredTranslator
Le traducteur ReadMembershipResponsePersonSourcedIdRequiredTranslator définit la personSourcedId de la réponse pour l'IMUserIdentifier dans la requête.
Mise en œuvre
D2L.IM.IPSIS.LIS.ResultAdapters.MMS.Default.ReadMembershipResponsePersonSourcedIdRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit la personSourcedId de la réponse pour l'IMUserIdentifier dans la requête donnée.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Identificateur de personne du SIS
|
result.membership.member.personSourcedId
|
request.UserMapping.IMUserIdentifier
|
Comportement en cas d'erreur
Si des objets de requête nécessaires sont nuls, le traducteur génère une exception ArgumentNullException. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
ReadMembershipResponseRoleTypeRequiredTranslator
Le traducteur ReadMembershipResponseRoleTypeRequiredTranslator définit l'objet du rôle de la réponse selon une matrice contenant un rôle qui correspond au rôle de la requête.
Mise en œuvre
D2L.IM.IPSIS.LIS.ResultAdapters.MMS.Default.ReadMembershipResponseRoleTypeRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit le rôle de la réponse à une matrice dotée d'une seule entrée. Cette entrée ne contient qu'un champ roleType qui est réglé à l'identificateur de rôle du SIS donné dans la requête.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Identificateur de rôle du SIS
|
result.membership.member.role\[0\].roleType
|
request.RoleMapping.IMRoleIdentifier
|
Comportement en cas d'erreur
Si des objets de requête nécessaires sont nuls, le traducteur génère une exception ArgumentNullException. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.