# Request to cancel an inflight service problem.

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

The Fibre Cafe 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.

Endpoint: POST /service-problem-cancellations
Version: 1.17
Security: oauth2

## Header parameters:

  - `X-Request-ID` (string, required)
    Unique identifier to identify request and response events across the Fibre Cafe gateway

  - `X-Conversation-ID` (string, required)
    Identifier to track message journey across the Fibre Cafe gateway

## Request fields (application/json):

  - `serviceProblemId` (number, required)
    Unique reference identifying the service problem to be cancelled
    Example: 123

  - `reasonCode` (string, required)
    Codes representing reason for cancellation of the service problem:

- ISSUE_RESOLVED
- CUSTOMER_NETWORK_ISSUE
- NO_LONGER_REQUIRED
- OTHER
    Example: "CUSTOMER_NETWORK_ISSUE"

  - `text` (string)
    Textual reason for cancellation - provides more context as applicable
    Example: "Issue appears to have rectified itself."

## Response 201 fields (application/json):

  - `id` (number, required)
    Unique reference identifying this service problem cancellation request (generated by Fibre Cafe)
    Example: 123

  - `status` (string, required)
    State model for amendment and cancellation requests.
    Enum: "RECEIVED_BY_GATEWAY", "PENDING", "FAILED_TO_SEND", "REJECTED", "COMPLETED"

  - `serviceProblemId` (number, required)
    Unique reference identifying the service problem to be cancelled
    Example: 123

  - `reasonCode` (string, required)
    Codes representing reason for cancellation of the service problem:

- ISSUE_RESOLVED
- CUSTOMER_NETWORK_ISSUE
- NO_LONGER_REQUIRED
- OTHER
    Example: "CUSTOMER_NETWORK_ISSUE"

  - `text` (string)
    Textual reason for cancellation - provides more context as applicable
    Example: "Issue appears to have rectified itself."

## Response 400 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 401 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 422 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]

## Response 500 fields (application/json):

  - `uuid` (string, required)
    Unique identifier of this error - for tracing purposes
    Example: "87432dfb-2e47-4532-a1b7-4b113d48867d"

  - `code` (string, required)
    Fibre Cafe error codes
    Enum: "GATEWAY_FAULT", "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT", "SUPPLIER_TIMED_OUT", "TENANT_FAULT"

  - `messages` (array, required)
    Message describing the error
    Example: ["e.g. Invalid value for field x - accepted values are y"]


## Response 403 fields

## Response 503 fields