Read Membership

Functional Overview

These functions may be used to retrieve information about one or more memberships, or associations between instructors and or students to classes within Turnitin.

readMembership

This function takes a membership ID and reads the enrollment information from it. If the ID and both user and class are associated with this account and API product then the class ID, user ID and role type is returned in a success response message.

Required:

sourceId: //integer. max size xxx. unique identifier for membership

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for class
sourceId: //integer. max size xxx. unique identifier for user
userRole: //string. ....
codeMajor: //string. max size xxx. returns "success" or "Failure"
codeMinor: //string. max siz xxx. returns "success", "partial success", "error"
description: //string. max siz xxx. description of successful action completed OR error encountered

Error Codes & Text

Code	Text
XXX	"description"
XXX	"description"
XXX	"description"

Example readMembership SOAP Request

   Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/mms2p0/readMembership"
  Content-length: 668
  Source: 12
  Authorization: OAuth oauth_nonce="14d466dc3088676df44838d8fcaef58a05c89ae4",
       oauth_timestamp="1337867275",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="wjry%2BtueZ356OAQ8dUu2MkcglLg%3D",
       oauth_signature="MANvEcOZSjLOJtPihkYAj%2BD3%2FxA%3D"

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns:ns2="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>51eafa88-cf49-435e-9f61-4d1140cfd639</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readMembershipRequest>
          <ns1:sourcedId>19065</ns1:sourcedId>
      </ns1:readMembershipRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example readMembership SOAP Response

   <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
      <tns:imsx_syncResponseHeaderInfo xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>FB913478-A59C-11E1-86A0-ACB9EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>51eafa88-cf49-435e-9f61-4d1140cfd639</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Membership object found.</tns:imsx_description>
          <tns:imsx_codeMinor>
              <tns:imsx_codeMinorField>
                  <tns:imsx_codeMinorFieldName>TargetEndSystem</tns:imsx_codeMinorFieldName>
                  <tns:imsx_codeMinorFieldValue>fullsuccess</tns:imsx_codeMinorFieldValue>
              </tns:imsx_codeMinorField>
          </tns:imsx_codeMinor>
      </tns:imsx_statusInfo>
  </tns:imsx_syncResponseHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <tns:readMembershipResponse xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
      <tns:membershipRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>19065</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:membership>
              <tns:collectionSourcedId>20005116</tns:collectionSourcedId>
              <tns:membershipIdType>courseSection</tns:membershipIdType>
              <tns:member>
                  <tns:personSourcedId>100012289</tns:personSourcedId>
                  <tns:role>
                      <tns:roleType>Instructor</tns:roleType>
                  </tns:role>
              </tns:member>
          </tns:membership>
      </tns:membershipRecord>
  </tns:readMembershipResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

readMemberships

his function takes a set of membership IDs and returns the information associated with them, if the IDs are found and the class / users are associated with this account and API product then the class ID, user ID and role type is returned in a success response message. If any ID is not found or not associated with this account and API product then a partial success is returned. If none of the membership IDs are found or none belong to this account and API product then an error is returned.

Parameters

Required:

sourceId: //integer. max size xxx. unique identifier for membership

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for class
sourceId: //integer. max size xxx. unique identifier for user
userRole: //string. ....
codeMajor: //string. max size xxx. returns "success" or "Failure"
codeMinor: //string. max siz xxx. returns "success", "partial success", "error"
description: //string. max siz xxx. description of successful action completed OR error encountered

Error Codes & Text

Code	Text
XXX	"description"
XXX	"description"
XXX	"description"

Example readMemberships SOAP Request

  Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/mms2p0/readMemberships"
  Content-length: 743
  Source: 12
  Authorization: OAuth oauth_nonce="52d8e502ede15157bde6943ae1c65b9005b74dc0",
       oauth_timestamp="1337867277",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="Rkgskme1vqSu9BZhqV6%2FQgvg%2FC0%3D",
       oauth_signature="x8xES1ECPnY51%2BPSpd913iTkSFg%3D"

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns:ns2="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>6517a8c2-0ec1-4556-bad2-c77b5c4ef60d</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readMembershipsRequest>
          <ns1:sourcedIdSet>
              <ns1:sourcedId>19064</ns1:sourcedId>
              <ns1:sourcedId>19065</ns1:sourcedId>
          </ns1:sourcedIdSet>
      </ns1:readMembershipsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example readMemberships SOAP Response

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
      <tns:imsx_syncResponseHeaderInfo xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>FB913478-A59C-11E1-86A0-ACB9EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>6517a8c2-0ec1-4556-bad2-c77b5c4ef60d</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>2/2 Membership Objects returned.</tns:imsx_description>
          <tns:imsx_codeMinor>
              <tns:imsx_codeMinorField>
                  <tns:imsx_codeMinorFieldName>TargetEndSystem</tns:imsx_codeMinorFieldName>
                  <tns:imsx_codeMinorFieldValue>fullsuccess</tns:imsx_codeMinorFieldValue>
              </tns:imsx_codeMinorField>
          </tns:imsx_codeMinor>
      </tns:imsx_statusInfo>
  </tns:imsx_syncResponseHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <tns:readMembershipsResponse xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
      <tns:membershipRecordSet>
          <tns:membershipRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>19064</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:membership>
                  <tns:collectionSourcedId>20005116</tns:collectionSourcedId>
                  <tns:membershipIdType>courseSection</tns:membershipIdType>
                  <tns:member>
                      <tns:personSourcedId>100012288</tns:personSourcedId>
                      <tns:role>
                          <tns:roleType>Learner</tns:roleType>
                      </tns:role>
                  </tns:member>
              </tns:membership>
          </tns:membershipRecord>
          <tns:membershipRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>19065</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:membership>
                  <tns:collectionSourcedId>20005116</tns:collectionSourcedId>
                  <tns:membershipIdType>courseSection</tns:membershipIdType>
                  <tns:member>
                      <tns:personSourcedId>100012289</tns:personSourcedId>
                      <tns:role>
                          <tns:roleType>Instructor</tns:roleType>
                      </tns:role>
                  </tns:member>
              </tns:membership>
          </tns:membershipRecord>
      </tns:membershipRecordSet>
  </tns:readMembershipsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>