Cancelling a third-party product entitlement – SSP deployment

Request

To cancel a third-party product entitlement, the CRM system should send a POST request to:

https://<host>:<port>/crm-gateway/v2/rmg/v1/entitlements/{entitlementId}

Headers

• x-correlation-id  – identifier for logging, to correlate messages across a call flow

• Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)

• Content-Type: application/json

Mandatory arguments

• entitlementId (in URL)

• status (in body) – the updated status of the entitlement. In this case, it is CANCELLED.

• cancelReasonCategory (in body) – the cancellation reason category (see table below)

• cancelReasonCode (in body) – the cancellation reason code (see table below)

Valid cancellation categories and reasons are as follows:

Optional arguments

None for third-party product entitlements

Example

A PUT request with the following body will update the status of the entitlement whose ID is specified in the URL:

{
  "status": "CANCELLED",
  "cancelReasonCategory": "CUSTOMER_CANCELLED",
  "cancelReasonCode": "NOT_RENEWED"
}

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

If the specified tenant does not exist, the request returns an HTTP 404 status.

See the CRM Gateway API documentation v1 for the specific error codes and their meanings.

Example

A successful request returns the following response body:

{
  "matchedCount": 1,
  "modifiedCount": 1
}

See also

CRM Gateway API documentation v1