Request to cancel an inflight service problem.

post/service-problem-cancellations

This endpoint is called to request cancellation of an existing inflight service problem on an active service.

The supplier should validate the cancellation request. If the request is invalid or not possible then a 422 code should be returned with reason(s) for the rejection in the response.

The supplier may return a 202 accepted response without confirming the cancellation if further validation/processing is required. In this scenario, the supplier must then send an update (KCI) to later confirm the cancellation was completed or if rejected.

Alternatively, the supplier can confirm the cancellation immediately by returning a 201 created response.

SecuritybearerAuth
Request
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the gateway

X-Conversation-ID
required
string

Identifier to track message journey across the gateway

Tenant
required
string

The tenant that has placed the request on the gateway

Example: TENANT1
Request Body schema: application/json
id
required
number >= 1

Unique reference identifying this service problem cancellation request (generated by Fibre Cafe Gateway)

serviceProblemId
required
number >= 1

Unique reference identifying the service problem to be cancelled

supplierServiceProblemReference
required
string^[A-Z0-9_]{5,25}

Unique reference generated by the supplier for the service problem

reasonCode
required
string (ServiceProblemCancellationReasonCode) ^[A-Z_]{5,50}

Codes representing reason for cancellation of the service problem:

  • ISSUE_RESOLVED
  • CUSTOMER_NETWORK_ISSUE
  • NO_LONGER_REQUIRED
  • OTHER
text
string [ 1 .. 1000 ] characters

Textual reason for cancellation - provides more context as applicable

Responses
201

Order cancellation request was successful and the order has been cancelled.

202

Order cancellation request has been received and will be confirmed or rejected later by a KCI

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

422

Unprocessable entity - invalid data was provided

500

Invalid or failed response from the supplier

501

The supplier has not implemented this endpoint

503

Supplier API is temporarily unavailable

Request samples
application/json
{
  • "id": 123365,
  • "serviceProblemId": 12356,
  • "supplierServiceProblemReference": "SK_PRO233827673",
  • "reasonCode": "CUSTOMER_NETWORK_ISSUE",
  • "text": "Issue appears to have rectified itself."
}
Response samples
application/json
{
  • "id": 123365,
  • "supplierReference": "SI_RE233827673",
  • "serviceProblemId": 12356,
  • "supplierServiceProblemReference": "SK_PRO233827673",
  • "reasonCode": "CUSTOMER_NETWORK_ISSUE",
  • "text": "Issue appears to have rectified itself."
}