# Service Test KCI Examples

Examples are available within the API documentation but here are some common end-to-end example KCIs demonstrating full
scenarios.

## KCI: FAILED_TO_SEND

Where the Fibre Cafe cannot send the service test request to a supplier due to an error, an error KCI will be sent.


```json Service Test
{
  "id": "1256cf7d-4471-42e4-a5be-c24ed58a7aa6",
  "supplier": "FIBRECO",
  "sequenceNumber": 1,
  "issuedOn": "2024-04-23T10:25:54.000Z",
  "receivedOn": "2024-04-23T10:25:24.000Z",
  "deliveredOn": "2024-04-23T10:26:54.000Z",
  "updateType": "ERROR",
  "entityType": "SERVICE_TEST",
  "entity": {
    "id": 123,
    "status": "FAILED_TO_SEND",
    "serviceId": "BBEU00537760",
    "serviceSpecification": {
      "id": "FTTP"
    },
    "supplier": "FIBRECO",
    "problemType": "OUTAGE",
    "characteristics": [
      {
        "name": "SERVICE_HAS_WORKED",
        "value": "true"
      },
      {
        "name": "SERVICE_LAST_WORKED",
        "value": "2024-04-20T09:45:00.000Z"
      }
    ]
  },
  "error": {
    "uuid": "8a3138c9-6523-48b9-81bc-5870bdb5972f",
    "code": "SUPPLIER_FAULT",
    "messages": [
      "The supplier API returned the following message: 500 Service unavailable"
    ]
  }
}
```

This KCI is terminal and a new service test must be created.

## KCI: SENT_TO_SUPPLIER

Fibre Cafe will send a KCI once the service test request has been sent to the supplier:


```json Service Test
{
  "id": "1256cf7d-4471-42e4-a5be-c24ed58a7aa6",
  "supplier": "FIBRECO",
  "sequenceNumber": 1,
  "issuedOn": "2024-04-23T10:25:54.000Z",
  "receivedOn": "2024-04-23T10:25:24.000Z",
  "deliveredOn": "2024-04-23T10:26:54.000Z",
  "updateType": "INFORMATIONAL",
  "information": {
    "type": "UPDATE"
  },
  "entityType": "SERVICE_TEST",
  "entity": {
    "id": 123,
    "status": "SENT_TO_SUPPLIER",
    "serviceId": "BBEU00537760",
    "serviceSpecification": {
      "id": "FTTP"
    },
    "supplier": "FIBRECO",
    "problemType": "OUTAGE",
    "characteristics": [
      {
        "name": "SERVICE_HAS_WORKED",
        "value": "true"
      },
      {
        "name": "SERVICE_LAST_WORKED",
        "value": "2024-04-20T09:45:00.000Z"
      }
    ]
  }
}
```

This will be followed by 1 of 2 types of KCIs: IN_PROGRESS or REJECTED.

## KCI: IN_PROGRESS

Once the supplier receives the service test request and it meets initial validation rules, it will be acknowledged by the supplier
and a KCI will be sent.


```json Service Test
{
  "id": "1256cf7d-4471-42e4-a5be-c24ed58a7aa5",
  "supplier": "FIBRECO",
  "sequenceNumber": 2,
  "issuedOn": "2024-04-23T10:35:54.000Z",
  "receivedOn": "2024-04-23T10:35:24.000Z",
  "deliveredOn": "2024-04-23T10:36:54.000Z",
  "updateType": "INFORMATIONAL",
  "information": {
    "type": "COMMITTED"
  },
  "entityType": "SERVICE_TEST",
  "entity": {
    "id": 123,
    "status": "IN_PROGRESS",
    "serviceId": "BBEU00537760",
    "supplierReference": "BBEU1234567824/04/2024 10:45:46GBEXJ",
    "serviceSpecification": {
      "id": "FTTP"
    },
    "supplier": "FIBRECO",
    "problemType": "OUTAGE",
    "characteristics": [
      {
        "name": "SERVICE_HAS_WORKED",
        "value": "true"
      },
      {
        "name": "SERVICE_LAST_WORKED",
        "value": "2024-04-20T09:45:00.000Z"
      }
    ]
  }
}
```

## KCI: REJECTED

If the service test does not meet validation rules, the service test will be rejected via a terminated KCI.


```json Service Test
{
  "id": "1256cf7d-4471-42e4-a5be-c24ed58a7aa9",
  "supplier": "FIBRECO",
  "sequenceNumber": 2,
  "issuedOn": "2024-04-23T10:35:54.000Z",
  "receivedOn": "2024-04-23T10:35:24.000Z",
  "deliveredOn": "2024-04-23T10:36:54.000Z",
  "updateType": "INFORMATIONAL",
  "information": {
    "type": "TERMINATED",
    "code": "INVALID_REQUEST",
    "text": "The supplier is unable to validate the serviceId. Please check the serviceId and retest the service.",
    "supplierCode": "SL09"
  },
  "entityType": "SERVICE_TEST",
  "entity": {
    "id": 123,
    "status": "REJECTED",
    "serviceId": "BBEU00537760",
    "serviceSpecification": {
      "id": "FTTP"
    },
    "supplier": "FIBRECO",
    "problemType": "OUTAGE",
    "characteristics": [
      {
        "name": "SERVICE_HAS_WORKED",
        "value": "true"
      },
      {
        "name": "SERVICE_LAST_WORKED",
        "value": "2024-04-20T09:45:00.000Z"
      }
    ]
  }
}
```

This KCI is terminal and a new service test must be created/submitted.

## KCI: COMPLETED

The service test has been completed and this KCI contains the test results:


```json Service test
{
  "id": "1256cf7d-4471-42e4-a5be-c24ed58a7aa7",
  "supplier": "FIBRECO",
  "sequenceNumber": 3,
  "issuedOn": "2024-04-23T10:45:54.000Z",
  "receivedOn": "2024-04-23T10:45:24.000Z",
  "deliveredOn": "2024-04-23T10:46:54.000Z",
  "updateType": "INFORMATIONAL",
  "information": {
    "type": "COMPLETED"
  },
  "entityType": "SERVICE_TEST",
  "entity": {
    "id": 123,
    "status": "COMPLETED",
    "serviceId": "BBEU00537760",
    "supplierReference": "BBEU1234567824/04/2024 10:45:46GBEXJ",
    "serviceSpecification": {
      "id": "FTTP"
    },
    "supplier": "FIBRECO",
    "problemType": "OUTAGE",
    "characteristics": [
       {
        "name": "SERVICE_HAS_WORKED",
        "value": "true"
       },
       {
        "name": "SERVICE_LAST_WORKED",
        "value": "2024-04-20T09:45:00.000Z"
       }
    ],
    "result": {
        "testValidity" : "2024-04-23T12:45:24.000Z",
        "testOutcome": {
          "testResult": "RED",
          "code": "NETWORK_NODE_ISSUE",
          "description": "The service test has detected a potential issue with a network node. Service problem may be raised to the supplier for further investigation, once end user checks have been completed.",
          "supplierText": "Potential Performance issue has been identified related to a network node. Device Id is <SNE ID>. Please pass to BTW for further diagnostics.",
          "supplierCodes": [
              "ND510"
          ]
        }
    }
  }
}
```