Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, Publishers, and users with a custom role can delete enrollments assigned to users from the departments they manage and their sub-departments.
Parameter | Type | Description |
---|---|---|
token (required) | string | Access token. You can obtain a token by making a request. |
enrollmentId (required) | string | The ID of the enrollment you want us to delete. |
After the request has been successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
success | bool | True if the enrollment has been deleted. |
Error | Description |
---|---|
Permission denied | The user has no permissions to delete enrollments. |
Wrong parameters | The enrollment with the given ID hasn't been found. |
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <UnenrollRequest> <credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <enrollmentId>string</enrollmentId> </UnenrollRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <successResult> <success>true</success> </successResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |