Documentatie over integraties

De Membership Management Service (MMS)

Deze service wordt gebruikt om Brightspace®-inschrijvingen te beïnvloeden.

Geïmplementeerde activiteiten

deleteMembership
replaceMembership
readMembership

Info over de deleteMembership-bewerking

deleteMembership is de bewerking die wordt gebruikt om inschrijvingen in Brightspace® te verwijderen. Inschrijvingen zijn de relatie tussen gebruikers en organisatie-eenheden en kunnen worden geverifieerd of onderzocht in gebruikers beheren of in de groepslijst voor een bepaalde cursus.

Processtroom: deleteMembership

Wanneer een aanvraag voor een LIS-deleteMembership wordt ontvangen, verkrijgt de adapter de unieke id voor het lidmaatschap rechtstreeks uit het veld sourcedId van de aanvraag, zonder een inplugbaar omzettingsprogramma te gebruiken.
Zodra de lidmaatschaps-id is verkregen, verwerken de IPSIS-platformhandlers die zijn geconfigureerd voor IDeleteEnrollmentHandler de aanvraag.
De LIS-respons wordt gegenereerd op basis van de respons van de handler.

Voorbeeld van een deleteMembership-aanvraag

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

     xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

         <ims:imsx_version>V1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:deleteMembershipRequest>

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

      </ims:deleteMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor deleteMembership-aanvraag

Velden van aanvraagkoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden van aanvraagtekst

De adapter accepteert de volgende velden in de aanvraag:

Eigenschap	Toewijzing LIS-aanvraag	Verplicht
Code	deleteMembershipRequest.sourcedId	Ja

Voorbeeld van deleteMembership-respons

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

          xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <imsx_version>V1.0</imsx_version>

         <imsx_messageIdentifier>MMS_deleteMembership_20120120T191434_9913552Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>status</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_description/>

            <imsx_codeMinor*gt;

               <imsx_codeMinorField>

                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>

                  <imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>

               </imsx_codeMinorField>

            </imsx_codeMinor>

         </imsx_statusInfo>

      </h:imsx_syncResponseHeaderInfo>

   </s:Header>

   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

       xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>

</s:Envelope>

Koptekst- en tekstvelden voor deleteMembership-respons

Velden voor responskoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden voor responstekst

Er worden geen velden geretourneerd in de tekst van de respons.

Info over de replaceMembership-bewerking

ReplaceMembership is de bewerking die wordt gebruikt om inschrijvingen in Brightspace® te maken of bij te werken. Inschrijvingen zijn de relatie tussen gebruikers en organisatie-eenheden en kunnen worden geverifieerd of onderzocht in gebruikers beheren of in de groepslijst voor een bepaalde cursus.

Processtroom: replaceMembership

Wanneer een LIS-aanvraag replaceMembership wordt ontvangen, vertaalt Brightspace® de aanvraag met behulp van de LIS-omzettingsprogramma's die zijn geconfigureerd voor ITranslateMembership om de aanvraag om te zetten in een indeling die het IPSIS-platform kan begrijpen.
Zodra de aanvraag is vertaald, verwerken de IPSIS-platformhandlers die zijn geconfigureerd voor IReplaceEnrollmentHandler de aanvraag.
Er wordt een LIS-respons gegenereerd op basis van de respons van de handler.

Voorbeeld van replaceMembership-aanvraag

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

         <ims:imsx_version>V1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:replaceMembershipRequest>

         <!--niet gebruikt door D2L®-->

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

         <ims:membershipRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:membership>

               <ims:collectionSourcedId>Demo_Section_01</ims:collectionSourcedId>

               <!--niet gebruikt door D2L®-->

               <ims:membershipIdType>courseSection</ims:membershipIdType>

               <ims:member>

                  <ims:personSourcedId>Demo_User</ims:personSourcedId>

                  <ims:role>

                     <ims:roleType>Learner</ims:roleType>

                     <ims:status>Active</ims:status>

                  </ims:role>

               </ims:member>

            </ims:membership>

         </ims:membershipRecord>

      </ims:replaceMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor replaceMembership-aanvraag

Velden van aanvraagkoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden van aanvraagtekst

De configuratie van het omzettingsprogramma voor sjablonen accepteert de volgende velden in de aanvraag:

Eigenschap	Toewijzing LIS-aanvraag	Verplicht
Inschrijvingsbericht-id	membershipRecord.sourcedGUID.sourcedId	Ja
Sectiecode	membershipRecord.membership.collectionSourcedId	Ja
Gebruikers-id	membershipRecord.membership.member.personSourcedId	Ja
Rol	membershipRecord.membership.member.role{*}.roleType	Ja
Inschrijvingsstatus	membershipRecord.membership.member.role{*}.status	Ja

Voorbeeld van replaceMembership-respons

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

          xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <imsx_version>V1.0</imsx_version>

         <imsx_messageIdentifier>MMS_replaceMembership_20120419T000158_6944880Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_description/>

            <imsx_codeMinor>

               <imsx_codeMinorField>

                  <imsx_codeMinorFieldName>TargetEndSystem<imsx_codeMinorFieldName>

                  <imsx_codeMinorFieldValue>partialdatastorage</imsx_codeMinorFieldValue>

               </imsx_codeMinorField>

            </imsx_codeMinor>

         </imsx_statusInfo>

      </h:imsx_syncResponseHeaderInfo>

   </s:Header>

   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>

</s:Envelope>

Koptekst- en tekstvelden voor replaceMembership-respons

Velden voor responskoptekst

Raadpleeg voor meer informatie het onderwerp LIS v2.0-services gebruiken > Aanvraag- en responskopteksten.

Velden voor responstekst

Er worden geen velden geretourneerd in de tekst van de respons.

Voorbeeld van readMembership-aanvraag

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

         <ims:imsx_version>V1.0</ims:imsx_version>

         <ims:imsx_messageIdentifier>1234</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readMembershipRequest>

         <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

      </ims:readMembershipRequest>

   </soapenv:Body>

</soapenv:Envelope>

Voorbeeld van readMembership-respons

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"

          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

          xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <imsx_version>V1.0</imsx_version>

         <imsx_messageIdentifier>MMS_readMembership_20120419T000158_6944880Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_description/>

            <imsx_codeMinor>

               <imsx_codeMinorField>

                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>

                  <imsx_codeMinorFieldValue>partialdatastorage</imsx_codeMinorFieldValue>

               </imsx_codeMinorField>

            </imsx_codeMinor>

         </imsx_statusInfo>

      </h:imsx_syncResponseHeaderInfo>

   </s:Header>

   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

       <ims:membershipRecord>

         <ims:sourcedGUID>

            <ims:sourcedId>Demo_Section_01_duser</ims:sourcedId>

         </ims:sourcedGUID>

         <ims:membership>

            <ims:collectionSourcedId>F515050A-6A6C-486B-8B46-97BA6FD62458</ims:collectionSourcedId>

            <ims:membershipIdType>83418823-CADC-40A6-885E-C460F78E896F</ims:membershipIdType>

            <ims:member>

               <ims:personSourcedId>967F247A-F65B-41CE-8A33-8B2E1C8AF357</ims:personSourcedId>

              <ims:role><ims:roleType>Learner</ims:roleType></ims:role>

           </ims:member>

         </ims:membership>

     </ims:membershipRecord>

   </s:Body>

</s:Envelope>