ideal-postcodes / postcodes.io

UK postcode & geolocation API, serving up open data
https://postcodes.io
MIT License
1.24k stars 249 forks source link

Documentation missing fields #1145

Open paulgrove opened 1 year ago

paulgrove commented 1 year ago

While writing an assignment at university I noticed that the api was returning some undocumented fields for the /postcodes endpoint:

    # the follow fields were found during testing but are undocumented at https://postcodes.io/docs
    "date_of_introduction", "pfa", "codes.pfa",
    "codes.parliamentary_constituency", "codes.ccg_id", "codes.ced" 

These fields can be seen here by calling GET api.postcodes.io/postcodes/RG304HY:

{
    "status": 200,
    "result": {
        "postcode": "RG30 4HY",
        "quality": 1,
        "eastings": 467515,
        "northings": 172767,
        "country": "England",
        "nhs_ha": "South Central",
        "longitude": -1.029814,
        "latitude": 51.449873,
        "european_electoral_region": "South East",
        "primary_care_trust": "Berkshire West",
        "region": "South East",
        "lsoa": "Reading 009A",
        "msoa": "Reading 009",
        "incode": "4HY",
        "outcode": "RG30",
        "parliamentary_constituency": "Reading West",
        "admin_district": "Reading",
        "parish": "Reading, unparished area",
        "admin_county": null,
        "date_of_introduction": "199507",
        "admin_ward": "Tilehurst",
        "ced": null,
        "ccg": "NHS Buckinghamshire, Oxfordshire and Berkshire West",
        "nuts": "Berkshire",
        "pfa": "Thames Valley",
        "codes": {
            "admin_district": "E06000038",
            "admin_county": "E99999999",
            "admin_ward": "E05013878",
            "parish": "E43000031",
            "parliamentary_constituency": "E14000890",
            "ccg": "E38000221",
            "ccg_id": "15A",
            "ced": "E99999999",
            "nuts": "TLJ11",
            "lsoa": "E01016394",
            "msoa": "E02003397",
            "lau2": "E06000038",
            "pfa": "E23000029"
        }
    }
}

Please note that I do not know the meaning of these fields, nor do I need to know what they are, just bringing to your attention that the documentation is out of date.

Kind Regards

markembling commented 9 hours ago

I believe ccg_id is documented but as ccg_code rather than with the actual name. Came to raise that exact issue but feel like it fits within this existing issue neatly.