Get Built Regions - Implan-Group/api GitHub Wiki

Get Built Regions


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

This endpoint returns a list of currently built models accessible to the user.

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/8/87/built

📥 Response

[
    {
        "hashId": "wlx680ZLbk",
        "urid": 1614296,
        "userModelId": null,
        "description": "32839 (FL)",
        "modelId": 147266,
        "modelBuildStatus": "Complete",
        "employment": 24436.78608021096,
        "output": 3711828857.980459,
        "valueAdded": 2332250603.174562,
        "aggregationSchemeId": 8,
        "datasetId": 87,
        "datasetDescription": "2021",
        "fipsCode": null,
        "provinceCode": null,
        "m49Code": null,
        "regionType": "Zipcode",
        "hasAccessibleChildren": true,
        "regionTypeDescription": "Zipcode",
        "geoId": null,
        "isMrioAllowed": true
    },
]
⚠️ **GitHub.com Fallback** ⚠️