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

You can delete an enrollment by sending the POST request to the following URL: /enrollment/delete.

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

Request Headers

X-Auth-Account-Url (required)

The base URL of the account, e.g. http://myaccount.ispringlearn.com.
X-Auth-Email (required)The login of Account OwnerAdministratorDepartment Administrator, Publisher or a user with a role with custom settings allowing to delete enrollments. 
X-Auth-Password (required)The password of Account OwnerAdministratorDepartment Administrator, Publisher or a user with a role with custom settings allowing to delete enrollments. 

enrollmentIds

The IDs of the enrollments you want to delete.

Header

Description

After the request has been successfully processed, the system returns the response with the 204 code.

Response Codes

CodeTextDescription
204Successful operationThe enrollment has been successfully deleted.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission deniedThe user doesn't have enough permissions to delete enrollments.

Sample Request

POST /enrollment/delete HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

<?xml version="1.0" encoding="UTF-8"?>
<DeleteEnrollments>
  <enrollmentIds>
    <id>c4f74ae0-e029-11e9-ba51-0a580af4b0f</id>
  </enrollmentIds>
</DeleteEnrollments>

Пример ответа

HTTP/1.1 204 Successful operation
Connection: close
  • No labels