Regions Top Level - Implan-Group/api GitHub Wiki

Regions - Top Level


GET /api/v1/region/{aggregationSchemeId}/{datasetId}

This endpoint returns all of the top-level (largest grouping geographically) Regions that are available for a given Aggregation Schemes and Datasets.

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Scheme to filter by.
datasetId route int The Dataset to filter by.

🧾Example

📤 Request

GET /api/v1/region/1/119

📥 Response

{
    "hashId": "WNaovyKGxO",
    "urid": 1797380,
    "userModelId": null,
    "description": "United States (US Totals)",
    "modelId": null,
    "modelBuildStatus": "NotBuilt",
    "employment": 201969200.00000012,
    "output": 37279974775902.9,
    "valueAdded": 21539982000000.0,
    "aggregationSchemeId": 1,
    "datasetId": 119,
    "datasetDescription": "2019",
    "fipsCode": "00000",
    "provinceCode": null,
    "m49Code": "840",
    "regionType": "Country",
    "hasAccessibleChildren": false,
    "regionTypeDescription": "Country",
    "geoId": "840",
    "isMrioAllowed": false
}
⚠️ **GitHub.com Fallback** ⚠️