DeleteE-LearningEnrollment

DELETE https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId

Delete an enrollment for an e-learning.

Path Parameters

courseId string required
Course ID
enrollmentId string required
Enrollment ID

Header Parameters

training-provider-id string required

Responses

Enrollment deleted

Default Response

application/json

Schema
Example (from schema)

Schema

anyOf
- MOD1
- MOD2
statusCode number required
code string
Error code
error string required
Error key
message string required
Error message

{
  "statusCode": 0,
  "code": "string",
  "error": "string",
  "message": "string"
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: An Authorization Header with an auth-scheme of BLN including auth-params type, version, entity, key, token and secret. Example: `bln type=api, version=1, entity=user, key=<api-key>, token=<api-token>, secret=<api-secret>`

Request

Base URL

https://shared-tp-api-test.30a.dev

ApiKey

courseId — path required

enrollmentId — path required

training-provider-id — header required

curl / cURL
curl -L -X DELETE 'https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios
curl -L -X DELETE 'https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests
curl -L -X DELETE 'https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId' \
-H 'Authorization: <API_KEY_VALUE>'

java / okhttp
curl -L -X DELETE 'https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / restsharp
curl -L -X DELETE 'https://shared-tp-api-test.30a.dev/tp-api/e-learning/:courseId/enrollments/:enrollmentId' \
-H 'Authorization: <API_KEY_VALUE>'