diff --git a/Connectivity.md b/Connectivity.md index 229b1aa..e1ddf13 100644 --- a/Connectivity.md +++ b/Connectivity.md @@ -9,13 +9,42 @@ Accept: application/json ```json { + "addresses": [ + { + "address": "13, Peveril Crescent", + "district": "MR", + "easting": "381233", + "gold": true, + "northing": "394561", + "parent_uprn": null, + "reference": "A00011178054", + "uprn": "77079066" + }, + { + /* and more of the same */ + } + ], + "query": { + "postcode": "M21 9WR" + } } ``` -## `GET https://api.faelix.net/connectivity/xdsl/address/service/availability/?address=A00034156395&district=MR` +## `GET https://api.faelix.net/connectivity/xdsl/address/service/availability/?reference=A00034156395&district=MR` +```json ```json { + "address": { + "district": "MR", + "gold": true, + "parent_uprn": null, + "reference": "A00034156395", + "uprn": null + }, + "line": { /* and then similar to below */ + /* ... */ + } } ``` @@ -24,7 +53,7 @@ Accept: application/json ```json { "address": null, - "line": { + "line": { /* information about line(s) available */ "ADSL2+": { "exchangeStatusDescription": "Live", "mdfSiteId": "MRCHO", @@ -169,53 +198,79 @@ Accept: application/json } }, "lines": { - "C000003101007": { + "C000003101007": { /* line ID */ "last2digits": "95", "line": "WorkingLine", - "number": null, - "service": "PSTN Single Line" + "number": null, /* will probably be null */ + "service": "PSTN Single Line" /* standard line */ }, "MRAAACQQFJ": { "last2digits": null, "line": "WorkingLine", "number": null, - "service": "SMPF" + "service": "SMPF" /* shared metallic path, e.g. TalkTalk LLU */ } }, - "messages": [ + "messages": [ /* might have list of strings detailing problems */ ], "onts": { + "ONT0012345678": { /* ONT reference number */ + "location": { + "floor": null, + "position": null, + "room": null + }, + "ports": { + "1": { + "data": true, + "status": "Spare" + }, + "2": { + "data": true, + "status": "Working" + }, + "3": { + "data": true, + "status": "Working" + }, + "4": { + "data": true, + "status": "Spare" + } + }, + "serial": "XXXXXXXXXXXXXXXX" /* should appear on the actual ONT */ + } }, "provisioning": "Migration", "query": { "cli": "01618629595" }, "reference": "bf862de7-1c91-49e8-a619-baf2301dce1a", - "services": { - "ADSL2+": { /* broadband service type */ - "ADSL2PLUS": { /* product code */ - "appointment": "NotRequired", /* might also be Optional or Required */ - "care": [ /* care level options available */ + "services": { /* THIS IS WHAT YOU WANT! */ + "ADSL2+": { /* broadband service type */ + "ADSL2PLUS": { /* product code */ + "appointment": "NotRequired", /* might also be Optional or Required */ + "care": [ /* care level options available */ "Standard", "Enhanced", "Critical" ], - "contact": "NotRequired", /* might also be Optional or Required */ + "contact": "NotRequired", /* might also be Optional or Required */ "description": null, "earliest": "2023-03-21T00:00:00+00:00", - "install": null, + "install": 40.0, /* wholesale cost for new install, excluding VAT (and WLR) */ "market": "B", - "migrate": null, - "monthly": null, - "name": "ADSL2+", + "migrate": 16.5, /* wholesale cost for migration, excluding VAT */ + "monthly": 7.5, /* wholesale monthly charge, excluding VAT */ + "name": "ADSL2+", /* customer-facing name of product */ "network": "Zen", - "orderable": true, /* is this available? */ - "priority": [ /* traffic weighting options available */ + "orderable": true, /* is this available? */ + "priority": [ /* traffic weighting options available */ "Standard" ], "provisioning": "Migration", - "status": null, /* additional information about status of orderability */ - "term": 12 /* number of months minimum term */ + "status": null, /* additional information about status of orderability */ + "term": 12 /* number of months minimum term */ }, "earliest": "2023-03-20T00:00:00+00:00", "market": "B",