This API is under construction. Some of the details documented here may change.

Create Membership

Functional Overview

This function may be used to create memberships, or associations between instructors or students to classes within Turnitin

createByProxyMembership

This function takes a class ID, user ID and role and joins the user to that class with the specified role. A membership ID is returned which can be used to identify that enrollment object.

If the call is successful the membership ID associated with the new membership relationship is returned in the SOAP response message.

Parameters

Required:
sourceId
//integer. max size xxx. unique identifier for class
sourceId
//integer. max size xxx. unique identifier for user
roleType
//String.(Values "Learner or...?"). User role.
Optional:
none
//

Outputs

sourceId
//integer. max size xxx. unique identifier for membership
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

CodeText
XXX "description"
XXX "description"
XXX "description"

Example createByProxyMembership 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/createByProxyMembership"
  Content-length: 1030
  Source: 12
  Authorization: OAuth oauth_nonce="bfbcddb8f77cf0c58a337cdc3313285042312f54",
       oauth_timestamp="1337867273",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="877r2OkBLT1sh8%2BEbCEvLRV2PZQ%3D",
       oauth_signature="Fl2w9FSGOPA93%2BzV0pDS4B2%2BkEI%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>7370b48d-7149-4c56-8f40-4e8325fc30cc</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:createByProxyMembershipRequest>
          <ns1:membershipRecord>
              <ns1:sourcedGUID>
                  <ns1:sourcedId/>
              </ns1:sourcedGUID>
              <ns1:membership>
                  <ns1:collectionSourcedId>20005116</ns1:collectionSourcedId>
                  <ns1:membershipIdType>courseSection</ns1:membershipIdType>
                  <ns1:member>
                      <ns1:personSourcedId>100012288</ns1:personSourcedId>
                      <ns1:role>
                          <ns1:roleType>Learner</ns1:roleType>
                      </ns1:role>
                  </ns1:member>
              </ns1:membership>
          </ns1:membershipRecord>
      </ns1:createByProxyMembershipRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example createByProxyMembership 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>7370b48d-7149-4c56-8f40-4e8325fc30cc</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Membership processed successfully.</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:createByProxyMembershipResponse xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
      <tns:sourcedId>19064</tns:sourcedId>
  </tns:createByProxyMembershipResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>