diff --git a/Connectivity.md b/Connectivity.md index e1ddf13..645d80a 100644 --- a/Connectivity.md +++ b/Connectivity.md @@ -281,3 +281,104 @@ Accept: application/json } } ``` + +## `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/available` + +Returns a dict mapping test types to information about the tests. Will only return tests available for that type of line. + +```json +{ + "adsl-xdsl-service-test": { "description": "ADSL Service Test" }, + "adsl-copper-service-test": { "description": "Copper Service Test" }, + "adsl-copper-line-test": { "description": "Copper Line Test" }, + "sogea-service-test": { "description": "SOGEA Service Test" }, + "fttc-service-test": { "description": "FTTC Service Test" }, + "gfast-service-test": { "description": "GFast Service Test" }, + "fttp-service-test": { "description": "FTTP Service Test" } +} +``` + +## `POST https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test` + +Starts a test, and returns a redirect (via `Location: ` header) where you can then `GET` the results. + +```json +Location: https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test/result/beeb411e-d15b-43db-810c-b850fa123253 + +{ + "id": "beeb411e-d15b-43db-810c-b850fa123253" +} +``` + +## `GET https://api.faelix.net/connectivity/xdsl/test/zen/ZW01234567XX/test/xxxx-service-test/result/beeb411e-d15b-43db-810c-b850fa123253` + +Returns a blob of raw JSON test results. Will be different for different test types. Not a valid result (yet) if the `dataFrom` key has no value associated. + +We set two additional keys to make interpreting simpler: `failure` (true or false) and `suspicious` (true or false). + +```json +{ + "dataFrom": "2023-10-05T22:38:01Z", + "errorMessage": null, + "failure": false, + "suspicious": false, + "lineHistory": { + "downstreamRate": { + "avg": 79.9, + "max": 79.9, + "min": 79.9 + }, + "retrains": { + "avg": 0.0, + "max": 0.0, + "min": 0.0 + }, + "upstreamRate": { + "avg": 20.0, + "max": 20.0, + "min": 20.0 + }, + "uptime": { + "avg": 900.0, + "max": 900.0, + "min": 900.0 + } + }, + "lineTest": { + "bridgeTap": 0, + "crossTalk": 0, + "faceplate": "Not Detected", + "homeWiringProblem": 2, + "mainFaultLocation": 1, + "ntE5c": "Not Detected", + "ntePowerStatus": 1, + "radioFrequencyIngress": 0, + "repetitiveElectricalImpulseNoise": 0, + "testOutcome": 1, + "testOutcomeDescription": "GEA service test completed and no fault found .", + "voiceReinjection": "Not Detected" + }, + "profileData": { + "currentPolicy": 3, + "dateOfLastProfileChange": null, + "profileDownstream": "0.128M-80M Downstream, Retransmission Low", + "profileUpstream": "0.128M-20M Upstream, Error Protection Off" + }, + "state": 20, + "type": "sogea-service-test", + "uuid": "beeb411e-d15b-43db-810c-b850fa123253", + "xDslStatusCheck": { + "currentSyncTime": null, + "estimatedSpeedAtProvisioningDownstream": null, + "estimatedSpeedAtProvisioningUpstream": null, + "orderedProductDownstream": 80.0, + "orderedProductUpstream": 20.0, + "retrainsDetected": 2, + "syncSpeedDownstream": 79.9, + "syncSpeedUpstream": 20.0, + "syncStatus": 1, + "unavailableSecondsLast15Minutes": 0.0, + "unavailableSecondsLast15MinutesStartDate": "2023-10-05T21:15:45" + } +} +```