Request to amend an inflight service problem.

post/service-problem-amendments

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.

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 identifier for this service problem amendment request (generated by the Fibre Cafe Gateway)

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

Unique reference identifying this service problem amendment - generated by the supplier

serviceProblemId
required
number >= 1

Unique reference identifying the service problem to be amended

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

Unique reference generated by the supplier for the service problem

problemText
string [ 10 .. 80 ] characters

The description of problem being raised as defined by the end user.

escalationRequest
boolean

Request to escalate the problem based on agreed SLA's.

Array of objects (Characteristic) non-empty

List of characteristics providing context on the problem

object (Contact)

Represents a contact available at the given address - primary contact must be provided.

object (Contact)

Represents a contact available at the given address - primary contact must be provided.

appointmentReservationId
number >= 1

Unique identifier for the reserved appointment (if applicable)

appointmentReservationReference
string [ 1 .. 50 ] characters

Unique reference identifying the appointment - supplier reference (if applicable)

hazards
string [ 1 .. 1000 ] characters

Hazard information about the site where the service will be restored

onSiteRestrictions
string [ 1 .. 1000 ] characters

Information about restrictions on the site where the service will be restored

notes
string [ 1 .. 1000 ] characters

Notes about the problem which are required by the supplier. This includes additional information that may be required

Responses
201

Amendment request was successful and the service problem has been updated

202

Service problem amendment 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": 23467,
  • "supplierReference": "SI_RE233827673",
  • "serviceProblemId": 12356,
  • "supplierServiceProblemReference": "SK_PRO233827673",
  • "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  • "escalationRequest": true,
  • "characteristics": [
    • {
      • "name": "END_USER_CPE",
      • "value": "Zyzel DX3301"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "appointmentReservationReference": "A234X",
  • "hazards": "Hazardous materials stored on site",
  • "onSiteRestrictions": "Restricted access",
  • "notes": "Lorem ipsum dolor sit amet..."
}
Response samples
application/json
{
  • "id": 23467,
  • "supplierReference": "SI_RE233827673",
  • "serviceProblemId": 12356,
  • "supplierServiceProblemReference": "SK_PRO233827673",
  • "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  • "escalationRequest": true,
  • "characteristics": [
    • {
      • "name": "END_USER_CPE",
      • "value": "Zyzel DX3301"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "appointmentReservationReference": "A234X",
  • "hazards": "Hazardous materials stored on site",
  • "onSiteRestrictions": "Restricted access",
  • "notes": "Lorem ipsum dolor sit amet..."
}