CmiService

Click here for a complete list of operations.

Read

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/CmiService.asmx HTTP/1.1
Host: scormplayer.digitaal.noordhoff.nl
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.icodeon.com/services/cmi/Read"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Read xmlns="http://www.icodeon.com/services/cmi">
      <RteDataModel action="Initialize or Terminate or Commit" domain="string" pk="string" learnerName="string" learner="string" course="string" org="string" sco="string" session="string" adlNavRequest="string" rteSchemaVersion="string">
        <cocd xmlns="http://ltsc.ieee.org/xsd/1484_11_3">
          <commentsFromLearner collectionType="string" spm="string">
            <commentFromLearner xsi:nil="true" />
            <commentFromLearner xsi:nil="true" />
          </commentsFromLearner>
          <commentsFromLMS collectionType="string" spm="string">
            <commentFromLMS xsi:nil="true" />
            <commentFromLMS xsi:nil="true" />
          </commentsFromLMS>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <completionThreshold>decimal</completionThreshold>
          <credit>credit or no_credit</credit>
          <dataModelVersion spm="string" />
          <entry>ab_initio or resume or </entry>
          <exit>logout or normal or suspend or timeout or </exit>
          <interactions collectionType="string" spm="string">
            <interaction xsi:nil="true" />
            <interaction xsi:nil="true" />
          </interactions>
          <launchData spm="string" />
          <learnerId spm="string" />
          <learnerName spm="string" />
          <learnerPreferenceData>
            <audioLevel>decimal</audioLevel>
            <language>language</language>
            <deliverySpeed>decimal</deliverySpeed>
            <audioCaptioning>off or no_change or on</audioCaptioning>
          </learnerPreferenceData>
          <lessonStatus>browsed or completed or failed or incomplete or not_attempted or passed</lessonStatus>
          <location spm="string" />
          <maxTimeAllowed>duration</maxTimeAllowed>
          <mode>browse or normal or review</mode>
          <objectives collectionType="string" spm="string">
            <objective xsi:nil="true" />
            <objective xsi:nil="true" />
          </objectives>
          <progressMeasure>decimal</progressMeasure>
          <rawPassingScore>decimal</rawPassingScore>
          <scaledPassingScore>decimal</scaledPassingScore>
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <sessionTime>duration</sessionTime>
          <successStatus>failed or passed or unknown</successStatus>
          <suspendData spm="string" />
          <timeLimitAction>continue_message or continue_no_message or exit_message or exit_no_message</timeLimitAction>
          <totalTime>duration</totalTime>
        </cocd>
      </RteDataModel>
    </Read>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <cocd xmlns="http://ltsc.ieee.org/xsd/1484_11_3">
      <commentsFromLearner collectionType="string" spm="string">
        <commentFromLearner>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLearner>
        <commentFromLearner>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLearner>
      </commentsFromLearner>
      <commentsFromLMS collectionType="string" spm="string">
        <commentFromLMS>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLMS>
        <commentFromLMS>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLMS>
      </commentsFromLMS>
      <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
      <completionThreshold>decimal</completionThreshold>
      <credit>credit or no_credit</credit>
      <dataModelVersion spm="string" />
      <entry>ab_initio or resume or </entry>
      <exit>logout or normal or suspend or timeout or </exit>
      <interactions collectionType="string" spm="string">
        <interaction>
          <identifier spm="string" />
          <type>true_false or multiple_choice or fill_in or long_fill_in or likert or matching or performance or sequencing or numeric or other</type>
          <objectiveIds collectionType="string" spm="string">
            <objectiveId xsi:nil="true" />
            <objectiveId xsi:nil="true" />
          </objectiveIds>
          <timeStamp>dateTime</timeStamp>
          <correctResponses>xml</correctResponses>
          <weighting>decimal</weighting>
          <learnerResponse>xml</learnerResponse>
          <result>string</result>
          <latency>duration</latency>
          <description spm="string" />
        </interaction>
        <interaction>
          <identifier spm="string" />
          <type>true_false or multiple_choice or fill_in or long_fill_in or likert or matching or performance or sequencing or numeric or other</type>
          <objectiveIds collectionType="string" spm="string">
            <objectiveId xsi:nil="true" />
            <objectiveId xsi:nil="true" />
          </objectiveIds>
          <timeStamp>dateTime</timeStamp>
          <correctResponses>xml</correctResponses>
          <weighting>decimal</weighting>
          <learnerResponse>xml</learnerResponse>
          <result>string</result>
          <latency>duration</latency>
          <description spm="string" />
        </interaction>
      </interactions>
      <launchData spm="string" />
      <learnerId spm="string" />
      <learnerName spm="string" />
      <learnerPreferenceData>
        <audioLevel>decimal</audioLevel>
        <language>language</language>
        <deliverySpeed>decimal</deliverySpeed>
        <audioCaptioning>off or no_change or on</audioCaptioning>
      </learnerPreferenceData>
      <lessonStatus>browsed or completed or failed or incomplete or not_attempted or passed</lessonStatus>
      <location spm="string" />
      <maxTimeAllowed>duration</maxTimeAllowed>
      <mode>browse or normal or review</mode>
      <objectives collectionType="string" spm="string">
        <objective>
          <identifier spm="string" />
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <status>browsed or completed or failed or incomplete or not_attempted or passed</status>
          <progressMeasure>decimal</progressMeasure>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <successStatus>failed or passed or unknown</successStatus>
          <description spm="string" />
        </objective>
        <objective>
          <identifier spm="string" />
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <status>browsed or completed or failed or incomplete or not_attempted or passed</status>
          <progressMeasure>decimal</progressMeasure>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <successStatus>failed or passed or unknown</successStatus>
          <description spm="string" />
        </objective>
      </objectives>
      <progressMeasure>decimal</progressMeasure>
      <rawPassingScore>decimal</rawPassingScore>
      <scaledPassingScore>decimal</scaledPassingScore>
      <score>
        <scaled>decimal</scaled>
        <max>decimal</max>
        <min>decimal</min>
        <raw>decimal</raw>
      </score>
      <sessionTime>duration</sessionTime>
      <successStatus>failed or passed or unknown</successStatus>
      <suspendData spm="string" />
      <timeLimitAction>continue_message or continue_no_message or exit_message or exit_no_message</timeLimitAction>
      <totalTime>duration</totalTime>
    </cocd>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/CmiService.asmx HTTP/1.1
Host: scormplayer.digitaal.noordhoff.nl
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Read xmlns="http://www.icodeon.com/services/cmi">
      <RteDataModel action="Initialize or Terminate or Commit" domain="string" pk="string" learnerName="string" learner="string" course="string" org="string" sco="string" session="string" adlNavRequest="string" rteSchemaVersion="string">
        <cocd xmlns="http://ltsc.ieee.org/xsd/1484_11_3">
          <commentsFromLearner collectionType="string" spm="string">
            <commentFromLearner xsi:nil="true" />
            <commentFromLearner xsi:nil="true" />
          </commentsFromLearner>
          <commentsFromLMS collectionType="string" spm="string">
            <commentFromLMS xsi:nil="true" />
            <commentFromLMS xsi:nil="true" />
          </commentsFromLMS>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <completionThreshold>decimal</completionThreshold>
          <credit>credit or no_credit</credit>
          <dataModelVersion spm="string" />
          <entry>ab_initio or resume or </entry>
          <exit>logout or normal or suspend or timeout or </exit>
          <interactions collectionType="string" spm="string">
            <interaction xsi:nil="true" />
            <interaction xsi:nil="true" />
          </interactions>
          <launchData spm="string" />
          <learnerId spm="string" />
          <learnerName spm="string" />
          <learnerPreferenceData>
            <audioLevel>decimal</audioLevel>
            <language>language</language>
            <deliverySpeed>decimal</deliverySpeed>
            <audioCaptioning>off or no_change or on</audioCaptioning>
          </learnerPreferenceData>
          <lessonStatus>browsed or completed or failed or incomplete or not_attempted or passed</lessonStatus>
          <location spm="string" />
          <maxTimeAllowed>duration</maxTimeAllowed>
          <mode>browse or normal or review</mode>
          <objectives collectionType="string" spm="string">
            <objective xsi:nil="true" />
            <objective xsi:nil="true" />
          </objectives>
          <progressMeasure>decimal</progressMeasure>
          <rawPassingScore>decimal</rawPassingScore>
          <scaledPassingScore>decimal</scaledPassingScore>
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <sessionTime>duration</sessionTime>
          <successStatus>failed or passed or unknown</successStatus>
          <suspendData spm="string" />
          <timeLimitAction>continue_message or continue_no_message or exit_message or exit_no_message</timeLimitAction>
          <totalTime>duration</totalTime>
        </cocd>
      </RteDataModel>
    </Read>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <cocd xmlns="http://ltsc.ieee.org/xsd/1484_11_3">
      <commentsFromLearner collectionType="string" spm="string">
        <commentFromLearner>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLearner>
        <commentFromLearner>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLearner>
      </commentsFromLearner>
      <commentsFromLMS collectionType="string" spm="string">
        <commentFromLMS>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLMS>
        <commentFromLMS>
          <comment spm="string" />
          <location spm="string" />
          <timeStamp>dateTime</timeStamp>
        </commentFromLMS>
      </commentsFromLMS>
      <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
      <completionThreshold>decimal</completionThreshold>
      <credit>credit or no_credit</credit>
      <dataModelVersion spm="string" />
      <entry>ab_initio or resume or </entry>
      <exit>logout or normal or suspend or timeout or </exit>
      <interactions collectionType="string" spm="string">
        <interaction>
          <identifier spm="string" />
          <type>true_false or multiple_choice or fill_in or long_fill_in or likert or matching or performance or sequencing or numeric or other</type>
          <objectiveIds collectionType="string" spm="string">
            <objectiveId xsi:nil="true" />
            <objectiveId xsi:nil="true" />
          </objectiveIds>
          <timeStamp>dateTime</timeStamp>
          <correctResponses>xml</correctResponses>
          <weighting>decimal</weighting>
          <learnerResponse>xml</learnerResponse>
          <result>string</result>
          <latency>duration</latency>
          <description spm="string" />
        </interaction>
        <interaction>
          <identifier spm="string" />
          <type>true_false or multiple_choice or fill_in or long_fill_in or likert or matching or performance or sequencing or numeric or other</type>
          <objectiveIds collectionType="string" spm="string">
            <objectiveId xsi:nil="true" />
            <objectiveId xsi:nil="true" />
          </objectiveIds>
          <timeStamp>dateTime</timeStamp>
          <correctResponses>xml</correctResponses>
          <weighting>decimal</weighting>
          <learnerResponse>xml</learnerResponse>
          <result>string</result>
          <latency>duration</latency>
          <description spm="string" />
        </interaction>
      </interactions>
      <launchData spm="string" />
      <learnerId spm="string" />
      <learnerName spm="string" />
      <learnerPreferenceData>
        <audioLevel>decimal</audioLevel>
        <language>language</language>
        <deliverySpeed>decimal</deliverySpeed>
        <audioCaptioning>off or no_change or on</audioCaptioning>
      </learnerPreferenceData>
      <lessonStatus>browsed or completed or failed or incomplete or not_attempted or passed</lessonStatus>
      <location spm="string" />
      <maxTimeAllowed>duration</maxTimeAllowed>
      <mode>browse or normal or review</mode>
      <objectives collectionType="string" spm="string">
        <objective>
          <identifier spm="string" />
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <status>browsed or completed or failed or incomplete or not_attempted or passed</status>
          <progressMeasure>decimal</progressMeasure>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <successStatus>failed or passed or unknown</successStatus>
          <description spm="string" />
        </objective>
        <objective>
          <identifier spm="string" />
          <score>
            <scaled>decimal</scaled>
            <max>decimal</max>
            <min>decimal</min>
            <raw>decimal</raw>
          </score>
          <status>browsed or completed or failed or incomplete or not_attempted or passed</status>
          <progressMeasure>decimal</progressMeasure>
          <completionStatus>completed or incomplete or not_attempted or unknown</completionStatus>
          <successStatus>failed or passed or unknown</successStatus>
          <description spm="string" />
        </objective>
      </objectives>
      <progressMeasure>decimal</progressMeasure>
      <rawPassingScore>decimal</rawPassingScore>
      <scaledPassingScore>decimal</scaledPassingScore>
      <score>
        <scaled>decimal</scaled>
        <max>decimal</max>
        <min>decimal</min>
        <raw>decimal</raw>
      </score>
      <sessionTime>duration</sessionTime>
      <successStatus>failed or passed or unknown</successStatus>
      <suspendData spm="string" />
      <timeLimitAction>continue_message or continue_no_message or exit_message or exit_no_message</timeLimitAction>
      <totalTime>duration</totalTime>
    </cocd>
  </soap12:Body>
</soap12:Envelope>