Build and Return Regions - Implan-Group/api GitHub Wiki

Regions - Build and Return

This endpoint provides a way to build and retrieve a list of Region Objects. Any Regions in the list that have not been built will be. A list of fully hydrated Region Objects will be returned.

POST /api/v1/region/build-and-return/{aggregationSchemeId}

Parameter Spec Type Details
aggregationSchemeId route guid The identifier of the Aggregation Scheme.
body body str A list of Regional Identifiers for all the Regions to build and retrieve.

🧾Example

📤 Request

POST /api/v1/region/build-and-return/1

[
    "p0aRdZl0VJ",
    1905981
]

📥 Response

[
  {
    "hashId": "wlx6e9WwVk",
    "urid": 1905008,
    "userModelId": null,
    "modelId": 17026,
    "description": "Marion County, OR",
    "modelBuildStatus": "Complete",
    "employment": 0.0,
    "output": 0.0,
    "valueAdded": 0.0,
    "isCustomized": false,
    "isCombined": false,
    "regionType": "County",
    "datasetId": 98,
    "datasetDescription": "2023",
    "parentRegionIds": [
      {
        "regionType": "Msa",
        "hashId": "W1aQlLzoxj",
        "urid": 1862706
      },
      {
        "regionType": "State",
        "hashId": "9pbP1nM0VN",
        "urid": 1863644
      }
    ],
    "isMrioAllowed": true,
    "isCustomizable": true,
    "isCombinable": true,
    "hasAccess": true,
    "hasAccessibleChildren": false,
    "regionTypeDescription": "County",
    "regionTypeSort": 3,
    "geoId": "41047",
    "congressionalSession": null
  },
]

© 2025 - IMPLAN

⚠️ **GitHub.com Fallback** ⚠️