{
"$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/_shared/indieningsvereistenresponse",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"compleet": {
"description": "Zowel de uitvoeringsregels (vragen en bijlage) die zijn vereist als niet zijn vereist voor het indienen zijn beantwoord.",
"type": "boolean"
},
"functioneleStructuurRef": {
"description": "De verwijzing naar de opgevraagde regelbeheerobjecten van de activiteit uit de request waarop het response van toepassing is",
"type": "string"
},
"indienbaar": {
"description": "Aan de indieningsvereisten is voldaan, alle uitvoeringsregels (vragen en bijlage) om te kunnen indienen zijn beantwoord.",
"type": "boolean"
},
"subactiviteiten": {
"description": "Subactiviteiten indien de activititeit verfijnbaar is. Als de activiteit niet verfijnbaar is, is er één subactiviteit die gelijk is aan de bovenliggende activiteit. De volgorde waarin de subactiviteiten geretourneerd worden blijft hetzelfde over meerdere requests heen. Note: aangezien verfijnbaar deprecated is zal deze lijst dus altijd maximaal één subactiviteit bevatten",
"items": {
"allOf": [
{
"properties": {
"bestuursorgaan": {
"allOf": [
{
"description": "Bestuursorgaan van de activiteit"
},
{
"description": "Organisatie",
"properties": {
"bestuurslaag": {
"description": "Bestuurslaag van een Organisatie",
"enum": [
"rijk",
"provincie",
"waterschap",
"gemeente"
],
"type": "string"
},
"oin": {
"description": "OIN van de organisatie",
"maxLength": 20,
"minLength": 20,
"type": "string"
}
},
"required": [
"oin",
"bestuurslaag"
]
}
]
},
"functioneleStructuurRef": {
"description": "Verwijzing naar het regelbeheerobject van de subactiviteit. Indien er voor deze subactiviteit geen regelbeheerobject bestaat is dit veld afwezig.",
"type": "string"
},
"ontbrekendeData": {
"allOf": [
{
"enum": [
"toepasbareRegels",
"regelbeheerobject"
],
"type": "string"
},
{
"description": "Definieert welke data ontbreekt:\n- toepasbareRegels: voor de betreffende activiteit of\n onderliggende subactiviteiten zijn geen toepasbare regels\n beschikbaar of zijn niet volledig.\n- regelbeheerobject: voor de betreffende activiteit of\n onderliggende subactiviteiten is geen regelbeheerobject\n beschikbaar of zijn niet volledig. N.B. in dit geval zijn de\n velden functioneleStructuurRef en typering niet gevuld.\n\nIn de situatie dat er data ontbreekt zullen er geen vraaggroepen en toepasbareRegelsIdentifiers in de response terugkomen."
}
],
"type": "string"
},
"subactiviteitNaam": {
"description": "De naam van de activiteit",
"type": "string"
},
"toepasbareRegelsIdentifiers": {
"description": "De identifiers van alle toepasbare regels bestanden die zijn uitgevoerd voor dit request. Dit kan gebruikt worden door afnemers om te detecteren of de onderliggende toepasbare regel bestanden zijn gewijzigd ten opzichte van een voorgaand request.",
"items": {
"type": "integer"
},
"type": "array"
},
"typering": {
"description": "Typering van de activiteit",
"enum": [
"Water",
"Milieubelastende",
"Overige"
],
"type": "string"
},
"vraaggroepen": {
"description": "Groep van vragen gesorteerd op prioriteit. De volgorde waarin de vraaggroepen geretourneerd worden blijft hetzelfde over meerdere requests heen.",
"items": {
"properties": {
"groepNaam": {
"description": "Tekst veld dat wordt gebruikt om de naam of het etiket van de groep te presenteren",
"type": "string"
},
"prioriteit": {
"description": "Prioriteit van de groep",
"type": "number"
},
"vragen": {
"description": "Lijst van de nog te beantwoorden vragen en al beantwoorden vragen binnen dezelfde groep, gesorteerd op prioriteit. De volgorde waarin de vragen geretourneerd worden blijft hetzelfde over meerdere requests heen.",
"items": {
"properties": {
"antwoordType": {
"description": "Het verwachtte antwoord type",
"enum": [
"boolean",
"numeriek",
"lijstwaarde",
"datum",
"string"
],
"type": "string"
},
"bereik": {
"description": "Geeft aan binnen welk bereik de via deze Uitvoeringsregel verkregen informatie kan worden gebruikt. Mogelijke waardes zijn 'werkzaamheid', 'locatie', 'gebruiker'.",
"enum": [
"werkzaamheid",
"locatie",
"gebruiker"
],
"type": "string"
},
"classificatie": {
"description": "Classificatie van de uitvoeringsregel waarmee deze zijn in te delen in de user interface.",
"enum": [
"project",
"aanvrager",
"verzoek",
"activiteit"
],
"type": "string"
},
"gewijzigdAntwoord": {
"description": "Het door de gebruiker opgegeven en gebruikte antwoord op de uitvoeringsregel die het vooringevuldAntwoord overruled.",
"type": "string"
},
"herbruikbareBeslissingFunctioneleStructuurRefs": {
"description": "Als de uitvoeringsregel van het type uitkomstHerbruikbareBeslissing is bevat dit veld de functioneleStructuurRefs van de activiteiten of werkzaamheden die de het antwoord levert voor deze vraag. Dit geeft inzicht in voor welke andere activiteiten of werkzaamheden nog vragen beantwoord moeten worden voordat de huidige activiteit tot een conclusie kan komen.",
"items": {
"description": "FunctioneleStructuurRef van de werkzaamheid of activiteit.",
"type": "string"
},
"type": "array"
},
"id": {
"description": "De unieke identifier van de vraag",
"type": "integer"
},
"invoertype": {
"description": "De presentatie van een invoerveld voor een vraag.",
"enum": [
"tekst",
"tekstveld"
],
"type": "string"
},
"invulinstructie": {
"description": "De invulinstructie van een vraag voor de gebruiker.",
"type": "string"
},
"locatieIdentificatie": {
"description": "De identificatie van de locatie. Deze is alleen gevuld voor uitvoeringsregelType geoVerwijzing",
"type": "string"
},
"optieType": {
"description": "Mogelijke waardes 'enkelAntwoord' of 'meerdereAntwoorden', wordt alleen gebruikt bij het antwoordType lijstwaarde",
"enum": [
"enkelAntwoord",
"meerdereAntwoorden"
],
"type": "string"
},
"opties": {
"description": "Een lijst met (antwoord) Opties voor de meerkeuzevragen van het antwoordType 'lijstwaarde'",
"items": {
"properties": {
"optieGeenVanBovenstaande": {
"description": "Kenmerk optieGeenVanBovenstaande=true betekent dat dit de optie \"geen van bovenstaande\" is en kan worden geselecteerd in plaats van de andere (antwoord) opties. Dit geldt voor meerkeuzevragen van het antwoordType 'lijstwaarde' met optieType 'meerdereAntwoorden'. Er is maximaal 1 optie met optieGeenVanBovenstaande=true.",
"type": "boolean"
},
"optieTekst": {
"description": "De tekst die de antwoord-optie omschrijft.",
"type": "string"
},
"sequenceId": {
"description": "Numeriek veld dat wordt gebruikt voor de presentatievolgorde van de Opties.",
"type": "integer"
},
"toelichting": {
"description": "Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service",
"properties": {
"belangrijk": {
"description": "Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.",
"type": "boolean"
},
"korteToelichtingId": {
"description": "identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
},
"langeToelichtingId": {
"description": "identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
}
},
"required": [
"belangrijk"
]
}
},
"required": [
"optieTekst",
"sequenceId",
"optieGeenVanBovenstaande"
]
},
"type": "array"
},
"potentieelVertrouwelijk": {
"description": "Kenmerk potentieelVertrouwelijk=true betekent dat een gebruiker kan aangeven dat een antwoord op een vraag vertrouwelijk is. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
"type": "boolean"
},
"prioriteit": {
"description": "Prioriteit van de vraag",
"type": "number"
},
"publiceerbaar": {
"description": "Kenmerk publiceerbaar=true betekent dat het antwoord op de vraag gepubliceerd mag worden. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
"type": "boolean"
},
"reguliereExpressie": {
"description": "Een reguliere expressie waarmee het antwoord kan worden gevalideerd.",
"type": "string"
},
"tekst": {
"description": "De tekst behorende bij deze vraag",
"type": "string"
},
"toelichting": {
"description": "Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service",
"properties": {
"belangrijk": {
"description": "Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.",
"type": "boolean"
},
"korteToelichtingId": {
"description": "identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
},
"langeToelichtingId": {
"description": "identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
}
},
"required": [
"belangrijk"
]
},
"uitvoeringsregelType": {
"description": "Type uitvoeringsregel. Deze staan beschreven in het bijbehorende Informatiemodel toepasbare regels (IMTR) van de Standaard toepasbare regels (STTR). Vragen van het type registerbevraging of geoVerwijzing kunnen een vooringevuld antwoord bevatten wat door de gebruiker gewijzigd mag worden. Vragen van het type uitkomstHerbruikbareBeslissing hoeven niet aan de gebruiker getoond te worden, en de bijbehorende vooringevulde antwoorden kunnen niet gewijzigd worden.",
"enum": [
"vraag",
"registerbevraging",
"geoVerwijzing",
"uitkomstHerbruikbareBeslissing"
],
"type": "string"
},
"verborgenStuurvraag": {
"description": "Een stuurvraag is een vraag die op basis van een (uit een registratie) bekend feit bepaalt welke verdere feiten nodig zijn om tot een beslissing te komen. Kenmerk verborgenStuurvraag=true betekent dat de stuurvraag niet aan een gebruiker getoond hoeft te worden. Als vooringevuldAntwoord leeg is, dient de vraag alsnog aan de gebruiker getoond te worden, ongeacht de waarde van verborgenStuurvraag",
"type": "boolean"
},
"verplicht": {
"description": "Kenmerk verplicht=true betekent dat een gebruiker een antwoord moet geven.",
"type": "boolean"
},
"vooringevuldAntwoord": {
"description": "Door de service vooringevuld antwoord in situaties waar het\nantwoord al bekend is (Bijvoorbeeld door middel van een register\nbevraging zoals de 'Basisregistratie Adressen en Gebouwen'). Indien\nmeerdere antwoorden bij een lijstwaarde dan komma gescheiden met spaties.\nDe mogelijke waardes zijn afhankelijk van het uitvoeringsregelType:\n* geoVerwijzing: Mogelijke waardes zijn 'ja', 'nee' en 'deels'.\n* uitkomstHerbruikbareBeslissing: Mogelijke waardes zijn 'ja',\n 'nee' en 'nietBeschikbaar'.\n* registerbevraging: Mogelijke waardes zijn niet beperkt tot een lijst.\n* vraag: Maakt geen gebruik van vooringevuldAntwoord.\n",
"type": "string"
},
"vraagReferentie": {
"description": "Identificatie van een gegeven om door te geven met de aanvraag. De structuur hiervan is <namespace>:<referentie>, waarbij de namespace \"imam\" gebruikt wordt voor de gegevens uit de IMAM (Informatie Model Aanvragen en Meldingen) standaard.",
"type": "string"
}
},
"required": [
"id",
"uitvoeringsregelType",
"antwoordType",
"tekst",
"bereik",
"classificatie",
"verplicht",
"publiceerbaar",
"potentieelVertrouwelijk",
"verborgenStuurvraag",
"prioriteit"
]
},
"type": "array"
}
},
"required": [
"prioriteit"
]
},
"type": "array"
}
},
"required": [
"subactiviteitNaam",
"bestuursorgaan"
]
},
{
"properties": {
"bijlagen": {
"description": "De inhoud van de bijlage-uitvoeringsregel gesorteerd op prioriteit, zodat de juiste bijlage aan gebruiker gevraagd kan worden. De volgorde waarin de bijlagen geretourneerd worden blijft hetzelfde over meerdere requests heen.",
"items": {
"properties": {
"classificatie": {
"description": "Classificatie van de uitvoeringsregel waarmee deze zijn in te delen in de user interface.",
"enum": [
"project",
"aanvrager",
"verzoek",
"activiteit"
],
"type": "string"
},
"documenttypeGeneriek": {
"description": "Het generieke documenttype van de bijlage. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
"type": "string"
},
"id": {
"description": "De unieke identifier van de bijlage.",
"type": "integer"
},
"potentieelVertrouwelijk": {
"description": "Kenmerk potentieelVertrouwelijk=true betekent dat een gebruiker kan aangeven dat een antwoord op een vraag vertrouwelijk is. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
"type": "boolean"
},
"publiceerbaar": {
"description": "Kenmerk publiceerbaar=true betekent dat het antwoord op de vraag gepubliceerd mag worden. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
"type": "boolean"
},
"toelichting": {
"description": "Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service",
"properties": {
"belangrijk": {
"description": "Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.",
"type": "boolean"
},
"korteToelichtingId": {
"description": "identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
},
"langeToelichtingId": {
"description": "identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
"type": "integer"
}
},
"required": [
"belangrijk"
]
},
"type": {
"description": "Het bestandstype dat verwacht wordt.",
"type": "string"
},
"verplicht": {
"description": "Kenmerk verplicht=true betekent dat een gebruiker een bijlage moet toevoegen.",
"type": "boolean"
},
"vraagReferentie": {
"description": "Identificatie van een gegeven om door te geven met de aanvraag. De structuur hiervan is <namespace>:<referentie>, waarbij de namespace \"imam\" gebruikt wordt voor de gegevens uit de IMAM (Informatie Model Aanvragen en Meldingen) standaard.",
"type": "string"
}
},
"required": [
"id",
"type",
"documenttypeGeneriek",
"classificatie",
"verplicht",
"publiceerbaar",
"potentieelVertrouwelijk"
]
},
"type": "array"
}
}
}
]
},
"type": "array"
},
"verfijnbaar": {
"deprecated": true,
"description": "Is de activiteit verfijnbaar? (verfijnbaar-functionaliteit is deprecated)",
"type": "boolean"
}
},
"required": [
"functioneleStructuurRef",
"indienbaar",
"compleet",
"verfijnbaar"
],
"x-derived-from": [
"https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v2.json#/components/schemas/IndieningsvereistenResponse",
"https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v3.json#/components/schemas/IndieningsvereistenResponse"
]
}