Documentatie over integraties

De Beheerservice voor cursussjablonen (CTMS)

Deze service wordt gebruikt voor interactie met de cursussjablonen van Brightspace®.

Geïmplementeerde activiteiten

deleteCourseTemplate
replaceCourseTemplate
readCourseTemplate

Info over de deleteCourseTemplate-bewerking

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

Processtroom: deleteCourseTemplate

Wanneer een een aanvraag voor een LIS-deleteCourseTemplate wordt ontvangen, haalt de adapter de unieke id voor de sjabloon rechtstreeks op uit het veld sourcedId van de aanvraag, zonder een inplugbaar omzettingsprogramma te gebruiken.
De handlers van het IPSIS-platform die zijn geconfigureerd voor IDeleteCourseTemplateHandler verwerken de aanvraag.
De LIS-respons wordt gegenereerd op basis van de respons van de handler.

Voorbeeld van een deleteCourseTemplate-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:deleteCourseTemplateRequest>

         <ims:sourcedId>Demo_Course_Template</ims:sourcedId>

      </ims:deleteCourseTemplateRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor deleteCourseTemplate-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	deleteCourseTemplateRequest.sourcedId	Ja

Voorbeeld van deleteCourseTemplate-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>CTMS_deleteCourseTemplate_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 deleteCourseTemplate-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 readCourseTemplate-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:readCourseTemplateRequest>

        <ims:sourcedId>Demo_Template</ims:sourcedId>

      </ims:readCourseTemplateRequest>

   </soapenv:Body>

</soapenv:Envelope>

Voorbeeld van een ReadCourseTemplate-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_readCourseOffering_20120803T145419_1122428Z</imsx_messageIdentifier>

         <imsx_statusInfo>            <imsx_codeMajor>succes</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">

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

         <courseTemplateRecord>

           <sourcedGUID>

              <sourcedId>Demo_Template</sourcedId>

            </sourcedGUID>

            <courseTemplate/>

         </courseTemplateRecord>

      </readCourseTemplateResponse>

   </s:Body>

</s:Envelope>