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 gateway will validate the request and generate a unique ID which is returned. If the problem cancellation is rejected immediately then a 4XX code will be returned with reason(s) for the rejection in the response.

The problem cancellation will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the cancellation does not meet supplier validation/processing rules.

Securityoauth2
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

Request Body schema: application/json
serviceProblemId
required
number >= 1

Unique reference identifying the service problem to be cancelled

reasonCode
required
string (ProblemCancellationReasonCode) ^[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

Problem 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

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Request samples
application/json
{
  • "serviceProblemId": 123,
  • "reasonCode": "CUSTOMER_NETWORK_ISSUE",
  • "text": "Issue appears to have rectified itself."
}
Response samples
application/json
{
  • "id": 123,
  • "status": "REJECTED",
  • "serviceProblemId": 123,
  • "reasonCode": "CUSTOMER_NETWORK_ISSUE",
  • "text": "Issue appears to have rectified itself."
}