Skip to content

Commit

Permalink
Merge pull request #2297 from openedx/ENT-9460/update-bulk-revoke-docs
Browse files Browse the repository at this point in the history
docs: update bulk-revoke endpoint docs
  • Loading branch information
hamzawaleed01 authored Oct 14, 2024
2 parents 4719e96 + a15a077 commit 054cf0d
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions en_us/enterprise_api/source/api_reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1100,12 +1100,33 @@ Response

The ``POST enterprise/v1/subscriptions/{subscription_plan_uuid}/licenses/bulk-revoke`` request can return the following responses:

204 No Content - All revocations were successful.
200 OK - All revocations were successful. Returns a list of successful revocations.

400 Bad Request - Some error occurred when processing one of the revocations, no revocations were committed. An error message is provided.
207 Multi-Status - Some revocations were successful, but others failed. Returns both successful and failed revocations.

400 Bad Request - An error occurred when processing the request (e.g., invalid data format).

404 Not Found - No license exists in the plan for one of the given email addresses, or the license is not in an assigned or activated state. An error message is provided.

.. code-block:: json
{
"successful_revocations": [
{
"license_uuid": "string",
"original_status": "string",
"user_email": "string"
}
],
"unsuccessful_revocations": [
{
"error": "string",
"error_response_status": "integer",
"user_email": "string"
}
]
}
.. _Bulk-license-enrollment Endpoint:

*************************************************************************************
Expand Down

0 comments on commit 054cf0d

Please sign in to comment.