Aggregation Scheme by Industry Set - Implan-Group/api GitHub Wiki

Aggregation Scheme by Industry Set

Returns a list of all the Aggregation Schemes that belong to a specified Industry Set.

Note

This endpoint also returns custom Aggregation Schemes.


GET /api/v1/aggregationschemes

This is the same as calling the below endpoint with industrySetId equal to the current default United States' Industry Set.


GET /api/v1/aggregationschemes?industrySetId={industrySetId}

Returns a list of all the Aggregation Schemes that belong to an Industry Set including customs.

Parameter Spec Type Details
industrySetId query int The Industry Set that the resulting Aggregation Scheme will belong to.

🧾Example

📤 Request

GET /api/v1/aggregationschemes?industrySetId=2

📥 Response>

[
	{
	    "id": 1,
	    "description": "536 Unaggregated",
	    "industrySetId": 2,
	    "householdSetIds": [ 1, 2 ],
	    "mapCode": "US",
	    "status": "Complete"
	},
]
⚠️ **GitHub.com Fallback** ⚠️