# Request to amend an inflight service problem.

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

A request will contain 1 or more fields to be amended - only fields supplied should be changed.

The supplier should validate the amendment 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 amendment if further validation/processing
is required. In this scenario, the supplier must then send an update (KCI) to later confirm the amendment was 
applied or if rejected.

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

Endpoint: POST /service-problem-amendments
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 identifier for this service problem amendment request (generated by the Fibre Cafe)
    Example: 23467

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

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

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

  - `problemText` (string)
    The description of problem being raised as defined by the end user.
    Example: "The service keeps dropping between 6pm and 9pm every evening."

  - `escalationRequest` (boolean)
    Request to escalate the problem based on agreed SLA's.
    Example: true

  - `characteristics` (array)
    List of characteristics providing context on the problem

  - `characteristics.name` (string, required)
    Name of the object characteristic
    Example: "END_USER_CPE"

  - `characteristics.value` (string, required)
    Value for this characteristic
    Example: "Zyzel DX3301"

  - `primaryContact` (object)
    Represents a contact available at the given site/address.

  - `primaryContact.name` (string, required)
    Contact name
    Example: "John Smith"

  - `primaryContact.email` (string)
    Contact email address (if available)
    Example: "john@smith.com"

  - `primaryContact.phoneNumber` (string, required)
    Contact phone number
    Example: "01234 567890"

  - `secondaryContact` (object)
    Represents a contact available at the given site/address.

  - `appointmentReservationId` (number)
    Unique identifier for the reserved appointment (if applicable)
    Example: 345

  - `appointmentReservationReference` (string)
    Unique reference identifying the appointment - supplier reference (if applicable)
    Example: "A234X"

  - `hazards` (string)
    Hazard information about the site where the service will be restored
    Example: "Hazardous materials stored on site"

  - `onSiteRestrictions` (string)
    Information about restrictions on the site where the service will be restored
    Example: "Restricted access"

  - `notes` (string)
    Notes about the problem which are required by the supplier. This includes additional information that may be required
    Example: "Lorem ipsum dolor sit amet..."

## Response 201 fields (application/json):

  - `id` (number, required)
    Unique identifier for this service problem amendment request (generated by the Fibre Cafe)
    Example: 23467

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

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

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

  - `problemText` (string)
    The description of problem being raised as defined by the end user.
    Example: "The service keeps dropping between 6pm and 9pm every evening."

  - `escalationRequest` (boolean)
    Request to escalate the problem based on agreed SLA's.
    Example: true

  - `characteristics` (array)
    List of characteristics providing context on the problem

  - `characteristics.name` (string, required)
    Name of the object characteristic
    Example: "END_USER_CPE"

  - `characteristics.value` (string, required)
    Value for this characteristic
    Example: "Zyzel DX3301"

  - `primaryContact` (object)
    Represents a contact available at the given site/address.

  - `primaryContact.name` (string, required)
    Contact name
    Example: "John Smith"

  - `primaryContact.email` (string)
    Contact email address (if available)
    Example: "john@smith.com"

  - `primaryContact.phoneNumber` (string, required)
    Contact phone number
    Example: "01234 567890"

  - `secondaryContact` (object)
    Represents a contact available at the given site/address.

  - `appointmentReservationId` (number)
    Unique identifier for the reserved appointment (if applicable)
    Example: 345

  - `appointmentReservationReference` (string)
    Unique reference identifying the appointment - supplier reference (if applicable)
    Example: "A234X"

  - `hazards` (string)
    Hazard information about the site where the service will be restored
    Example: "Hazardous materials stored on site"

  - `onSiteRestrictions` (string)
    Information about restrictions on the site where the service will be restored
    Example: "Restricted access"

  - `notes` (string)
    Notes about the problem which are required by the supplier. This includes additional information that may be required
    Example: "Lorem ipsum dolor sit amet..."

## Response 202 fields (application/json):

  - `id` (number, required)
    Unique identifier for this service problem amendment request (generated by the Fibre Cafe)
    Example: 23467

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

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

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

  - `problemText` (string)
    The description of problem being raised as defined by the end user.
    Example: "The service keeps dropping between 6pm and 9pm every evening."

  - `escalationRequest` (boolean)
    Request to escalate the problem based on agreed SLA's.
    Example: true

  - `characteristics` (array)
    List of characteristics providing context on the problem

  - `characteristics.name` (string, required)
    Name of the object characteristic
    Example: "END_USER_CPE"

  - `characteristics.value` (string, required)
    Value for this characteristic
    Example: "Zyzel DX3301"

  - `primaryContact` (object)
    Represents a contact available at the given site/address.

  - `primaryContact.name` (string, required)
    Contact name
    Example: "John Smith"

  - `primaryContact.email` (string)
    Contact email address (if available)
    Example: "john@smith.com"

  - `primaryContact.phoneNumber` (string, required)
    Contact phone number
    Example: "01234 567890"

  - `secondaryContact` (object)
    Represents a contact available at the given site/address.

  - `appointmentReservationId` (number)
    Unique identifier for the reserved appointment (if applicable)
    Example: 345

  - `appointmentReservationReference` (string)
    Unique reference identifying the appointment - supplier reference (if applicable)
    Example: "A234X"

  - `hazards` (string)
    Hazard information about the site where the service will be restored
    Example: "Hazardous materials stored on site"

  - `onSiteRestrictions` (string)
    Information about restrictions on the site where the service will be restored
    Example: "Restricted access"

  - `notes` (string)
    Notes about the problem which are required by the supplier. This includes additional information that may be required
    Example: "Lorem ipsum dolor sit amet..."

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