Customize Industry - Implan-Group/api GitHub Wiki

Customize Industry


POST /api/v1/region/build/CustomizeIndustry/{aggregationSchemeId}

This endpoint initiates a new model build that incorporates user provided industry customizations. Only the industries being customized need to be provided in the request body customization array. All fields must be provided for each customization.

Parameter Spec Type Details
aggregationSchemeId route int The Aggregation Schemes to filter by.
Property Type Details
modelName str The name/description for the customized industry.
hashId query str❔ The HashId of the Region to filter by.
urid query int❔ The Urid of the Region to filter by.
userModelId query int❔ The UserModelId of the Region to filter by.
customizedIndustryData array An array of Industry Economic Data objects.

🧾Example

📤 Request

POST /api/v1/region/build/CustomizeIndustry/1

// ❗this is only a portion of example data
{    
    "modelName": "Customized Model Name",
    "urid": 2177236,
    "userModelId": null,
    "hashId": null,
    "customizedIndustryData": [
        {
            "output": 880065020.8526169,
            "employeeCompensation": 1290736.0910256733,
            "proprietorIncome": 242123266.86085218,
            "otherPropertyTypeIncome": 190558603.13303137,
            "taxOnProductionAndImports": 1927449.7258658477,
            "employment": 900,
            "industryId": 4638
        }
    ]
}

📥 Response

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