Retrieve current service problem details including updates (KCIs).

get/service-problems/{id}

This endpoint is called to retrieve the current details (including KCIs) about a service problem request.

Securityoauth2
Request
path Parameters
id
required
string

Find order details relating to the specified service problem

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

Responses
200

Request successful - service problem details were returned

400

Bad request - supplied request was malformed or missing mandatory parameters

401

Unauthorised access

403

The client is not permitted to access this resource.

404

Service Problem not found with the specified id

422

Unprocessable entity - invalid data was provided

500

Unexpected Fibre Gateway error

503

Fibre Gateway is temporarily unavailable

Response samples
application/json
{
  • "id": 123,
  • "status": "ACKNOWLEDGED",
  • "created": "2022-01-01T09:09:33.001Z",
  • "updated": "2022-01-01T09:45:39.001Z",
  • "supplierIdentifier": "A123X",
  • "updates": [
    • {
      • "id": "3456cf7d-4471-42e4-a5be-c24ed58a7aa6",
      • "supplier": "SUPPLIER1",
      • "sequenceNumber": 1,
      • "issuedOn": "2022-01-10T09:00:00.000Z",
      • "receivedOn": "2022-01-10T09:00:00.000Z",
      • "deliveredOn": "2022-01-10T09:00:00.000Z",
      • "deliveryStatus": "PENDING",
      • "updateType": "ACTION_REQUIRED",
      • "supplierNotes": [
        • {
          • "note": "Lorem ipsum dolor sit amet...",
          • "type": "Engineer Note",
          • "created": "2022-01-01T09:09:33.001Z"
          }
        ],
      • "information": {
        • "type": "CREATED",
        • "code": "NETWORK_ISSUE",
        • "text": "Resolving network issue",
        • "supplierCode": "313"
        },
      • "action": {
        • "type": "INFORMATION_REQUIRED",
        • "code": "NETWORK_ISSUE",
        • "text": "Fault between Node and Toby.",
        • "supplierCode": "313"
        },
      • "error": {
        • "uuid": "87432dfb-2e47-4532-a1b7-4b113d48867d",
        • "code": "GATEWAY_FAULT",
        • "messages": [
          • "e.g. Invalid value for field x - accepted values are y"
          ]
        },
      • "serviceProblemResolution": {
        • "id": 123,
        • "serviceProblemId": 123,
        • "status": "REJECTED",
        • "resolvedDate": "2022-01-10T09:00:00.000Z",
        • "closedDate": "2022-01-10T09:00:00.000Z",
        • "resolutionDetails": {
          • "resolutionCode": "NETWORK_ISSUE",
          • "resolutionCategory": "FAULTY_EQUIPMENT",
          • "resolutionText": "string",
          • "supplierCodes": [
            • "R9"
            ],
          • "faultCode": [
            • "DAMAGED_ONT"
            ]
          },
        • "slaViolation": [
          • "EXCEEDED_SLA_TIME_TO_REPAIR"
          ],
        • "tenantNotes": "The problem was not resolved"
        },
      • "serviceProblemAmendment": {
        • "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
        },
      • "serviceProblemCancellation": {
        • "id": 123,
        • "status": "REJECTED",
        • "serviceProblemId": 123,
        • "reasonCode": "CUSTOMER_NETWORK_ISSUE",
        • "text": "Issue appears to have rectified itself."
        }
      }
    ],
  • "externalIdentifier": "DS-2345432345345",
  • "problemType": "PERFORMANCE",
  • "problemText": "The service keeps dropping between 6pm and 9pm every evening.",
  • "serviceId": "SI2345432345345",
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "FTTH"
    },
  • "address": {
    • "id": "A00000031882",
    • "type": "NAD",
    • "additionalIdentifiers": [
      • {
        • "id": "A00000031882",
        • "type": "NAD"
        }
      ]
    },
  • "supplier": "DUMMY_SUPPLIER",
  • "serviceTestId": 123,
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ],
  • "primaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "secondaryContact": {
    • "name": "John Smith",
    • "email": "john@smith.com",
    • "phoneNumber": "01234 567890"
    },
  • "appointmentReservationId": 345,
  • "parentServiceProblemId": 2443435345,
  • "hazards": "Hazardous materials stored on site",
  • "onSiteRestrictions": "Restricted access",
  • "notes": "Lorem ipsum dolor sit amet..."
}