Documentatie over integraties

De Course Section Management Service (CSMS)

Deze service wordt gebruikt om invloed te hebben op de cursussecties (of -groepen) van Brightspace®.

Geïmplementeerde bewerkingen

deleteCourseSection
replaceCourseSection
readCourseSection

Info over de deleteCourseSection-bewerking

deleteCourseSection is de bewerking die wordt gebruikt voor het verwijderen van organisatie-eenheden in Brightspace® die aan LIS-cursussecties zijn gekoppeld.

Processtroom: deleteCourseSection

Bij ontvangst van een LIS deleteCourseSection-aanvraag haalt de adapter de unieke id voor de cursus rechtstreeks op vanuit het veld sourcedId van de aanvraag, zonder de gebruiker van een inplugbaar omzettingsprogramma.
Zodra de id van de cursussectie is opgehaald, worden de handlers van het IPSIS-platform die zijn geconfigureerd voor IDeleteCourseSectionHandler gebruikt om de aanvraag te verwerken.
De LIS-respons wordt gegenereerd op basis van de respons van de handler.

Voorbeeld van een deleteCourseSection-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:deleteCourseSectionRequest>

         <ims:sourcedId>LIS_Section_01</ims:sourcedId>

      </ims:deleteCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden van de deleteCourseSection-aanvraag

Velden van aanvraagkoptekst

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

Velden van aanvraagtekst

Eigenschap	Toewijzing LIS-aanvraag	Verplicht
Code	deleteCourseSectionRequest.sourcedId	Ja

Voorbeeld van deleteCourseSection-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 deleteCourseSection-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 replaceCourseSection-bewerkingen

replaceCourseSection is de bewerking die wordt gebruikt voor het maken of bijwerken van cursussecties of -groepen in Brightspace®.

Bij gebruik van de standaardconfiguraties kunt u na succes controleren of de groep is gemaakt dan wel bijgewerkt via de browser voor configuratievariabelen in Brightspace® of via de tool voor groepen en secties in de cursus (afhankelijk van de configuratie van de handler).

Processtroom: replaceCourseSection

Wanneer een LIS-aanvraag ReplaceCourseSection wordt ontvangen, vertaalt Brightspace® de aanvraag met behulp van de LIS-omzettingsprogramma's die zijn geconfigureerd voor ITranslateCourseSection om de aanvraag om te zetten in een indeling die het IPSIS-platform kan begrijpen.
De handlers van het IPSIS-platform die zijn geconfigureerd voor IReplaceCourseSectionHandler worden gebruikt om de aanvraag te verwerken.
Er wordt een LIS-respons gegenereerd op basis van de respons van de handler.

Voorbeeld van replaceCourseSection-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:replaceCourseSectionRequest>

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

         <ims:sourcedId>Demo_Section_01</ims:sourcedId>

         <ims:courseSectionRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Section_01</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseSection>

               <ims:title>

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

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

               </ims:title>

               <ims:parentOfferingId>Demo_Offering</ims:parentOfferingId>

               <!--Optioneel:-->

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

               <!--Optioneel:-->

               <ims:academicSession>

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

                  <ims:textString>Demo_Semester</ims:textString>

               </ims:academicSession>

               <!--Optioneel:-->

               <ims:org>

                  <!--Optioneel:-->

                  <ims:orgName>

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

                     <ims:textString>Demo_Department</ims:textString>

                  </ims:orgName>

               &lt:/ims:org>

               <ims:timeFrame>

                  <ims:begin>2012-01-01T00:00:00.000000</ims:begin>

                  <ims:end>2012-04-01T00:00:00.000000</ims:end>

               </ims:timeFrame>

            </ims:courseSection>

         </ims:courseSectionRecord>

      </ims:replaceCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor replaceCourseSection-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	sourcedGUID.sourcedId	Ja
Naam	courseSection.title.textString	Ja
Parent OfferingId	courseSection.parentOfferingId	Ja
Bovenliggende DepartmentId	courseSection.org.orgName	Ja
Bovenliggende SemesterId	courseSection.academicSession.textString	Nee
Startdatum	courseSection.timeFrame(0).begin	Ja
Einddatum	courseSection.timeFrame(0).end	Ja
Status	courseSection.status	Nee

Voorbeeld van een replaceCourseSection-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_replaceCourseSection_20120130T160616_8347289Z</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>

replaceCourseSection velden voor responskoptekst en -hoofdtekst

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 readCourseSection-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:ReadCourseSectionRequest>

         <ims:sourcedId<Demo_Section</ims:sourcedId>

      </ims:readCourseSectionRequest>

   </soapenv:Body>

</soapenv:Envelope>

Voorbeeld van readCourseSection-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_messageIdentifier>CMS_readCourseSection_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">

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

        <courseSectionRecord>

           <sourcedGUID>

               <sourcedId>Demo_Section</sourcedId>

           </sourcedGUID>

            <courseSection/>

        </courseSectionRecord>

      </readCourseSectionResponse>

   </s:Body>

</s:Envelope>