Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation missing fields #1145

Open
paulgrove opened this issue Apr 22, 2023 · 1 comment
Open

Documentation missing fields #1145

paulgrove opened this issue Apr 22, 2023 · 1 comment

Comments

@paulgrove
Copy link

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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants