This documentation provides information on the Service Diagnostics API and how to access it.
Please note:
In this document, we use Buyer and Supplier for the Service Provider / CityFibre respectively and Reporter as the person within the Buyers Organisation.
This document describes the messages which can pass between Buyer and Supplier, and the various status changes and updates for diagnostic requests though-out the process.
The API is accessed via HTTPS. Calls are made by POST, sending XML as the HTTP body.
Messages are exchanged using SOAP exchanges over HTTPS POST, where the request is in the POST body and the response is in the HTTP response body. Messages are encapsulated in a SOAP envelope using Document/Literal style following WS-Basic Profile 1.0.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
... single request or response element goes here ...
</soap:Body>
</soap:Envelope>CityFibre provides two pre-production environments for the Buyer to integrate with, to allow the Buyer to test the API endpoint before going live.
Authentication is handled in the same way as the Order API and the authentication details provided apply to this API endpoint.
Below are the details for these environments:
Production: https://api-gw.cityfibre.com:41223/prod/api2
The Buyer can request diagnostic information for a serviceId reported in the request. The request will come synchronously and contain the serviceDiagnostic information.
The response to a requestServiceDiagnostics call contains the current state of the service and the utilisation status of the network path during the last busy period.
| Date | Change |
|---|---|
| 16/09/2024 | Added NBA (Next Best Action) codes to XSD and the explanations for them |
| 25/07/2024 | Removed incidents from currentStatus |
| 17/05/2024 | Added the Revision History document |
| 18/04/2024 | Added the explanations for UniPort Status values |
| 11/04/2024 | Added currentUniportStatus field to the XSD schema |
| 03/04/2024 | Added the node utilisation for Local and National Configurations |
| 08/03/2024 | Added the explanations for ONT Status and CFM Status values |
| 16/02/2024 | Fixed the buyerIdentifier field in the XSD schema |
| 15/02/2024 | Added the Service Diagnostic API diagram |
| 12/02/2024 | Updated the servicePathUsage field in the XSD schema |
No request payload