Page tree
Skip to end of metadata
Go to start of metadata

You can delete an enrollment with the unenroll method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators, Publishers, or users with a role with custom settings allowing to delete enrollments.

Parameters

ParameterTypeОписание
credentials (required)credentialsRead the description of the Credentials object.
enrollmentId (required)string

The ID of the enrollment you want us to delete.

Return Value

After the request has been successfully processed, the system returns an object with the following properties:

ParameterTypeDescription
successboolTrue if the enrollment has been deleted.

Possible Errors

Error

Description

Permission deniedThe user has no permissions to delete enrollments.
Wrong parameters

The enrollment with the given ID hasn't been found. 

Sample Request

 <?xml version="1.0" encoding="utf-8"?>
 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                    xmlns="http://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
     <UnenrollRequest>
       <credentials>
         <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
         <email>email@email.com</email>
         <password>password</password>
       </credentials>
       <enrollmentId>string</enrollmentId>
     </UnenrollRequest>
   </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <successResult>
      <success>true</success>
    </successResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels