Aedes-datastandaarden / vera-openapi

VERA REST OpenAPI-specificaties
MIT License
14 stars 5 forks source link

Verduidelijking gebruik WoningwaarderingCriteriumGroep en WoningwaarderingCriterium #50

Open benverhees opened 6 months ago

benverhees commented 6 months ago

Kunnen jullie het gebruik van WoningwaarderingCriteriumGroep en WoningwaarderingCriterium verduidelijken?

Een WoningwaarderingGroep heeft een criteriumGroep en woningwaarderingen van het type Woningwaardering. Een Woningwaardering heeft een criterium van het type WoningwaarderingCriterium, met de attributen

Een WoningwaarderingGroep heeft dan een criteriumGroep van het type WoningwaarderingCriteriumGroep, met de attributen

Het is mij niet geheel duidelijk wat ik bij code, naam, criteria[^1], bovenliggendeCriterium en omschrijving dien op te geven, en waarom een stelsel dient opgegeven te worden wanneer deze ook al op de criteriumGroep gespecificeerd worden. Zouden jullie dit met een voorbeeld kunnen verduidelijken? Bijvoorbeeld: een woningwaarderinggroep voor oppervlakte van vertrekken:

{
    "criteriumGroep": {
        "code": "?",
        "naam": "?",
        "criteria": "?",
        "stelsel": {
            "code": "ZEL",
            "naam": "Zelfstandige woonruimten"
        },
        "stelselgroep": {
            "code": "OVZ",
            "naam": "Oppervlakte van vertrekken"
        }
    },
    "punten": 134.0,
    "woningwaarderingen": [
        {
            "aantal": 6.33,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 21.54,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 22.66,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 14.71,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 17.63,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 32.95,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        },
        {
            "aantal": 18.58,
            "criterium": {
                "code": "?",
                "naam": "?",
                "bovenliggendeCriterium": "?",
                "meeteenheid": {
                    "code": "M2",
                    "naam": "Vierkante meter, m2"
                },
                "stelsel": {
                    "code": "ZEL",
                    "naam": "Zelfstandige woonruimten"
                },
            }
        }
    ]
}

[^1]: Het criteria attribuut staat wel in de documentatie maar mist in de OpenApi specificatie. Hiervoor is #51 aangemaakt.