Delete Membership

Functional Overview

This function may be used to unenroll a student or remove an instructor from a course in Turnitin

deleteMembership

This function takes a membership ID and removes the enrollment information associated with it. If the ID is found and is associated with this account and API product then the membership relationship is removed.

Parameters

Required:

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

Optional:

none: //

Outputs

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 deleteMembership 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/deleteMembership"
  Content-length: 672
  Source: 12
  Authorization: OAuth oauth_nonce="c6a09c4bf9a13f251ba6c5afb79a153cba2cb98a",
       oauth_timestamp="1337867278",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="dho86DWHnpxcf9Z3iTBOGf%2Fed8A%3D",
       oauth_signature="DfQ66uiHNkIW2ZIcdLk1jzw1CWE%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>21451722-1668-489d-bbb3-ef9104ea25ea</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:deleteMembershipRequest>
          <ns1:sourcedId>19065</ns1:sourcedId>
      </ns1:deleteMembershipRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example deleteMembership 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>21451722-1668-489d-bbb3-ef9104ea25ea</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Membership object successfully deleted.</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:deleteMembershipResponse xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0"/>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>