Starter Mode

List Top Five and Bottom Five Values of a Dataset

Endpoint: /api/starterMode

Request

Parameter Type Position Required Sample
Content-Type string Header Yes application/json
Accept string Header Yes application/json
Authorization string Header Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGci...
query json Body Yes JSON.stringify('[{ "dataset": "(+/-) Postcode Income Difference from London-wide Median", "metric": "Income", "metric_year": "2017", "postcode": "BR11AA" }]')

Success Response 

{
    "Data": [
        {
            "Metric": "Income",
            "Dataset": "(+/-) Postcode Income Difference from London-wide Median",
            "Postcodes": {
                "top_five": [
                    {
                        "postcode": "W1K 4DX",
                        "actual": "3832517.418"
                    },
                    {
                        "postcode": "W2 3BW",
                        "actual": "3538165.335"
                    },
                    {
                        "postcode": "W1D 1AF",
                        "actual": "3027276.685"
                    },
                    {
                        "postcode": "W1S 4AN",
                        "actual": "2657966.99"
                    },
                    {
                        "postcode": "W14 8PB",
                        "actual": "2650868.395"
                    }
                ],
                "bottom_five": [
                    {
                        "postcode": "RM6 6NY",
                        "actual": "-10575.85103"
                    },
                    {
                        "postcode": "RM6 5UE",
                        "actual": "-10472.16317"
                    },
                    {
                        "postcode": "E16 4HQ",
                        "actual": "-10286.42689"
                    },
                    {
                        "postcode": "IG1 2EN",
                        "actual": "-10135.09837"
                    },
                    {
                        "postcode": "SM1 2GB",
                        "actual": "-10001.50625"
                    }
                ]
            },
            "DatasetValue": {
                "min": -10575.85103,
                "actual": 36805.51279,
                "max": 3832517.418
            }
        }
    ]
}