Create a service test record for an active service.

post/service-tests

This endpoint can be called to perform a service test on an active service.

The Fibre Cafe will validate the request and generate a service test identifier which is returned. If the test request is rejected immediately then a 4XX code will be returned with reason(s) for the rejection in the response.

The Fibre Cafe will internally determine the best supplier test to execute based on supplier and service specification attributes, in addition to the PROBLEM_TYPE characteristics supplied.

The service test result will be returned asynchronously via a KCI, and may also be queried via the GET /service-tests/{id} API.

Securityoauth2
Request
header Parameters
X-Request-ID
required
string

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-ID
required
string

Identifier to track message journey across the Fibre Cafe gateway

Request Body schema: application/json
serviceId
required
string [ 1 .. 50 ] characters

Identifier of an existing live service

problemType
required
string^[\w_]{3,15}

The type of problem being experienced with the service.

  • CPE
  • CUSTOMER
  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
required
object (ServiceSpecification)

Details of a service the supplier provides at the selected address.

supplier
required
string^[\w_]{1,20}

System identifier for a supplier on the Fibre Cafe that is associated with this service

required
Array of objects (ServiceTestCharacteristic) non-empty
Responses
201

Request was received by the Fibre Cafe and will be acknowledged later via 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 Cafe error

503

Fibre Cafe is temporarily unavailable

Request samples
application/json
{
  • "serviceId": "SI2345432345345",
  • "problemType": "string",
  • "serviceSpecification": {
    • "id": "ftthl2r"
    },
  • "supplier": "DUMMY_SUPPLIER",
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ]
}
Response samples
application/json
{
  • "id": 123,
  • "status": "IN_PROGRESS",
  • "created": "2022-01-01T09:09:33.001Z",
  • "updated": "2022-01-01T09:45:39.001Z",
  • "supplierReference": "A12345",
  • "serviceId": "SI2345432345345",
  • "problemType": "string",
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "FTTH"
    },
  • "supplier": "DUMMY_SUPPLIER",
  • "characteristics": [
    • {
      • "name": "string",
      • "value": "string"
      }
    ]
}