Documentatie over integraties

De Course Offering Management Service (COMS)

Deze service wordt gebruikt om D2L®-cursusedities te beïnvloeden.

Geïmplementeerde activiteiten

deleteCourseOffering
replaceCourseOffering
readCourseOffering

Info over de deleteCourseOffering-bewerking

De deleteCourseOffering-bewerking wordt gebruikt om D2L®-organisatie-eenheden te verwijderen die zijn gekoppeld aan de LIS-cursusedities.

Processtroom: deleteCourseOffering

Wanneer een aanvraag voor een LIS-deleteCourseOffering wordt ontvangen, verkrijgt de adapter de unieke id voor de cursuseditie rechtstreeks uit het sourcedId-veld van de aanvraag, zonder een inplugbaar omzettingsprogramma te gebruiken.
Zodra de id van de cursuseditie is verkregen, worden de handlers van het IPSIS-platform die zijn geconfigureerd voor IDeleteCourseOfferingHandler gebruikt om de aanvraag te verwerken.
De LIS-respons wordt gegenereerd op basis van de respons van de handler om het proces te voltooien.

Voorbeeld van deleteCourseOffering-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:deleteCourseOfferingRequest>

         <ims:sourcedId>Demo_Course_Offering</ims:sourcedId>

      </ims:deleteCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor deleteCourseOffering-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	deleteCourseOfferingRequest.sourcedId	Ja

Voorbeeld van deleteCourseOfferingResponse

<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>COMS_deleteCourseOffering_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 deleteCourseOffering-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 replaceCourseOffering-bewerking

replaceCourseOffering is de bewerking die wordt gebruikt voor het maken of bijwerken van Brightspace®-cursusedities.

Als u de standaardconfiguraties gebruikt, kunt u na succes controleren of de cursuseditie is gemaakt of bijgewerkt via de browser voor configuratievariabelen in Brightspace®, Cursussen beheren, of de widget Mijn cursussen.

Processtroom: replaceCourseOffering

Wanneer een LIS-aanvraag replaceCourseOffering wordt ontvangen, wordt de aanvraag vertaald met behulp van de LIS-omzettingsprogramma's die zijn geconfigureerd voor ITranslateCourseOffering, waardoor de aanvraag wordt omgezet in een indeling die het IPSIS-platform kan begrijpen.
Zodra de aanvraag is vertaald, worden de IPSIS-platformhandlers die zijn geconfigureerd voor IReplaceCourseOfferingHandler gebruikt om de aanvraag te verwerken.
Vervolgens wordt een LIS-respons gegenereerd uit de respons van de handler om het proces te voltooien.

Voorbeeld van replaceCourseOffering-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:replaceCourseOfferingRequest>

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

         <ims:sourcedId>Demo_Offering</ims:sourcedId>

         <ims:courseOfferingRecord>

            <ims:sourcedGUID>

               <ims:sourcedId>Demo_Offering</ims:sourcedId>

            </ims:sourcedGUID>

            <ims:courseOffering>

               <ims:title>

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

                  <ims:textString>Demo Offering</ims:textString>

               </ims:title>

               <ims:parentTemplateId>Demo_Template</ims:parentTemplateId>

               <!--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>

               </ims:org>

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

               <ims:timeFrame>

                  <!--Optioneel:-->

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

                  <!--Optioneel:-->

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

               </ims:timeFrame>

            </ims:courseOffering>

         </ims:courseOfferingRecord>

      </ims:replaceCourseOfferingRequest>

   </soapenv:Body>

</soapenv:Envelope>

Koptekst- en tekstvelden voor replaceCourseOffering-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 IS-aanvraag	Verplicht
Code	courseOfferingRecord.sourcedGUID.sourcedId	Ja
Naam	courseOfferingRecord.courseOffering.title.textString	Ja
Bovenliggende TemplateId	courseOfferingRecord.courseOffering.parentTemplateId	Ja
Bovenliggende SemesterId	courseOfferingRecord.courseOffering.academicSession.textString	Nee
Bovenliggende DepartmentId	courseOfferingRecord.courseOffering.org.orgName.textString	Nee
Startdatum	courseOfferingRecord.courseOffering.timeframe(0).begin	Nee
Einddatum	courseOfferingRecord.courseOffering.timeframe(0).end	Nee
Status	courseOfferingRecord.courseOffering.status	Nee

Voorbeeld van replaceCourseOffering-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_replaceCourseOffering_20120113T180550_5936594Z</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 replaceCourseOffering-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 readCourseOffering

readCourseOffering is de bewerking die wordt gebruikt om informatie over het IPSIS-platform over de LIS-cursusedities te lezen.

De LIS 2.0-adapter accepteert de volgende velden in de aanvraag:

LIS XML-element	D2L®-gegevens	Verplicht
readCourseOfferingRequest.sourcedId	OrgUnitCode	Ja

Voorbeeld van ReadCourseOffering-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:readCourseOfferingRequest>

			<ims:sourcedId>Demo_Offering</ims:sourcedId>

		</ims:readCourseOfferingRequest>

	</soapenv:Body>

</soapenv:Envelope>

Voorbeeld van readCourseOffering-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<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">

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

         <courseOfferingRecord>

            <sourcedGUID>

               <sourcedId<Demo_Offering</sourcedId>

           </sourcedGUID>

            <courseOffering/>

         </courseOfferingRecord>

      </readCourseOfferingResponse>

   </s:Body>

</s:Envelope>