Route getFilter

Schema

The returned data has the following schema:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "oneOf": [
        {
            "$ref": "#/definitions/AllTypes"
        },
        {
            "$ref": "#/definitions/SingleType"
        }
    ],
    "definitions": {
        "AllTypes": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "decke": {
                    "$ref": "#/definitions/SingleType"
                },
                "trennwand": {
                    "$ref": "#/definitions/SingleType"
                },
                "steildach": {
                    "$ref": "#/definitions/SingleType"
                },
                "aussenwand": {
                    "$ref": "#/definitions/SingleType"
                },
                "twzweischalig": {
                    "$ref": "#/definitions/SingleType"
                },
                "flachdach": {
                    "$ref": "#/definitions/SingleType"
                }
            },
            "required": [],
            "title": "AllTypes"
        },
        "SingleType": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "beschwerungtragschicht": {
                    "$ref": "#/definitions/BoolFilterData"
                },
                "nutzschicht": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "trittschall": {
                    "$ref": "#/definitions/MinMaxFilterData"
                },
                "beschwerungkonstruktion": {
                    "$ref": "#/definitions/BoolFilterData"
                },
                "bekleidung": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "estrich": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "daemmungbekleidung": {
                    "$ref": "#/definitions/BoolFilterData"
                },
                "bauteiltyp": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "daemmungkonstruktion": {
                    "$ref": "#/definitions/BoolFilterData"
                },
                "dicke": {
                    "$ref": "#/definitions/MinMaxFilterData"
                },
                "luftschall": {
                    "$ref": "#/definitions/MinMaxFilterData"
                },
                "hersteller": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "bauteilevon": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "beplankung": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "lueftung": {
                    "$ref": "#/definitions/StringFilterData"
                },
                "wandbekleidung": {
                    "$ref": "#/definitions/StringFilterData"
                }
            },
            "required": [],
            "title": "SingleType"
        },
        "BoolFilterData": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "label": {
                    "type": "string"
                },
                "values": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "label": {
                                "type": "string"
                            },
                            "key": {
                                "type": "boolean"
                            }
                        },
                        "required": [
                            "label",
                            "key"
                        ]
                    }
                }
            },
            "required": [
                "label",
                "values"
            ],
            "title": "BoolFilterData"
        },
        "StringFilterData": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "label": {
                    "type": "string"
                },
                "values": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "label": {
                                "type": "string"
                            },
                            "key": {
                                "type": "string"
                            }
                        },
                        "required": [
                            "label",
                            "key"
                        ]
                    }
                }
            },
            "required": [
                "label",
                "values"
            ],
            "title": "StringFilterData"
        },
        "MinMaxFilterData": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "anpassung": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "type": "string"
                    }
                },
                "label": {
                    "type": "string"
                },
                "values": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "min": {
                            "type": "number"
                        },
                        "max": {
                            "type": "number"
                        }
                    },
                    "required": [
                        "max",
                        "min"
                    ]
                }
            },
            "required": [
                "label",
                "values"
            ],
            "title": "MinMaxFilterData"
        }
    }
}

Examples

Query All Filter for a Single Type

This request returns all the meaningful filters (property names of the returned object) and their localized names (property label) for the type decke. The possible values are returned as a JSON Array of labeled keys or an JSON Object for filters defining a range from min (inclusive) up to max (inclusive).

Request
https://lignumdata.ch/api/v1.cfc?method=getFilter&type=decke
Response
{
    "beschwerungtragschicht": {
        "label": "Damping on the supporting structure",
        "values": [
            {
                "label": "Without dampening on the supporting structure",
                "key": false
            },
            {
                "label": "With dampening on the supporting structure",
                "key": true
            }
        ]
    },
    "trittschall": {
        "anpassung": [
            "ci50_2500",
            "ci"
        ],
        "label": "Weighted normalized Impact sound pressure level - Ln,w",
        "values": {
            "min": 0.0,
            "max": 100.0
        }
    },
    "beschwerungkonstruktion": {
        "label": "Damping in the construction",
        "values": [
            {
                "label": "without dampening in the supporting structure",
                "key": false
            },
            {
                "label": "with dampening in supporting structure",
                "key": true
            }
        ]
    },
    "bekleidung": {
        "label": "Ceiling linings",
        "values": [
            {
                "label": "Without covering",
                "key": "Ohne Bekleidung"
            },
            {
                "label": "Substructure rigid screwed",
                "key": "Unterkonstruktion steif befestigt"
            },
            {
                "label": "Substructure with rubber-mounted hangers",
                "key": "Unterkonstruktion entkoppelt"
            },
            {
                "...": "..."
            }
        ]
    },
    "estrich": {
        "label": "Screed",
        "values": [
            {
                "label": "with cement screed",
                "key": "mit Zementestrich"
            },
            {
                "label": "with anhydrite screed",
                "key": "mit Anhydritfliessestrich"
            },
            {
                "label": "with dry screed",
                "key": "mit Trockenestrich"
            },
            {
                "...": "..."
            }
        ]
    },
    "bauteiltyp": {
        "label": "Supporting structure",
        "values": [
            {
                "label": "Beam",
                "key": "Balken"
            },
            {
                "label": "Ribs",
                "key": "Rippen"
            },
            {
                "label": "Ribs / joists",
                "key": "Rippen / Balken"
            },
            {
                "...": "..."
            }
        ]
    },
    "daemmungkonstruktion": {
        "label": "Cavity insulation between the support structure",
        "values": [
            {
                "label": "without cavity insulation in the supporting structure",
                "key": false
            },
            {
                "label": "with cavity insulation in the supporting structure",
                "key": true
            }
        ]
    },
    "dicke": {
        "label": "Ceiling thickness",
        "values": {
            "min": 100.0,
            "max": 900.0
        }
    },
    "luftschall": {
        "anpassung": [
            "c",
            "c50_3150"
        ],
        "label": "Weighted sound reduction index - Rw",
        "values": {
            "min": 0.0,
            "max": 100.0
        }
    },
    "hersteller": {
        "label": "Products with manufacturers",
        "values": [
            {
                "label": "Generisches Produkt",
                "key": "Generisches Produkt"
            },
            {
                "label": "Isover",
                "key": "Isover"
            },
            {
                "label": "Sager",
                "key": "Sager"
            },
            {
                "label": "Swisspor",
                "key": "Swisspor"
            },
            {
                "...": "..."
            }
        ]
    },
    "bauteilevon": {
        "label": "Source of component information",
        "values": [
            {
                "label": "Lignum",
                "key": "Lignum"
            },
            {
                "label": "Lignatur",
                "key": "Lignatur"
            },
            {
                "...": "..."
            }
        ]
    }
}

Query a Single Filter using the all Type

This request returns all possible values of a filter under the different types.

The response states that only the types decke and flachdach can be filtered by trittschall but all types can be filtered by dicke.

Request
https://lignumdata.ch/api/v1.cfc?method=getFilter&type=all&filterName=trittschall
Response
{
    "decke": {
        "trittschall": {
            "anpassung": [
                "ci50_2500",
                "ci"
            ],
            "label": "Weighted normalized Impact sound pressure level - Ln,w",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        }
    },
    "flachdach": {
        "trittschall": {
            "anpassung": [
                "ci50_2500",
                "ci"
            ],
            "label": "Weighted normalized Impact sound pressure level - Ln,w",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        }
    }
}
Request
https://lignumdata.ch/api/v1.cfc?method=getFilter&type=all&filterName=dicke
Response
{
    "decke": {
        "dicke": {
            "label": "Ceiling thickness",
            "values": {
                "min": 100.0,
                "max": 900.0
            }
        }
    },
    "trennwand": {
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 50.0,
                "max": 500.0
            }
        }
    },
    "steildach": {
        "dicke": {
            "label": "Ceiling thickness",
            "values": {
                "min": 300.0,
                "max": 800.0
            }
        }
    },
    "aussenwand": {
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 100.0,
                "max": 600.0
            }
        }
    },
    "twzweischalig": {
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 150.0,
                "max": 700.0
            }
        }
    },
    "flachdach": {
        "dicke": {
            "label": "Ceiling thickness",
            "values": {
                "min": 100.0,
                "max": 1000.0
            }
        }
    }
}

Query All Filter with a condition

This request returns all possible values of a filter respecting the condition provided.

Request
https://lignumdata.ch/api/v1.cfc?method=getFilter&type=all&condition={"hersteller":"Rigips"}
Response
{
    "decke": {
        "beschwerungtragschicht": {
            "label": "Damping on the supporting structure",
            "values": [
                {
                    "label": "Without dampening on the supporting structure",
                    "key": false
                },
                {
                    "label": "With dampening on the supporting structure",
                    "key": true
                }
            ]
        },
        "trittschall": {
            "anpassung": [
                "ci50_2500",
                "ci"
            ],
            "label": "Weighted normalized Impact sound pressure level - Ln,w",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "beschwerungkonstruktion": {
            "label": "Damping in the construction",
            "values": [
                {
                    "label": "without dampening in the supporting structure",
                    "key": false
                },
                {
                    "label": "with dampening in supporting structure",
                    "key": true
                }
            ]
        },
        "bekleidung": {
            "label": "Ceiling linings",
            "values": [
                {
                    "label": "Without covering",
                    "key": "Ohne Bekleidung"
                },
                {
                    "label": "Substructure rigid screwed",
                    "key": "Unterkonstruktion steif befestigt"
                },
                {
                    "...": "..."
                }
            ]
        },
        "estrich": {
            "label": "Screed",
            "values": [
                {
                    "label": "with dry screed",
                    "key": "mit Trockenestrich"
                },
                {
                    "label": "with cement screed",
                    "key": "mit Zementestrich"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteiltyp": {
            "label": "Supporting structure",
            "values": [
                {
                    "label": "Ribs / joists",
                    "key": "Rippen / Balken"
                },
                {
                    "label": "Hollow box element",
                    "key": "Hohlkasten"
                },
                {
                    "...": "..."
                }
            ]
        },
        "daemmungkonstruktion": {
            "label": "Cavity insulation between the support structure",
            "values": [
                {
                    "label": "without cavity insulation in the supporting structure",
                    "key": false
                },
                {
                    "label": "with cavity insulation in the supporting structure",
                    "key": true
                }
            ]
        },
        "dicke": {
            "label": "Ceiling thickness",
            "values": {
                "min": 100.0,
                "max": 900.0
            }
        },
        "luftschall": {
            "anpassung": [
                "c",
                "c50_3150"
            ],
            "label": "Weighted sound reduction index - Rw",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "hersteller": {
            "label": "Products with manufacturers",
            "values": [
                {
                    "label": "Fermacell",
                    "key": "Fermacell"
                },
                {
                    "label": "Rigips",
                    "key": "Rigips"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteilevon": {
            "label": "Source of component information",
            "values": [
                {
                    "label": "Lignum",
                    "key": "Lignum"
                },
                {
                    "label": "Lignatur",
                    "key": "Lignatur"
                },
                {
                    "...": "..."
                }
            ]
        }
    },
    "trennwand": {
        "daemmungbekleidung": {
            "label": "Cavity insulation in cover",
            "values": [
                {
                    "label": " with cavity insulation",
                    "key": true
                }
            ]
        },
        "bauteiltyp": {
            "label": "Supporting structure",
            "values": [
                {
                    "label": "Stud",
                    "key": "Ständer"
                },
                {
                    "label": "Metal stud",
                    "key": "Metallständer"
                },
                {
                    "...": "..."
                }
            ]
        },
        "daemmungkonstruktion": {
            "label": "Cavity insulation between the support structure",
            "values": [
                {
                    "label": "with cavity insulation in the supporting structure",
                    "key": true
                },
                {
                    "label": "without cavity insulation in the supporting structure",
                    "key": false
                }
            ]
        },
        "wandbekleidung": {
            "label": "Wallcovering",
            "values": [
                {
                    "label": "Without substructure, directly sheathed",
                    "key": "Ohne Unterkonstruktion, direkt montiert"
                },
                {
                    "label": "Without covering",
                    "key": "Ohne Bekleidung"
                },
                {
                    "...": "..."
                }
            ]
        },
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 50.0,
                "max": 500.0
            }
        },
        "luftschall": {
            "anpassung": [
                "c"
            ],
            "label": "Weighted sound reduction index - Rw",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "hersteller": {
            "label": "Products with manufacturers",
            "values": [
                {
                    "label": "Fermacell",
                    "key": "Fermacell"
                },
                {
                    "label": "Rigips",
                    "key": "Rigips"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteilevon": {
            "label": "Source of component information",
            "values": [
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "label": "Homatherm GmbH",
                    "key": "Homatherm GmbH"
                },
                {
                    "...": "..."
                }
            ]
        },
        "beplankung": {
            "label": "Sheathing",
            "values": [
                {
                    "label": "Sheathed on one side",
                    "key": "Beplankung einseitig"
                },
                {
                    "label": "Sheathed on both sides",
                    "key": "Beplankung beidseitig"
                },
                {
                    "...": "..."
                }
            ]
        }
    },
    "steildach": {
        "bekleidung": {
            "label": "Ceiling linings",
            "values": [
                {
                    "label": "Simple covering",
                    "key": "Einfache Bekleidung"
                },
                {
                    "label": "Double covering",
                    "key": "Doppelte Bekleidung"
                },
                {
                    "...": "..."
                }
            ]
        },
        "daemmungbekleidung": {
            "label": "Cavity insulation in cover",
            "values": [
                {
                    "label": "without insulation on top of the sub-floor",
                    "key": false
                },
                {
                    "label": "with insulation on top of the sub-floor",
                    "key": true
                }
            ]
        },
        "bauteiltyp": {
            "label": "Supporting structure",
            "values": [
                {
                    "label": "Ribs / rafters",
                    "key": "Rippen / Sparren"
                },
                {
                    "label": "Solid wood panel",
                    "key": "Massivholz"
                }
            ]
        },
        "daemmungkonstruktion": {
            "label": "Cavity insulation between the support structure",
            "values": [
                {
                    "label": "with cavity insulation in the supporting structure",
                    "key": true
                },
                {
                    "label": "without cavity insulation in the supporting structure",
                    "key": false
                }
            ]
        },
        "dicke": {
            "label": "Ceiling thickness",
            "values": {
                "min": 300.0,
                "max": 800.0
            }
        },
        "luftschall": {
            "anpassung": [
                "ctr",
                "c"
            ],
            "label": "Weighted sound reduction index - Rw",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "hersteller": {
            "label": "Products with manufacturers",
            "values": [
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "label": "Rigips",
                    "key": "Rigips"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteilevon": {
            "label": "Source of component information",
            "values": [
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "label": "STEICO",
                    "key": "STEICO"
                },
                {
                    "...": "..."
                }
            ]
        },
        "beplankung": {
            "label": "Sheathing",
            "values": [
                {
                    "label": "without sheathing",
                    "key": "Ohne Beplankung"
                },
                {
                    "label": "Sheathed on one side",
                    "key": "Beplankung einseitig"
                },
                {
                    "...": "..."
                }
            ]
        }
    },
    "aussenwand": {
        "bekleidung": {
            "label": "Ceiling linings",
            "values": [
                {
                    "label": "Without covering",
                    "key": "Ohne Bekleidung"
                },
                {
                    "label": "Without substructure, directly sheathed",
                    "key": "Ohne Unterkonstruktion, direkt montiert"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteiltyp": {
            "label": "Supporting structure",
            "values": [
                {
                    "label": "Stud",
                    "key": "Ständer"
                },
                {
                    "label": "Solid wood panel",
                    "key": "Massivholz"
                }
            ]
        },
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 100.0,
                "max": 600.0
            }
        },
        "luftschall": {
            "anpassung": [
                "ctr",
                "c"
            ],
            "label": "Weighted sound reduction index - Rw",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "hersteller": {
            "label": "Products with manufacturers",
            "values": [
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "label": "Rigips",
                    "key": "Rigips"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteilevon": {
            "label": "Source of component information",
            "values": [
                {
                    "label": "GUTEX",
                    "key": "GUTEX"
                },
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "...": "..."
                }
            ]
        },
        "beplankung": {
            "label": "Sheathing",
            "values": [
                {
                    "label": "Sheathed on both sides",
                    "key": "Beplankung beidseitig"
                },
                {
                    "label": "Sheathed on one side",
                    "key": "Beplankung einseitig"
                },
                {
                    "...": "..."
                }
            ]
        },
        "lueftung": {
            "label": "Facade type",
            "values": [
                {
                    "label": "Ventilated facade",
                    "key": "Hinterlüftete Fassade"
                },
                {
                    "label": "Compact facade",
                    "key": "Kompaktfassade"
                },
                {
                    "...": "..."
                }
            ]
        }
    },
    "twzweischalig": {
        "bauteiltyp": {
            "label": "Supporting structure",
            "values": [
                {
                    "label": "Stud",
                    "key": "Ständer"
                },
                {
                    "label": "Metal stud",
                    "key": "Metallständer"
                },
                {
                    "...": "..."
                }
            ]
        },
        "daemmungkonstruktion": {
            "label": "Cavity insulation between the support structure",
            "values": [
                {
                    "label": "with cavity insulation in the supporting structure",
                    "key": true
                },
                {
                    "label": "without cavity insulation in the supporting structure",
                    "key": false
                }
            ]
        },
        "dicke": {
            "label": "Wall thickness",
            "values": {
                "min": 150.0,
                "max": 700.0
            }
        },
        "luftschall": {
            "anpassung": [
                "c"
            ],
            "label": "Weighted sound reduction index - Rw",
            "values": {
                "min": 0.0,
                "max": 100.0
            }
        },
        "hersteller": {
            "label": "Products with manufacturers",
            "values": [
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "label": "Rigips",
                    "key": "Rigips"
                },
                {
                    "...": "..."
                }
            ]
        },
        "bauteilevon": {
            "label": "Source of component information",
            "values": [
                {
                    "label": "GUTEX",
                    "key": "GUTEX"
                },
                {
                    "label": "Knauf",
                    "key": "Knauf"
                },
                {
                    "...": "..."
                }
            ]
        },
        "beplankung": {
            "label": "Sheathing",
            "values": [
                {
                    "label": "Sheathed on both sides",
                    "key": "Beplankung beidseitig"
                },
                {
                    "label": "Sheathed on one side",
                    "key": "Beplankung einseitig"
                },
                {
                    "...": "..."
                }
            ]
        }
    }
}