API

Revoke the current Provider offer qualification

Generated from the checked-in source. Do not edit this reference by hand.

POST /api/v1/providers/{provider}/offers/{offer}/qualification/revoke

Platform administration required. Appends an immutable reason digest and audit, clears the current offer review and pauses that offer atomically. Missing/deleted Provider, missing offer or absence of a current review conflicts, including repeated revocation. Other offers and historical request charges or earnings are unchanged.

Operation: revokeProviderOfferQualification.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X POST "$NIU_ORIGIN/api/v1/providers/{provider}/offers/{offer}/qualification/revoke" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @request.json

Parameters

provider

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

offer

Location: path. Required.

{
  "type": "string",
  "format": "uuid"
}

Request body

application/json

Required.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reason_sha256"
  ],
  "properties": {
    "reason_sha256": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$",
      "description": "SHA-256 digest of independently reviewed evidence; lowercase hexadecimal. Evidence content is not uploaded by this operation."
    }
  }
}

Responses

HTTP 200

Qualification transaction committed.

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "qualification_status"
      ],
      "properties": {
        "qualification_status": {
          "type": "string",
          "enum": [
            "revoked"
          ]
        }
      }
    }
  }
}

HTTP 400

Invalid path UUID, malformed JSON, evidence digest, expiry or review metadata.

HTTP 401

Missing or invalid administrator authentication.

HTTP 403

Authenticated principal lacks platform management permission.

HTTP 409

Missing resource or qualification/revision prerequisites no longer hold.

HTTP 415

Request is not JSON.

HTTP 422

JSON has missing, unknown or incorrectly typed fields.

HTTP 500

Unexpected internal persistence failure.

HTTP 503

Persistence temporarily unavailable; no successful qualification is confirmed.

Behavior and supported scope

Supported scope: implemented