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.

The gateway will validate the request and generate a unique ID which is returned. If the problem amendment is rejected immediately then a 4XX code will be returned with reason(s) for the rejection in the response.

The problem amendment will then be sent to the supplier for processing and further updates will be sent via KCIs - this could include a rejection if the request 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 amended

problemText
string [ 10 .. 80 ] characters

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

Array of objects (ServiceProblemCharacteristic) non-empty

Update any characteristics of the problem

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 - refer to developer portal

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 new reserved appointment

Responses
201

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

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Request samples
application/json
{
  • "serviceProblemId": 123,
  • "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ],
  • "hazards": "Hazardous materials stored on site",
  • "onSiteRestrictions": "Restricted access",
  • "notes": "Lorem ipsum dolor sit amet...",
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345
}
Response samples
application/json
{
  • "id": 123,
  • "status": "REJECTED",
  • "serviceProblemId": 123,
  • "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ],
  • "hazards": "Hazardous materials stored on site",
  • "onSiteRestrictions": "Restricted access",
  • "notes": "Lorem ipsum dolor sit amet...",
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345
}