Documentatie over integraties

De Section Association Management Service (SAMS)

Deze service wordt gebruikt om de koppelingen tussen SIS-secties en Brightspace®-cursusedities te beïnvloeden.

Geïmplementeerde activiteiten

deleteSectionAssociation
replaceSectionAssociation
readSectionAssociation

Info over de deleteSectionAssociation-bewerking

De deleteSectionAssociation-bewerking wordt gebruikt om organisatie-eenheden van Brightspace® te verwijderen die zijn gekoppeld aan LIS-sectiekoppelingen.

Processtroom: deleteSectionAssociation

Wanneer een LIS-deleteSectionAssociation-aanvraag wordt ontvangen, verkrijgt de adapter de unieke id voor de sectiekoppeling rechtstreeks uit het sourcedId-veld van de aanvraag, zonder gebruik van een inplugbaar omzettingsprogramma.
Zodra de id van de cursussectie is verkregen, wordt de aanvraag verwerkt door de IPSIS-platform-handlers die zijn geconfigureerd voor IDeleteSectionAssociationHandler.
De LIS-respons wordt vervolgens gegenereerd op basis van de respons van de handler.

Voorbeeld van deleteSectionAssociation-aanvraag

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

   xmlns:ims="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_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:deleteSectionAssociationRequest>

         <ims:sourcedId>Demo_Section_Assocation</ims:sourcedId>

      </ims:deleteSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor deleteSectionAssociation-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	deleteSectionAssociationRequest.sourcedId	Ja

Voorbeeld van deleteSectionAssociation-respons

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

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

         xmlns:h="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0"

         xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_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>CSMS_deleteCourseSection_20120104T232203_8033886Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>status</imsx_severity>

            <imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>

            <imsx_codeMinor>

               <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 deleteSectionAssociation-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 replaceSectionAssociation-bewerking

De replaceSectionAssociation-bewerking wordt gebruikt om Brightspace®-cursusedities en bijbehorende secties/groepen te maken of bij te werken op basis van aanvragen voor LIS-sectiekoppelingen.

Wanneer u de standaardconfiguraties gebruikt, kunt u (na succes) de sectiekoppeling valideren die is gemaakt of bijgewerkt met behulp van de browser voor configuratievariabelen in Brightspace®, Cursussen beheren, of de widget Mijn cursussen.

Processtroom: replaceSectionAssociation

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

Opmerking: Als de ReplaceSectionAssociationDatenFromAllSectionsHandler is geconfigureerd (automatisch geconfigureerd voor LIS 2.0), worden de oudste startdatum en de nieuwste einddatum voor de cursus gebruikt.

Voorbeeld van replaceSectionAssociation-aanvraag

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

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

   <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:replaceSectionAssociationRequest>

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

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

         <ims:sectionAssociationRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:sectionAssociation>

               <!--Optioneel:-->

               <ims:title>

                  <ims:language>en-US</ims:language>

                  <ims:textString>Demo Section Association</ims:textString>

               </ims:title>

               <!--Optioneel:-->

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

               <!--Optioneel:-->

               <ims:courseSectionIdList>

                  <!--1 of meer herhalingen:-->

                  <ims:courseSectionId>Demo_Section_01</ims:courseSectionId>

               </ims:courseSectionIdList>

            </ims:sectionAssociation>

         </ims:sectionAssociationRecord>

      </ims:replaceSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor replaceSectionAssociation-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
Code sectiekoppeling	sectionAssociationRecord.sourcedGUID.sourcedId	Ja
Naam sectiekoppeling	sectionAssociationRecord.sourcedGUID.sourcedId	Ja
Naam sectiekoppeling	sectionAssociationRecord.sectionAssociation.title.textString	Nee
Sectie-id's	sectionAssociationRecord.sectionAssociation.courseSectionIdList{*}.CourseSectionId	Ja
Status	sectionAssociationRecord.sectionAssociation.status	Nee

Voorbeeld van replaceSectionAssociation-respons

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

   <s:Header>

      <h:imsx_syncResponseHeaderInfo

          xmlns:h="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

          xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

          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>CMS_replaceSectionAssociation_20120419T002302_0384880Z</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 van replaceSectionAssociation-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 readSectionAssociation-aanvraag

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

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

   <soapenv:Header>

      <ims:imsx_syncRequestHeaderInfo>

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

         <ims:imsx_messageIdentifier>MessageID_774290</ims:imsx_messageIdentifier>

      </ims:imsx_syncRequestHeaderInfo>

   </soapenv:Header>

   <soapenv:Body>

      <ims:readSectionAssociationRequest>

         <ims:sourcedId>Demo_Section_Association</ims:sourcedId>

      </ims:readSectionAssociationRequest>

   </soapenv:Body>

</soapenv:Envelope>

Voorbeeld van readSectionAssociation-respons

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

   <s:Header>

      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

         xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0"

         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>CMS_readSectionAssociation_20120803T145419_1122428Z</imsx_messageIdentifier>

         <imsx_statusInfo>

            <imsx_codeMajor>success</imsx_codeMajor>

            <imsx_severity>warning</imsx_severity>

            <imsx_messageRefIdentifier>MessageId_774290</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">

      <readSectionAssociationResponse xmlns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">

         <sectionAssociationRecord>

            <sourcedGUID>

               <sourcedId>Demo_Section_Association</sourcedId>

            </sourcedGUID>

            <sectionAssociation/>

         </sectionAssociationRecord>

      </readSectionAssociationResponse>

   </s:Body>

</s:Envelope>