# 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 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.

Endpoint: POST /service-problem-cancellations
Version: 1.15
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

  - `Tenant` (string, required)
    The tenant that has placed the request on the Fibre Cafe
    Example: "TENANT1"

## Request fields (application/json):

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

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

  - `supplierServiceProblemReference` (string, required)
    Unique reference generated by the supplier for the service problem
    Example: "SK_PRO233827673"

  - `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 the Fibre Cafe)
    Example: 123365

  - `supplierReference` (string)
    Unique reference identifying this service problem cancellation request as generated by the supplier
    Example: "SI_RE233827673"

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

  - `supplierServiceProblemReference` (string, required)
    Unique reference generated by the supplier for the service problem
    Example: "SK_PRO233827673"

  - `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 202 fields (application/json):

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

  - `supplierReference` (string)
    Unique reference identifying this service problem cancellation request as generated by the supplier
    Example: "SI_RE233827673"

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

  - `supplierServiceProblemReference` (string, required)
    Unique reference generated by the supplier for the service problem
    Example: "SK_PRO233827673"

  - `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: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_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: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_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: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_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: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_FAULT"

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

## Response 501 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: "INVALID_REQUEST", "MALFORMED_REQUEST", "NOT_AUTHORISED", "NOT_FOUND", "NOT_IMPLEMENTED", "SUPPLIER_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