Perform a service test on an active live/service.

This endpoint is called to request a service test on an active line/service.

The supplier should validate and accept the request if the validation is successful or otherwise reject it. If the service test is rejected, a 422 code should be returned with reason(s) for the rejection in the response.

If the service test is accepted, the supplier should return a 201 created response with the service test reference and start the test. The result of the service test should be sent asynchronously via the Fibre Gateway - Supplier Updates API once the test has completed.

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 test request (generated by the Fibre Cafe Gateway)

serviceId
required
string [ 1 .. 50 ] characters

Identifier of an existing live service

required
object (ServiceSpecification)

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

problemType
required
string (ServiceProblemType) ^[A-Z_]{5,25}

Codes representing the type of problem being encountered by the end user:

  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
  • CUSTOMER
  • CPE
Responses
201

Request was received by the supplier - result of service test will be sent 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

Invalid or failed response from the supplier

501

The supplier has not implemented this endpoint

503

Supplier API is temporarily unavailable

post/service-tests
Request samples
application/json
{
  • "id": 23467,
  • "serviceId": "SI2345432345",
  • "serviceSpecification": {
    • "id": "ftthl2r"
    },
  • "problemType": "STABILITY"
}
Response samples
application/json
{
  • "supplierReference": "A123X",
  • "id": 23467,
  • "serviceId": "SI2345432345",
  • "serviceSpecification": {
    • "id": "ftthl2r",
    • "name": "FTTH"
    },
  • "problemType": "STABILITY"
}