Request
To resume a suspended third-party product entitlement, the CRM system should send a POST request to:
https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/actions/resume
Headers
-
x-correlation-id– identifier for logging, to correlate messages across a call flow -
Authorization– Keycloak access token (see (25.12_Q1) Accessing operator APIs using Keycloak) -
nv-tenant-id– the tenant ID
Mandatory arguments
-
entitlementId(in URL) – the ID of the entitlement -
productId– (in body) the ID of the product that the entitlement relates to
Optional arguments
None
Example
A POST request with the following body will resume the suspended entitlement whose ID is specified in the URL:
{
"productId": "example_product_001"
}
Response
A successful request returns an HTTP 200 status.
If the request is awaiting confirmation from the third-party provider, the request returns an HTTP 202 status. When OPF receives this confirmation, it notifies your CRM system – see Implementing endpoints to handle notification and authorisation calls from OPF.
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 Third Party Entitlement Service (TPES) API documentation for the specific error codes and their meanings.