{
"openapi": "3.1.0",
"info": {
"contact": {
"name": "Contact via vragenformulier",
"url": "https://developer.omgevingswet.overheid.nl/services/contact/"
},
"description": "API voor de DSO-samenwerkfunctionaliteit.",
"license": {
"name": "Copyright",
"url": "https://developer.omgevingswet.overheid.nl/site/copyright/"
},
"termsOfService": "https://developer.omgevingswet.overheid.nl/services/fair-use-policy/",
"title": "Samenwerken-API",
"version": "5.7.3"
},
"externalDocs": {
"description": "Api-register",
"url": "https://developer.omgevingswet.overheid.nl/ontwikkelaarsportaal/api-register/api/samenwerkfunctionaliteit/"
},
"servers": [ {
"url": "https://pkio.service.{{ www_hostname }}/overheid/samenwerken/api/behandelen/v5",
"description": "De REST API die de samenwerkfunctionaliteit (SWF) van het Digitaal stelsel Omgevingswet realiseert. De API is beschikbaar voor bevoegd gezagen en voor ketenpartners in de samenwerking, mits deze in het bezit zijn van een PKIO-certificaat."
}, {
"url": "https://service.{{ www_hostname }}/publiek/samenwerken/api/behandelen/v5",
"description": "De REST API die de samenwerkfunctionaliteit (SWF) van het Digitaal stelsel Omgevingswet realiseert. De API is beschikbaar voor bevoegd gezagen en voor ketenpartners in de samenwerking, mits deze in het bezit zijn van een PKIO-certificaat."
} ],
"paths": {
"/": {
"get": {
"deprecated": true,
"operationId": "getOASDeprecated",
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"type": "string",
"externalDocs": {
"url": "https://spec.openapis.org/oas/3.1/schema/2025-09-15"
}
}
}
},
"description": "Detailinformatie over de API.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Vraag Open Api Specificatie op.",
"tags": [ "Api" ],
"x-auth-type": "None"
}
},
"/actieverzoeken": {
"get": {
"operationId": "getActieverzoeken",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor actieverzoeken opgehaald moeten worden.",
"in": "query",
"name": "samenwerkingId",
"required": false,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "Status van het actieverzoek",
"in": "query",
"name": "status",
"required": false,
"schema": {
"type": "string",
"enum": [ "OPEN", "IN_BEHANDELING", "GEWEIGERD", "INGETROKKEN", "GEREEDGEMELD", "GEREED" ]
}
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op zender.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | zender=00000001821699180000 |
\n | != | [not] | zender[not]=00000001821699180000 |
\n \n
\nDoor het oin van de huidige gebruiker als filterwaarde te gebruiken (?zender=<oin huidige gebruiker>) kunnen alle uitgaande actieverzoeken opgehaald worden.\n",
"in": "query",
"name": "zender",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/NotStringParameter"
} ]
},
"style": "form"
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op ontvanger.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | ontvanger=00000001821699180000 |
\n | != | [not] | ontvanger[not]=00000001821699180000 |
\n \n
\nDoor het oin van de huidige gebruiker als filterwaarde te gebruiken (?ontvanger=<oin huidige gebruiker>) kunnen alle inkomende actieverzoeken opgehaald worden.\n",
"in": "query",
"name": "ontvanger",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/NotStringParameter"
} ]
},
"style": "form"
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op creatieDatumTijd.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | creatieDatumTijd=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | < | [lt] | creatieDatumTijd[lt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | > | [gt] | creatieDatumTijd[gt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | <= | [lte] | creatieDatumTijd[lte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | >= | [gte] | creatieDatumTijd[gte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | != | [not] | creatieDatumTijd[not]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n \n
\nOok een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle notificaties tussen 1 januari 2024 en 1 januari 2025 te selecteren:\nGET /actieverzoeken?creatieDatumTijd[gte]=2024-01-01T10%3A49%3A44.457%2B0200&creatieDatumTijd[lte]=2024-12-31T10%3A49%3A44.457%2B0200
\n",
"in": "query",
"name": "creatieDatumTijd",
"required": false,
"schema": {
"oneOf": [ {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
}, {
"$ref": "#/components/schemas/AllOtherDatumTijdParameters"
} ]
},
"style": "form"
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/ActieverzoekList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van actieverzoeken.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de actieverzoeken van de deelnemer op.",
"tags": [ "Actieverzoeken" ]
}
},
"/actieverzoeken/{actieverzoekId}": {
"get": {
"operationId": "getActieverzoek",
"parameters": [ {
"description": "De identificatie van het actieverzoek dat opgehaald moet worden.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Actieverzoek"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal het actieverzoek op.",
"tags": [ "Actieverzoeken" ]
},
"patch": {
"description": "Een actieverzoek kan op verschillende manieren gewijzigd worden:\n- De titel, productId, de omschrijving, de melding of een combinatie van deze velden kan gewijzigd worden.\n\n De zender mag de titel, productId en de omschrijving wijzigen. Zowel zender als ontvanger mogen de melding wijzigen.\n\n- De status kan gewijzigd worden. Hierbij kan optioneel een melding meegegeven worden.\n\n Zowel de zender als de ontvanger mogen de status wijzigen, afhankelijk van welke transitie uitgevoerd wordt; zie onder.\n\n\nMeerdere combinaties tegelijk wijzigen is niet toegestaan: het is bijvoorbeeld niet toegestaan zowel de titel als de status te wijzigen.\nBij het wijzigen van de status van het actieverzoek, zijn de volgende transities toegestaan:\n\n \n | Actor | \n Huidige status | \n Nieuwe status | \n Opm | \n \n \n | Zender | OPEN | INGETROKKEN | Eindstatus |
\n | Zender | IN_BEHANDELING | INGETROKKEN | Eindstatus |
\n | Zender | GEREEDGEMELD | IN_BEHANDELING |
\n | Zender | GEREEDGEMELD | GEREED | Eindstatus |
\n | Ontvanger | OPEN | GEWEIGERD | Eindstatus |
\n | Ontvanger | OPEN | IN_BEHANDELING |
\n | Ontvanger | IN_BEHANDELING | GEWEIGERD | Eindstatus |
\n | Ontvanger | IN_BEHANDELING | GEREEDGEMELD |
\n \n
\n\nAls een actieverzoek in een van de eindstatussen terechtkomt, kan deze niet meer gewijzigd worden.\n",
"operationId": "updateActieverzoek",
"parameters": [ {
"description": "De identificatie van het actieverzoek.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateActieverzoek"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Actieverzoek"
}
}
},
"description": "Actieverzoek gewijzigd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten of het actieverzoek bevindt zich in een eindstatus.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het wijzigen van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig het actieverzoek, op een van de verschillende mogelijkheden.\n",
"tags": [ "Actieverzoeken" ]
}
},
"/actieverzoeken/{actieverzoekId}/berichten": {
"get": {
"description": "Haal alle berichten geassocieerd met een actieverzoek op. Deze actie is alleen toegestaan voor deelnemers van de samenwerking waartoe het actieverzoek behoort.\n",
"operationId": "getBerichten",
"parameters": [ {
"description": "De identificatie het actieverzoek waarvoor de berichten opgehaald moeten worden.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/BerichtList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de berichten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal alle berichten bij een actieverzoek op.",
"tags": [ "Berichten" ]
},
"post": {
"description": " Via dit endpoint is het mogelijk een bericht te sturen binnen de context van een actieverzoek. Het versturen van een bericht mag alleen gedaan worden door de zender of ontvanger van het betreffende actieverzoek.
Wel is het zo dat alle deelnemers van de samenwerking de berichten vervolgens kunnen opvragen.
Berichten kunnen ook verstuurd worden als het actieverzoek ingetrokken of gereed is.
Wanneer een samenwerking gesloten is, kunnen geen berichten meer verstuurd worden.
Nadat een bericht verstuurd is, krijgt de ontvanger van een bericht hier een notificatie over.
\n",
"operationId": "createBericht",
"parameters": [ {
"description": "De identificatie het actieverzoek waarvoor het bericht aangemaakt moet worden.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBericht"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Bericht"
}
}
},
"description": "Bericht aangemaakt.",
"headers": {
"Location": {
"description": "De URI van het aangemaakte bericht.",
"schema": {
"type": "string",
"format": "uri"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Deze foutmelding kan een van de volgende oorzaken hebben:\n- De gebruiker is geen deelnemer van de samenwerking.\n- De gebruiker is geen zender en geen ontvanger van het actieverzoek.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het aanmaken van het bericht.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Maak een bericht aan.",
"tags": [ "Berichten" ]
}
},
"/actieverzoeken/{actieverzoekId}/berichten/{berichtId}": {
"delete": {
"description": " Via dit endpoint is het mogelijk een eerder verstuurd bericht te verwijderen. Het verwijderen van een bericht mag alleen gedaan worden door de zender van het betreffende bericht.
Berichten kunnen ook verwijderd worden als het actieverzoek ingetrokken of gereed is.
Wanneer een samenwerking gesloten is, kunnen geen berichten meer verwijderd worden.
\n",
"operationId": "deleteBericht",
"parameters": [ {
"description": "De identificatie het actieverzoek waarvoor het bericht verwijderd moet worden.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}, {
"in": "path",
"name": "berichtId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"204": {
"description": "Bericht verwijderd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Deze foutmelding kan een van de volgende oorzaken hebben:\n- De gebruiker is geen deelnemer van de samenwerking.\n- De gebruiker is geen zender van het bericht.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het bericht bestaat niet.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten, of het bericht bestaat niet binnen het opgegeven actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het verwijderen van het bericht.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijder een bericht",
"tags": [ "Berichten" ]
},
"get": {
"description": "Haal een bericht geassocieerd met een actieverzoek op. Deze actie is alleen toegestaan voor deelnemers van de samenwerking waartoe het actieverzoek behoort.\n",
"operationId": "getBericht",
"parameters": [ {
"description": "De identificatie het actieverzoek waarvoor het bericht opgehaald moet worden.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}, {
"description": "De identificatie het bericht dat opgehaald moet worden",
"in": "path",
"name": "berichtId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Bericht"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer) of het bericht bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het gevraagde bericht behoort niet tot het gegeven actieverzoek.
Zorg dat berichtId en actieverzoekId met elkaar overeenkomen.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het bericht.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een bericht op",
"tags": [ "Berichten" ]
}
},
"/actieverzoeken/{actieverzoekId}/documenten": {
"post": {
"description": "Koppel een document aan het actieverzoek. Documenten die al gekoppeld waren aan het actieverzoek blijven gekoppeld aan het actieverzoek. Het opgegeven document moet bestaan binnen de samenwerking en mag niet al gekoppeld zijn aan het actieverzoek.\n",
"operationId": "linkDocumentToActieverzoek",
"parameters": [ {
"description": "De identifier (UUID) van het actieverzoek waar het document aan gekoppeld wordt.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostActieverzoekDocument"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"description": "Het document is met succes aan het actieverzoek gekoppeld.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document hoort niet bij deze samenwerking of bestaat niet.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen zender of ontvanger van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek is niet meer wijzigbaar, of het document is al gekoppeld aan het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het koppelen van een document aan het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Koppel een document aan het actieverzoek.",
"tags": [ "Actieverzoeken" ]
},
"put": {
"description": "Overschrijf de lijst van gekoppelde documenten voor het actieverzoek. Alle opgegeven documenten moeten bestaan binnen de samenwerking.\n",
"operationId": "updateActieverzoekDocuments",
"parameters": [ {
"description": "Een lijst identifiers (UUID) van documenten die gekoppeld dienen te gaan worden met het actieverzoek.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateActieverzoekDocumenten"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"description": "De lijst met documenten die horen bij het actieverzoek is aangepast.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document hoort niet bij deze samenwerking of bestaat niet.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen zender of ontvanger van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het wijzigen van de gekoppelde documenten voor het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig de gekoppelde documenten bij het actieverzoek.",
"tags": [ "Actieverzoeken" ]
}
},
"/actieverzoeken/{actieverzoekId}/documenten/{documentId}": {
"delete": {
"description": "Ontkoppel een document van het actieverzoek. Andere gekoppelde documenten van het actieverzoek blijven gekoppeld aan het actieverzoek. Het opgegeven document moet bestaan binnen de samenwerking.\n",
"operationId": "unlinkDocumentFromActieverzoek",
"parameters": [ {
"description": "De identifier (UUID) van het actieverzoek waar het document van ontkoppeld wordt.",
"in": "path",
"name": "actieverzoekId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}, {
"description": "De identifier (UUID) van het document dat ontkoppeld wordt van het actieverzoek.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"204": {
"description": "Het document is met succes ontkoppeld van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen zender of ontvanger van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek bestaat niet, of het document is niet gekoppeld aan het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het actieverzoek is niet meer wijzigbaar. Het actieverzoek is gereed gemeld of de samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ontkoppelen van een document aan het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Ontkoppel een document van het actieverzoek.",
"tags": [ "Actieverzoeken" ]
}
},
"/app-health": {
"get": {
"operationId": "getAppHealth",
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/app-health"
}
}
},
"description": "Health-status over de API.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Vraag health-status over de API op.",
"tags": [ "Api" ],
"x-auth-type": "None"
}
},
"/app-info": {
"get": {
"operationId": "getAppInfo",
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/API"
}
}
},
"description": "Detailinformatie over de API.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Vraag metadata over de API op.",
"tags": [ "Api" ],
"x-auth-type": "None"
}
},
"/documenten/{documentId}": {
"delete": {
"operationId": "deleteDocument",
"parameters": [ {
"description": "De identificatie van het document dat verwijderd wordt.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"204": {
"description": "Document verwijderd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking, of heeft onvoldoende rechten op het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijder een document uit de samenwerking.",
"tags": [ "Documenten" ]
},
"get": {
"operationId": "getDocumentMetadata",
"parameters": [ {
"description": "De identificatie van het document.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Document"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de metadata van het document op.",
"tags": [ "Documenten" ]
},
"patch": {
"operationId": "patchDocumentMetadata",
"parameters": [ {
"description": "De identificatie van het document.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocument"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Document"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"415": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Niet toegestaan mediatype.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem bij het wijzigen van het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig de metadata van het document.",
"tags": [ "Documenten" ]
}
},
"/documenten/{documentId}/content": {
"get": {
"operationId": "getDocumentContent",
"parameters": [ {
"description": "De identificatie van het document.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"examples": { },
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "Succes.",
"headers": {
"Content-Length-File": {
"description": "Bevat de grootte van het document in bytes.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Download het document.",
"tags": [ "Documenten" ]
},
"put": {
"operationId": "replaceDocumentFile",
"parameters": [ {
"description": "De identificatie van het document.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"contentMediaType": "application/octet-stream",
"description": "Het document dat opgeslagen moet worden.\n\n - Het document mag maximaal 250MB groot zijn\n\n - Excel-bestanden mogen geen macro's bevatten.\n\n - De naam van het document:\n - mag niet langer zijn dan 256 tekens\n - moet een extensie hebben\n - mag niet beginnen of eindigen met een punt\n - mag geen aanhalingstekens bevatten\n - mag geen meerdere punten achter elkaar bevatten\n - moet minimaal één letter (a-z), cijfer (0-9) of een streepje (-) bevatten\n"
}
},
"required": [ "file" ]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"413": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document is te groot.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"415": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Niet toegestaan mediatype.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"422": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bevat een virus.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem bij het vervangen van het document",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig het document.",
"tags": [ "Documenten" ]
}
},
"/notificaties": {
"get": {
"operationId": "getAllNotificaties",
"parameters": [ {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de notificaties gefilterd worden op eventDatumTijd.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | eventDatumTijd=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | < | [lt] | eventDatumTijd[lt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | > | [gt] | eventDatumTijd[gt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | <= | [lte] | eventDatumTijd[lte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | >= | [gte] | eventDatumTijd[gte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | != | [not] | eventDatumTijd[not]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n \n
\nOok een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle notificaties tussen 1 januari 2024 en 1 januari 2025 te selecteren:\nGET /notificaties?eventDatumTijd[gte]=2024-01-01T10%3A49%3A44.457%2B0200&eventDatumTijd[lte]=2024-12-31T10%3A49%3A44.457%2B0200
\n",
"in": "query",
"name": "eventDatumTijd",
"required": false,
"schema": {
"oneOf": [ {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
}, {
"$ref": "#/components/schemas/AllOtherDatumTijdParameters"
} ]
},
"style": "form"
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op samenwerkVorm.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | samenwerkVorm=SAMENWERKEN_AAN_BEHANDELEN |
\n | != | [not] | samenwerkVorm[not]=SAMENWERKEN_AAN_TOEZICHT_EN_HANDHAVING |
\n \n
\n",
"in": "query",
"name": "samenwerkVorm",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/NotStringParameter"
} ]
},
"style": "form"
}, {
"description": "Deze query-parameter accepteert een lijst van velden waarop gesorteerd moet worden gescheiden door een komma. Door een minteken (“-”) voor de veldnaam te zetten, wordt het veld in aflopende volgorde gesorteerd.\nDe volgende velden worden ondersteund:\n- eventDatumTijd\n- samenwerkingId\n- eventInitiator\n\nEen aantal voorbeelden: _sort=eventDatumTijd\\n _sort=samenwerkingId,-eventDatumTijd\\n _sort=-eventInitiator,-samenwerkingId,eventDatumTijd\\n
Als geen sortering wordt opgegeven, worden de resultaten aflopend op eventDatumTijd gesorteerd.\n",
"example": "-samenwerkingId,-eventDatumTijd",
"in": "query",
"name": "_sort",
"required": false,
"schema": {
"type": "string",
"default": "-eventDatumTijd"
}
}, {
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"default": 1000,
"minimum": 1
}
}, {
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/NotificatieList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"description": "Totaal aantal pagina’s.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"description": "Aantal resultaten per pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Pagination-Page": {
"description": "Huidige pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Total-Count": {
"description": "Totaal aantal resultaten.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de notificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal alle notificaties van de deelnemer op.",
"tags": [ "Notificaties" ]
}
},
"/notificaties/{notificatieId}": {
"delete": {
"operationId": "deleteNotificatie",
"parameters": [ {
"description": "De identificatie van een notificatie.",
"in": "path",
"name": "notificatieId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"204": {
"description": "Notificatie verwijderd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De notificatie bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het verwijderen van de notificatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijder de notificatie.",
"tags": [ "Notificaties" ]
},
"get": {
"operationId": "getNotificatie",
"parameters": [ {
"description": "De identificatie van de notificatie die opgehaald moet worden.",
"in": "path",
"name": "notificatieId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Notificatie"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de ontvanger van de notificatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De notificatie bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de notificatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de notificatie op.",
"tags": [ "Notificaties" ]
}
},
"/openapi.json": {
"get": {
"operationId": "getOAS",
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"type": "string",
"externalDocs": {
"url": "https://spec.openapis.org/oas/3.1/schema/2025-09-15"
}
}
}
},
"description": "Detailinformatie over de API.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Vraag Open Api Specificatie op.",
"tags": [ "Api" ],
"x-auth-type": "None"
}
},
"/organisaties": {
"get": {
"description": "Via dit endpoint kan een lijst van organisaties opgehaald worden. De lijst kan gefilterd worden door een zoekterm op te geven (de _find-parameter). Zie de beschrijving van de _find-parameter over het gebruik ervan.\n",
"operationId": "getOrganisaties",
"parameters": [ {
"description": "Een optionele zoekterm. Hiermee wordt de lijst met resultaten gefilterd; alleen organisaties waarbij de zoekterm in de naam voorkomt (case-insensitive) worden teruggegeven.",
"in": "query",
"name": "_find",
"required": false,
"schema": {
"type": "string"
}
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op het moment waarop de organisatie voor het laatst is gezien.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | laatstGezien=2024-07-19T10%3A49%3A44.457%2B0200 |
\n | < | [lt] | laatstGezien[lt]=2024-07-19T10%3A49%3A44.457%2B0200 |
\n | > | [gt] | laatstGezien[gt]=2024-07-19T10%3A49%3A44.457%2B0200 |
\n | <= | [lte] | laatstGezien[lte]=2024-07-19T10%3A49%3A44.457%2B0200 |
\n | >= | [gte] | laatstGezien[gte]=2024-07-19T10%3A49%3A44.457%2B0200 |
\n | != | [not] | laatstGezien[not]=2024-07-19T10%3A49%3A44.457%2B0200 |
\n \n
\nDe not-operator is hier handig om alle organisaties te selecteren die ooit gebruik hebben gemaakt van de api: GET /organisaties?laatstGezien[not]=\"\"
\nOok een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle organisaties te selecteren die tussen 1 januari 2024 en 1 januari 2025 gebruik hebben gemaakt van de api:\nGET /organisaties?laatstGezien[gte]=2024-01-01T00%3A00%3A00.457%2B0200&laatstGezien[lte]=2024-12-31T23%3A59%3A59.457%2B0200
\n",
"in": "query",
"name": "laatstGezien",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/AllOtherParameters"
} ]
},
"style": "form"
}, {
"description": "Max aantal organisaties per pagina. Als de parameter niet meegegeven wordt zal de standaardwaarde 10 gebruikt worden.",
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"default": 10,
"minimum": 1
}
}, {
"description": "Deze parameter wordt gebruikt om de betreffende pagina op te halen. De geldige waarden zijn 1 en waarden hoger dan 1. Standaard zal de eerste pagina opgehaald worden.\n",
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": {
"Voorbeeld 200-response": {
"description": "Deze response wordt teruggegeven wanneer bij het opvragen van de organisaties gefilterd wordt op 'Gemeente Steenwijkerland'.",
"value": "{\"_embedded\": {\"organisaties\": [{\"id\": \"00000001809249066000\",\"naam\": \"Gemeente Steenwijkerland\",\"laatstGezien\": \"2024-09-05T14:00:31.121+02:00\",\"_links\": {\"self\": {\"href\": \"https://omgevingsloket:8444/samenwerken/api/organisaties/00000001809249066000\"}}}]},\"_links\": {\"self\": {\"href\": \"https://omgevingsloket:8444/samenwerken/api/organisaties?_find=Gemeente%20Steenwijkerland&pagina=1&aantal=10&_sort=naam\"}},\"page\": {\"size\": 10,\"totalElements\": 1,\"totalPages\": 1,\"number\": 1}}\n"
}
},
"schema": {
"$ref": "#/components/schemas/OrganisatieList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"description": "Totaal aantal pagina’s.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"description": "Aantal resultaten per pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Pagination-Page": {
"description": "Huidige pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Total-Count": {
"description": "Totaal aantal resultaten.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van organisaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een lijst van organisaties op die voldoen aan de opgegeven criteria.",
"tags": [ "Organisaties" ]
}
},
"/organisaties/{organisatieId}": {
"get": {
"operationId": "getOrganisatie",
"parameters": [ {
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": {
"Succesvol opvragen van een organisatie.": {
"description": "Hier is de organisatie 'Gemeente Rotterdam' opgevraagd",
"value": "{\"id\":\"00000001001876387000\",\"naam\":\"Gemeente Rotterdam\",\"laatstGezien\":\"2024-09-05T14:00:31.121+02:00\",\"_links\":{\"self\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/organisaties/00000001001876387000\"}}}\n"
}
},
"schema": {
"$ref": "#/components/schemas/Organisatie"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 404-response": {
"description": "Hier is een organisatie opgevraagd met een niet-bestaand oin.",
"value": "{\"title\":\"Er is geen organisatie gevonden.\",\"status\":404,\"detail\":\"Uitgevoerde operatie: get organisatie / geen details\",\"instance\":\"3c3499e378260fbb0c7cec618e5831bf\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is geen organisatie gevonden.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de organisatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de gegevens van de organisatie op.",
"tags": [ "Organisaties" ]
}
},
"/samenwerkingen": {
"get": {
"operationId": "getSamenwerkingen",
"parameters": [ {
"description": " Deze query-parameter accepteert een lijst van velden waarop gesorteerd moet worden, gescheiden door een komma. Door een minteken (“-”) voor de veldnaam te zetten, wordt het veld in aflopende volgorde gesorteerd. Dit kan per veldnaam.\nDe volgende velden worden ondersteund:\n- titel\n- creatieDatumTijd\n- laatstAangepastDatumTijd\n- status\n- samenwerkVorm\n\nEen aantal voorbeelden: _sort=titel\n _sort=status,-laatstAangepastDatumTijd\n _sort=-status,-titel,creatieDatumTijd\n
Als geen sortering wordt opgegeven, worden de resultaten aflopend gesorteerd op creatieDatumTijd. ",
"example": "-status,-titel",
"in": "query",
"name": "_sort",
"required": false,
"schema": {
"type": "string",
"default": "-creatieDatumTijd"
}
}, {
"description": "Max aantal elementen per pagina. Als de parameter niet meegegeven wordt zal de standaardwaarde 100 gebruikt worden.",
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"default": 100,
"minimum": 1
}
}, {
"description": "Deze parameter wordt gebruikt om de betreffende pagina op te halen. De geldige waarden zijn 1 en waarden hoger dan 1. Standaard zal de eerste pagina opgehaald worden.\n",
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/SamenwerkingenList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"description": "Totaal aantal pagina’s.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"description": "Aantal resultaten per pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Pagination-Page": {
"description": "Huidige pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Total-Count": {
"description": "Totaal aantal resultaten.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Not Found",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de samenwerkingen.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een overzicht van de samenwerkingen op.",
"tags": [ "Samenwerkingen" ]
},
"post": {
"description": "Maak een nieuwe samenwerking aan.\nAls er een samenwerking voor Toezicht en Handhaving aangemaakt wordt, dan geldt het volgende:\n- samenwerkDoel moet de waarde TOEZICHT_EN_HANDHAVING bevatten.\n- De velden verzoeknummer, oloVerzoeknummer en bronVerzoek moeten afwezig zijn.\n- De requestheader X-Stam-Versie moet afwezig zijn.\n- Samenwerkdoel TOEZICHT_EN_HANDHAVING mag vanwege wettelijke beperkingen naar verwachting pas vanaf 1 juli 2026 gebruikt worden.\nAls een samenwerking aangemaakt wordt met een verzoeknummer, dan wordt na het aanmaken voor elke ondersteunde stamversie de verzoekinhoud (verzoek.xml) geïmporteerd. Het importeren van de verzoekinhoud genereert geen notificaties of foutmeldingen, en wordt uitgevoerd ongeacht de waarde van de parameter 'importeerVerzoek'.\n\n - Samenwerkdoel TOEZICHT_EN_HANDHAVING mag vanwege wettelijke beperkingen naar verwachting pas vanaf 1 juli 2026 gebruikt worden.\n\n\nVerder geldt:\n- Als een samenwerking aangemaakt wordt met een verzoeknummer, dan wordt na het aanmaken voor elke ondersteunde stamversie de verzoekinhoud (verzoek.xml) geïmporteerd.\n- Het importeren van de verzoekinhoud genereert geen notificaties of foutmeldingen, en wordt uitgevoerd ongeacht de waarde van de parameter 'importeerVerzoek'.\n- Sinds 1 juli 2024 is het niet langer mogelijk samenwerkingen te starten op basis van een OLO-verzoek.\n",
"operationId": "createSamenwerking",
"parameters": [ {
"description": "Geeft optioneel aan of het DSO-verzoek direct tijdens het aanmaken van de samenwerking geïmporteerd moet worden. Dit is alleen van toepassing als het veld 'verzoeknummer' is ingevuld. Het importeren van een verzoek gebeurt wanneer het veld 'verzoeknummer' ingevuld is en de parameter 'importeerVerzoek' ontbreekt of de waarde 'true' heeft.\n",
"in": "query",
"name": "importeerVerzoek",
"required": false,
"schema": {
"type": "boolean"
}
}, {
"in": "header",
"name": "X-Stam-Versie",
"required": false,
"schema": {
"type": "string"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSamenwerking"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/hal+json": {
"examples": {
"De samenwerking is aangemaakt.": {
"description": "De samenwerking is met succes aangemaakt",
"value": "{\"samenwerkingId\":\"SAM-246\",\"verzoeknummer\":null,\"titel\":\"Samenwerking 0.4827400342016064\",\"aangemaaktDoorNaam\":\"Gemeente Steenwijkerland\",\"aangemaaktDoor\":\"00000001809249066000\",\"status\":\"OPEN\",\"samenwerkVorm\":\"SAMENWERKEN_AAN_BEHANDELEN\",\"creatieDatumTijd\":\"2024-08-15T14:53:21.843+0200\",\"eindDatumTijd\":\"2024-08-22T14:53:21.843+0200\",\"kenmerkSysteem\":\"zaaksysteem Rotterdam\",\"nummerBinnenSysteem\":\"ZS-000-123\",\"laatstAangepastDoor\":null,\"laatstAangepastDoorNaam\":null,\"contactpersoonNaam\":\"E. Dijkstra\",\"contactpersoonEmailadres\":\"e.dijkstra@samenwerken.nl\",\"contactpersoonTelefoonnummer\":\"0612345678\",\"laatstAangepastDatumTijd\":null,\"beschrijving\":\"Discussie omtrent wenselijkheid dakkapellen in deze buurt\",\"taal\":\"NL\",\"bronVerzoek\":null,\"samenwerkDoel\":\"CONCEPTVERZOEK\",\"typeVerzoek\":\"Informatie ongewoon voorval\",\"globaleLocatie\":\"Tunnelstraatweg 7, 1234AB Gouda\",\"oloVerzoeknummer\":null,\"_links\":{\"self\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246\"},\"bewerken\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246\"},\"sluiten\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246\"},\"verzoekKoppelen\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246\"},\"documentToevoegen\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246/documenten\"},\"ketenpartnerToevoegen\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246/deelnemers\"},\"actieverzoekOpstellen\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246/actieverzoeken\"},\"inkomendeActieverzoeken\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246/actieverzoeken/inkomend\"},\"uitgaandeActieverzoeken\":{\"href\":\"https://omgevingsloket:8444/samenwerken/api/samenwerkingen/SAM-246/actieverzoeken/uitgaand\"}}}\n"
}
},
"schema": {
"$ref": "#/components/schemas/Samenwerking"
}
}
},
"description": "De samenwerking is aangemaakt.",
"headers": {
"Location": {
"description": "De URI van de aangemaakte samenwerking.",
"schema": {
"type": "string",
"format": "uri"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"'importeerVerzoek' queryparameter gebruikt zonder dat er een verzoeknummer opgegeven is.": {
"description": "Er wordt een samenwerking aangemaakt, maar 'importeerVerzoek' query parameter is niet toegestaan in combinatie met de opgegeven data. Deze parameter is mag alleen gebruikt worden als een verzoeknummer is opgegeven.",
"value": "{\"type\": \"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\": \"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\": 400,\"instance\": \"5c2c9e112db94b7e2c9e1b382b580cb3\",\"detail\": \"Uitgevoerde operatie: post samenwerking / Queryparameter 'importeerVerzoek' is alleen toegestaan in combinatie met een DSO-verzoeknummer.\" }\n"
},
"Geen titel opgegeven": {
"description": "Er wordt een samenwerking aangemaakt, maar er is geen titel opgegeven.",
"value": "{\"type\": \"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\": \"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\": 400,\"instance\": \"5c2c9e112db94b7e2c9e1b382b580cb3\",\"invalid-params\": [{\"type\": \"https://content.omgevingswet.overheid.nl/id//validatie/titel\",\"name\": \"titel\",\"reason\": \"De waarde mag niet leeg zijn.\"}]}\n"
},
"Incorrect samenwerkdoel": {
"description": "Er wordt een samenwerking aangemaakt, maar het veld samenwerkDoel is opgegeven met een niet-ondersteunde waarde.",
"value": "{\"type\": \"https://content.omgevingswet.overheid.nl/id//NietLeesbaar\",\"title\": \"De opgegeven informatie is niet leesbaar.\",\"status\": 400,\"instance\": \"abd43686d2f2767f0bd534306ec26392\",\"invalid-params\": [{\"type\": \"https://content.omgevingswet.overheid.nl/id//validatie/SamenwerkDoel\",\"name\": \"SamenwerkDoel\",\"reason\": \"Geen toegestane waarde: [VOOROVERLEG]\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": {
"aanmaken met verzoeknummer zonder rechten": {
"description": "Er wordt een samenwerking aangemaakt waarbij een verzoeknummer wordt gebruikt van een verzoek waar de gebruiker geen toegang toe heeft.",
"value": "{\"title\": \"De gebruiker heeft geen rechten op het verzoek.\",\"status\": 403,\"detail\": \"Het is niet gelukt het verzoek met verzoeknummer [4030000000000] op te halen.\",\"instance\": \"89cd6ff16a6a2b1c472107c3e6db9350\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker heeft geen rechten op het verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"aanmaken met niet-bestaand verzoeknummer": {
"description": "Er wordt een samenwerking aangemaakt. Hierbij wordt een verzoeknummer opgegeven waar geen verzoek voor bestaat.",
"value": "{\"title\": \"Het gevraagde verzoek bestaat niet (meer).\",\"status\": 404,\"detail\": \"Het is niet gelukt het verzoek met verzoeknummer [4040000000000] op te halen.\",\"instance\": \"03314a3d062ea7c1a36411a9f089497d\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het gevraagde verzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"422": {
"content": {
"application/problem+json": {
"examples": {
"aanmaken voor Toezicht en Handhaving": {
"description": "Deze foutmelding geeft de sw-api terug wanneer de gebruiker een samenwerking aanmaakt met samenwerkdoel TOEZICHT_EN_HANDHAVING op het moment dat dit niet mag.\n",
"value": "{\"title\": \"De samenwerking kan niet aangemaakt worden.\",\"status\": 422,\"detail\": \"Uitgevoerde operatie: post samenwerking / Een samenwerking met samenwerkdoel TOEZICHT_EN_HANDHAVING mag vanwege wettelijke beperkingen naar verwachting pas vanaf 1 juli 2026 aangemaakt worden.\",\"instance\": \"183f3d83acb9ddc94d721e1cd0b34e4e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking kan niet aangemaakt worden.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het opslaan van de samenwerking of het ophalen ven het verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Maak een nieuwe samenwerking aan.",
"tags": [ "Samenwerkingen" ]
}
},
"/samenwerkingen/{samenwerkingId}": {
"delete": {
"deprecated": true,
"operationId": "deleteSamenwerking",
"parameters": [ {
"description": "De identificatie van de samenwerking die verwijderd moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"responses": {
"400": {
"content": {
"application/problem+json": {
"examples": {
"Incorrect samenwerkingId": {
"description": "Er wordt een samenwerking verwijderd, maar het samenerkingId heeft een incorrecte waarde",
"value": "{\"type\": \"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\": \"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\": 400,\"instance\": \"bc33a211151869acee2b330e85f1f636\",\"invalid-params\": [{\"type\": \"https://content.omgevingswet.overheid.nl/id//validatie/samenwerkingId\",\"name\": \"samenwerkingId\",\"reason\": \"De lengte moet tussen 5 en 20 tekens zijn.\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"405": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het handmatig verwijderen van samenwerkingen is niet langer mogelijk. Aanroepen van dit endpoint zal een 405-response teruggeven.Vanaf 1 juli 2026 zal het endpoint niet meer bestaan.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het verwijderen van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijder de samenwerking.",
"tags": [ "Samenwerkingen" ]
},
"get": {
"operationId": "getSamenwerking",
"parameters": [ {
"description": "De identificatie van de samenwerking die opgehaald moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Samenwerking"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de gegevens van de samenwerking op.",
"tags": [ "Samenwerkingen" ]
},
"patch": {
"description": "De patch kan gebruikt worden voor verschillende doelen:\n* het sluiten of openen van een samenwerking (status wordt opgegeven met de waarde GESLOTEN of OPEN)\n* het koppelen van een verzoek (verzoeknummer wordt opgegeven)\n* het wijzigen van metadata van de samenwerking (een of meer van de overige velden worden opgegeven).\nDeze doelen mogen niet binnen één request gecombineerd worden. Het is dus niet toegestaan om tegelijk zowel de samenwerking te sluiten als een verzoek te koppelen.\n\nBij het wijzigen van de samenwerking gelden verschillende regels, afhankelijk van welke velden gewijzigd worden.\n\n Voor elke wijziging gelden in elk geval de eis dat de patch uitgevoerd wordt door de initiator van de samenwerking.\n\n\n Voor het wijzigen van de status geldt:\n\n * De toegestane waarden zijn OPEN, GESLOTEN.\n\n * De samenwerking wordt heropend als de opgegeven status OPEN is (en de samenwerking nu GESLOTEN is), of gesloten als de status GESLOTEN is (en de samenwerking nu OPEN is).\n\n\n Voor het wijzigen van bronVerzoek, oloVerzoeknummer of verzoeknummer geldt:\n\n * Geen van deze velden heeft een waarde in de huidige samenwerking.\n\n * Het is niet toegestaan een oloVerzoeknummer op te geven.\n Sinds 1 juli 2024 is het niet langer mogelijk samenwerkingen te starten op basis van een OLO-verzoek.\n Hierdoor mogen bestaande samenwerkingen ook niet meer aangepast worden met een OLO verzoeknummer.\n\n\n * bronVerzoek mag optioneel opgegeven worden. Als het opgegeven is, moet het overeenkomen met het opgegeven verzoeknummer.\n Als het niet opgegeven is, dan wordt de waarde hieruit afgeleid.\n\n * de queryparameter importeerVerzoek mag opgegeven worden. Als het opgegeven is met de waarde true, dan\n wordt nadat de patch is uitgevoerd het verzoek geïmporteerd; de samenwerking krijgt tijdelijk de status INITIALISATIE.\n\nAls bij de (succesvolle) patch een verzoeknummer gezet is, dan wordt na afloop voor elke ondersteunde stamversie de verzoekinhoud (verzoek.xml) geïmporteerd. Het importeren van de verzoekinhoud genereert geen notificaties of foutmeldingen, en wordt uitgevoerd ongeacht de waarde van de parameter 'importeerVerzoek'.\n",
"operationId": "patchSamenwerking",
"parameters": [ {
"description": "De identificatie van de samenwerking die aangepast moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "Geeft aan of, wanneer bij de patch een verzoeknummer opgegeven is, het verzoek ook gelijk geïmporteerd moet worden.\n* Als dit veld niet is opgegeven, maar wel een verzoeknummer, dan wordt niet gecontroleerd of het bijbehorende verzoek bestaat of de gebruiker er toegang toe heeft.\n* Als dit veld is opgegeven met de waarde true, dan vindt deze controle wel plaats. Als de controle niet slaagt, wordt de patch in zijn geheel niet uitgevoerd.\n* Het is niet toegestaan dit veld te gebruiken wanneer de patch geen verzoeknummer bevat.\n",
"in": "query",
"name": "importeerVerzoek",
"required": false,
"schema": {
"type": "boolean"
}
} ],
"requestBody": {
"content": {
"application/merge-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateSamenwerking"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Samenwerking"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking heeft een status waarin deze actie niet kan worden uitgevoerd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"422": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het is niet toegestaan een of meerdere van deze velden te wijzigen, of deze combinatie van velden kan niet tegelijkertijd worden gewijzigd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het wijzigen van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig de gegevens van de samenwerking.",
"tags": [ "Samenwerkingen" ]
}
},
"/samenwerkingen/{samenwerkingId}/actieverzoeken": {
"post": {
"operationId": "createActieverzoek",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor actieverzoek aangemaakt moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateActieverzoek"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Actieverzoek"
}
}
},
"description": "Actieverzoek aangemaakt.",
"headers": {
"Location": {
"description": "De URI van het aangemaakte actieverzoek.",
"schema": {
"type": "string",
"format": "uri"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het aanmaken van het actieverzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Maak een actieverzoek aan.",
"tags": [ "Actieverzoeken" ]
}
},
"/samenwerkingen/{samenwerkingId}/deelnemers": {
"get": {
"operationId": "getDeelnemers",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor deelnemers opgehaald worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/DeelnemerList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"Invalide samenwerking-id": {
"description": "Het id van de opgegeven samenwerking is niet 5-20 cijfers lang.",
"value": "{\"type\":\"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\":\"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\":400,\"instance\":\"fcb88b85b75a143cabe967c55b139840\",\"invalid-params\":[{\"type\":\"https://content.omgevingswet.overheid.nl/id//validatie/samenwerkingId\",\"name\":\"samenwerkingId\",\"reason\":\"De lengte moet tussen 5 en 20 tekens zijn.\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": {
"Geen deelnemer": {
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"value": "{\"title\":\"De gebruiker is geen deelnemer van de samenwerking.\",\"status\":403,\"detail\":\"Organisatie [00000001001876387000] is geen deelnemer van samenwerking [SAM-4899].\",\"instance\":\"69b2bfee06bf9947ff55c08940309575\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"Samenwerking bestaat niet": {
"description": "De samenwerking bestaat niet meer.",
"value": "{\"title\":\"De samenwerking bestaat niet (meer).\",\"status\":404,\"detail\":\"Samenwerking [SAM-1] bestaat niet (meer).\",\"instance\":\"74f256bf74efa5798a53b66307fde074\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van deelnemers voor de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een overzicht van deelnemers aan de samenwerking op.",
"tags": [ "Deelnemers" ]
},
"post": {
"operationId": "addKetenpartner",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor de gebruiker geautoriseerd wordt.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateKetenpartner"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Deelnemer"
}
}
},
"description": "Ketenpartner toegevoegd.",
"headers": {
"Location": {
"description": "De URI om de ketenpartner op te halen.",
"schema": {
"type": "string",
"format": "uri"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"Invalide oin": {
"description": "Het id van de opgegeven organisatie is niet 20 cijfers lang.",
"value": "{\"type\":\"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\":\"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\":400,\"instance\":\"e24b63cc2b97cc81609cf8d13f9287c4\",\"invalid-params\":[{\"type\":\"https://content.omgevingswet.overheid.nl/id//validatie/oinBehandelorganisatie\",\"name\":\"oinBehandelorganisatie\",\"reason\":\"De lengte moet tussen 20 en 20 tekens zijn.\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": {
"Gebruiker is niet de initiator": {
"description": "De gebruiker voegt een ketenpartner toe aan een samenwerking, terwijl de gebruiker niet de initiator is.",
"value": "{\"title\":\"De gebruiker is niet de initiator van de samenwerking.\",\"status\":403,\"detail\":\"De gebruiker is niet de initiator van samenwerking [SAM-4452].\",\"instance\":\"cd0b4ff5c87687d0763b3094705a6e0e\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"Samenwerking bestaat niet": {
"description": "De samenwerking bestaat niet meer.",
"value": "{\"title\":\"De samenwerking bestaat niet (meer).\",\"status\":404,\"detail\":\"Samenwerking [SAM-1] bestaat niet (meer).\",\"instance\":\"74f256bf74efa5798a53b66307fde074\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"De behandelorganisatie van de gebruiker is al deelnemer van de samenwerking (namens iemand anders).": {
"description": "De gebruiker probeert een organisatie toe te voegen, maar deze gebruiker is een samenwerkingsverband aangegaan met iemand die al ketenpartner is namens een andere organisatie. Daarom kan de organisatie niet toegevoegd worden.",
"value": "{\"title\":\"De behandelorganisatie van de gebruiker is al deelnemer van de samenwerking.\",\"status\":409,\"detail\":\"'00000001001584182000' heeft '00000001008340560000' als behandelorganisatie en deze is al namens '00000001001915794000' deelnemer van samenwerking [SAM-2334].\",\"instance\":\"73bbbab213d4825c8fbb4a97e2435028\",\"invalid-params\":[]}\n"
},
"De behandelorganisatie van de gebruiker is al deelnemer van de samenwerking.": {
"description": "De gebruiker probeert een organisatie toe te voegen, maar deze gebruiker is een samenwerkingsverband aangegaan met iemand die al ketenpartner is. Daarom kan de organisatie niet toegevoegd worden.",
"value": "{\"title\":\"De behandelorganisatie van de gebruiker is al deelnemer van de samenwerking.\",\"status\":409,\"detail\":\"'00000001001915794000' heeft '00000001008340560000' als behandelorganisatie. '00000001008340560000' is al deelnemer van samenwerking [SAM-1886].\",\"instance\":\"69a71b3e38ac8f96196089e8bf6929df\",\"invalid-params\":[]}\n"
},
"De gebruiker is al deelnemer van de samenwerking.": {
"description": "De gebruiker probeert een organisatie toe te voegen die al ketenpartner is.",
"value": "{\"title\":\"De gebruiker is al deelnemer van de samenwerking.\",\"status\":409,\"detail\":\"'00000001008340560000' is al deelnemer van samenwerking [SAM-1886].\",\"instance\":\"637ddacc64226ccf9b9518ef8e4adf0d\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten of de gebruiker is al deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het toevoegen van de ketenpartner.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Voeg een deelnemer toe aan de samenwerking.",
"tags": [ "Deelnemers" ]
}
},
"/samenwerkingen/{samenwerkingId}/deelnemers/{organisatieId}": {
"delete": {
"operationId": "deleteKetenpartner",
"parameters": [ {
"description": "De identificatie van de samenwerking waar de ketenpartner van verwijderd moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De organisatieId van de te verwijderen ketenpartner.",
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d{20}"
}
} ],
"responses": {
"204": {
"description": "Ketenpartner verwijderd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker heeft geen rechten om de deelnemer te verwijderen.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer) of de ketenpartner is niet (meer) geautoriseerd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten, de gebruiker probeert de initiator te verwijderen, of er zijn nog openstaande actieverzoeken voor de ketenpartner.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het verwijderen van de ketenpartner.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijder een deelnemer uit de samenwerking.",
"tags": [ "Deelnemers" ]
},
"get": {
"operationId": "getDeelnemer",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor een deelnemer opgehaald wordt.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De organisatieId van de deelnemer die opgehaald wordt.",
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d{20}"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Deelnemer"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"Invalide samenwerking-id": {
"description": "Het id van de opgegeven samenwerking is niet 5-20 cijfers lang.",
"value": "{\"type\":\"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\":\"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\":400,\"instance\":\"fcb88b85b75a143cabe967c55b139840\",\"invalid-params\":[{\"type\":\"https://content.omgevingswet.overheid.nl/id//validatie/samenwerkingId\",\"name\":\"samenwerkingId\",\"reason\":\"De lengte moet tussen 5 en 20 tekens zijn.\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": {
"Geen deelnemer": {
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"value": "{\"title\":\"De gebruiker is geen deelnemer van de samenwerking.\",\"status\":403,\"detail\":\"Organisatie [00000001001876387000] is geen deelnemer van samenwerking [SAM-4899].\",\"instance\":\"69b2bfee06bf9947ff55c08940309575\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"Samenwerking bestaat niet": {
"description": "De samenwerking bestaat niet meer.",
"value": "{\"title\":\"De samenwerking bestaat niet (meer).\",\"status\":404,\"detail\":\"Samenwerking [SAM-1] bestaat niet (meer).\",\"instance\":\"74f256bf74efa5798a53b66307fde074\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de deelnemer voor de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de gegevens van de deelnemer op.",
"tags": [ "Deelnemers" ]
},
"put": {
"operationId": "updatePrivilegeVoorKetenpartner",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor het privilege van een ketenpartner aangepast wordt.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De organisatieId van de ketenpartner voor wie het privilege aangepast wordt.",
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d{20}"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePrivilegeKetenpartner"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Deelnemer"
}
}
},
"description": "Samenwerkingautorisatie aangepast.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer) of gebruiker is geen ketenpartner in de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten of de gebruiker probeert de initiator te wijzigen",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het wijzigen van de samenwerkingautorisatie voor de ketenpartner.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig het privilege van de deelnemer binnen de samenwerking.",
"tags": [ "Deelnemers" ]
}
},
"/samenwerkingen/{samenwerkingId}/documenten": {
"get": {
"operationId": "getDocumenten",
"parameters": [ {
"description": "De identificatie van een samenwerking.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op creatieDatumTijd.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | creatieDatumTijd=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | < | [lt] | creatieDatumTijd[lt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | > | [gt] | creatieDatumTijd[gt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | <= | [lte] | creatieDatumTijd[lte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | >= | [gte] | creatieDatumTijd[gte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | != | [not] | creatieDatumTijd[not]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n \n
\nOok een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle notificaties tussen 1 januari 2024 en 1 januari 2025 te selecteren:\nGET /actieverzoeken?creatieDatumTijd[gte]=2024-01-01T10%3A49%3A44.457%2B0200&creatieDatumTijd[lte]=2024-12-31T10%3A49%3A44.457%2B0200
\n",
"in": "query",
"name": "creatieDatumTijd",
"required": false,
"schema": {
"oneOf": [ {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
}, {
"$ref": "#/components/schemas/AllOtherDatumTijdParameters"
} ]
},
"style": "form"
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op aangemaaktDoor.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | aangemaaktDoor=00000001821699180000 |
\n | != | [not] | aangemaaktDoor[not]=00000001821699180000 |
\n \n
\n",
"in": "query",
"name": "aangemaaktDoor",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/NotStringParameter"
} ]
},
"style": "form"
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de resultaten gefilterd worden op aangemaaktDoorNaam.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | aangemaaktDoorNaam=Gemeente Rotterdam |
\n | < | [lt] | aangemaaktDoorNaam[lt]=Gemeente Rotterdam |
\n | > | [gt] | aangemaaktDoorNaam[gt]=Gemeente Amsterdam |
\n | <= | [lte] | aangemaaktDoorNaam[lte]=Gemeente Rotterdam |
\n | >= | [gte] | aangemaaktDoorNaam[gte]=Gemeente Amsterdam |
\n | != | [not] | aangemaaktDoorNaam[not]=Gemeente Den Haag |
\n \n
Ook een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle documenten tussen 1 januari 2024 en 1 januari 2025 te selecteren:\nGET /samenwerking/SAM-xxxx/documenten?aangemaaktDoorNaam[gte]=Gemeente Amsterdam&aangemaaktDoorNaam[lte]=Gemeente Utrecht
\n",
"in": "query",
"name": "aangemaaktDoorNaam",
"required": false,
"schema": {
"oneOf": [ {
"type": "string"
}, {
"$ref": "#/components/schemas/AllOtherParameters"
} ]
},
"style": "form"
}, {
"allowEmptyValue": true,
"description": " Deze query-parameter accepteert een lijst van velden waarop gesorteerd moet worden, gescheiden door een komma. Door een minteken (“-”) voor de veldnaam te zetten, wordt het veld in aflopende volgorde gesorteerd. Dit kan per veldnaam.\nDe volgende velden worden ondersteund:\n- bestandsNaam\n- vertrouwelijkheidsAanduiding\n- aangemaaktDoorNaam\n- creatieDatumTijd\n\nEen aantal voorbeelden: _sort=bestandsNaam\n _sort=bestandsNaam,-aangemaaktDoorNaam\n _sort=-bestandsNaam,-aangemaaktDoorNaam,creatieDatumTijd\n
Als geen sortering wordt opgegeven, worden de resultaten aflopend gesorteerd op creatieDatumTijd. ",
"example": "-bestandsNaam,-creatieDatumTijd",
"in": "query",
"name": "_sort",
"required": false,
"schema": {
"type": "string",
"default": "-creatieDatumTijd"
}
}, {
"description": "Max aantal elementen per pagina. Als de parameter niet meegegeven wordt zal de standaardwaarde 100 gebruikt worden.",
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"default": 100,
"minimum": 1
}
}, {
"description": "Deze parameter wordt gebruikt om de betreffende pagina op te halen. De geldige waarden zijn 1 en waarden hoger dan 1. Standaard zal de eerste pagina opgehaald worden.\n",
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/DocumentenList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"description": "Totaal aantal pagina’s.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"description": "Aantal resultaten per pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Pagination-Page": {
"description": "Huidige pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Total-Count": {
"description": "Totaal aantal resultaten.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de documenten van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een overzicht van documenten in de samenwerking op.",
"tags": [ "Documenten" ]
},
"post": {
"operationId": "addNewDocument",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor het document geupload moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "Een tekstuele beschrijving van het document.",
"in": "query",
"name": "documentOmschrijving",
"required": false,
"schema": {
"type": "string",
"maxLength": 200,
"minLength": 0
}
}, {
"description": "Het identificerend nummer binnen een extern systeem.",
"in": "query",
"name": "nummerBinnenSysteem",
"required": false,
"schema": {
"type": "string",
"maxLength": 80,
"minLength": 0
}
}, {
"description": "Het kenmerk van een extern systeem.",
"in": "query",
"name": "kenmerkSysteem",
"required": false,
"schema": {
"type": "string",
"maxLength": 80,
"minLength": 0
}
}, {
"description": "De vertrouwelijkheidsaanduiding van het document.",
"in": "query",
"name": "vertrouwelijkheidsAanduiding",
"required": false,
"schema": {
"type": "string",
"default": "RV",
"enum": [ "SV", "RV" ]
}
}, {
"description": "De taal waarin het document is opgesteld.",
"in": "query",
"name": "taal",
"required": false,
"schema": {
"type": "string",
"maxLength": 80,
"minLength": 0
}
} ],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"contentMediaType": "application/octet-stream",
"description": "Het document dat opgeslagen moet worden.\n\n - Het document mag maximaal 250MB groot zijn\n\n - Excel-bestanden mogen geen macro's bevatten.\n\n - De naam van het document:\n - mag niet langer zijn dan 256 tekens\n - moet een extensie hebben\n - mag niet beginnen of eindigen met een punt\n - mag geen aanhalingstekens bevatten\n - mag geen meerdere punten achter elkaar bevatten\n - moet minimaal één letter (a-z), cijfer (0-9) of een streepje (-) bevatten\n"
}
},
"required": [ "file" ]
}
}
}
},
"responses": {
"201": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Document"
}
}
},
"description": "Het document is met succes opgeslagen.",
"headers": {
"Location": {
"description": "De URI van het toegevoegde document.",
"schema": {
"type": "string",
"format": "uri"
},
"style": "simple"
},
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"413": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document is te groot.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"415": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Niet toegestaan mediatype.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"422": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bevat een virus.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het uploaden van het document.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Voeg een document toe aan de samenwerking.",
"tags": [ "Documenten" ]
}
},
"/samenwerkingen/{samenwerkingId}/documenten/content": {
"get": {
"operationId": "getDocumentenAsZip",
"parameters": [ {
"description": "De identificatie van een samenwerking.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
} ],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"examples": { },
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het zipbestand met documenten van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal zip-bestand met alle toegankelijke documenten in de samenwerking op.",
"tags": [ "Documenten" ]
}
},
"/samenwerkingen/{samenwerkingId}/documenten/{documentId}/autorisaties": {
"get": {
"operationId": "getAutorisatiesVoorDocument",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor autorisaties opgehaald moeten worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De identificatie van het document waarvoor autorisaties opgehaald moeten worden.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/DocumentAutorisatieList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Het document bestaat niet (binnen de samenwerking), of de samenwerking bestaat niet.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de autorisatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de documentautorisaties van de deelnemers op.",
"tags": [ "DocumentAutorisaties" ]
}
},
"/samenwerkingen/{samenwerkingId}/documenten/{documentId}/autorisaties/{organisatieId}": {
"put": {
"operationId": "updateDocumentAutorisatieVoorKetenpartner",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor de autorisatie aangepast wordt.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De identificatie van het document waarvoor de autorisatie aangepast wordt.",
"in": "path",
"name": "documentId",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}, {
"description": "De organisatieId van de instantie waarvoor de autorisatie aangepast wordt.",
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d{20}"
}
} ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDocumentAutorisatie"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/DocumentAutorisatie"
}
}
},
"description": "Samenwerkingautorisatie aangepast.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer) of het document is geen bestaand document in de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is gesloten of de rechten van de initiator worden gewijzigd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het wijzigen van de autorisatie.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig een documentautorisatie van de deelnemer.",
"tags": [ "DocumentAutorisaties" ]
}
},
"/samenwerkingen/{samenwerkingId}/eventtrail": {
"get": {
"operationId": "getEventTrail",
"parameters": [ {
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string"
}
}, {
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"minimum": 1
}
}, {
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/EventTrail"
}
}
},
"description": "OK",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Page": {
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Total-Count": {
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Unauthorized",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Forbidden",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Not Found",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"tags": [ "EventTrail" ]
}
},
"/samenwerkingen/{samenwerkingId}/initiator/{organisatieId}": {
"put": {
"description": "Wijzig de initiator van de samenwerking naar een andere overheidsorganisatie.",
"operationId": "putInitiator",
"parameters": [ {
"description": "De identificatie van de samenwerking die aangepast moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"description": "De identificatie van de organisatie die initiator wordt.",
"in": "path",
"name": "organisatieId",
"required": true,
"schema": {
"type": "string",
"pattern": "\\d{20}"
}
} ],
"responses": {
"200": {
"content": {
"application/json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Samenwerking"
}
}
},
"description": "De initiator van de samenwerking is met succes gewijzigd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Wijzig de initiator van de samenwerking.",
"tags": [ "Samenwerkingen" ]
}
},
"/samenwerkingen/{samenwerkingId}/notificaties": {
"get": {
"operationId": "getNotificatiesInSamenwerking",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor notificaties opgehaald moeten worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"allowReserved": true,
"description": "Met deze query-parameter kunnen de notificaties gefilterd worden op eventDatumTijd.\nDe volgende operators worden ondersteund: \n \n | Operator | \n Notatie | \n Voorbeeld | \n \n \n | = | | eventDatumTijd=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | < | [lt] | eventDatumTijd[lt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | > | [gt] | eventDatumTijd[gt]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | <= | [lte] | eventDatumTijd[lte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | >= | [gte] | eventDatumTijd[gte]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n | != | [not] | eventDatumTijd[not]=2024-08-16T10%3A49%3A44.457%2B0200 |
\n \n
\nOok een bereik kan worden geselecteerd door een parameter simpelweg twee keer op te nemen met verschillende operatoren. In het onderstaande voorbeeld gebeurt dit om alle notificaties tussen 1 januari 2024 en 1 januari 2025 te selecteren:\nGET /notificaties?eventDatumTijd[gte]=2024-01-01T10%3A49%3A44.457%2B0200&eventDatumTijd[lte]=2024-12-31T10%3A49%3A44.457%2B0200
\n",
"in": "query",
"name": "eventDatumTijd",
"required": false,
"schema": {
"oneOf": [ {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
}, {
"$ref": "#/components/schemas/AllOtherDatumTijdParameters"
} ]
},
"style": "form"
}, {
"description": "Deze query-parameter accepteert een lijst van velden waarop gesorteerd moet worden gescheiden door een komma. Door een minteken (“-”) voor de veldnaam te zetten, wordt het veld in aflopende volgorde gesorteerd.\nDe volgende velden worden ondersteund:\n- eventDatumTijd\n- samenwerkingId\n- eventInitiator\n\nEen aantal voorbeelden: _sort=eventDatumTijd\\n _sort=samenwerkingId,-eventDatumTijd\\n _sort=-eventInitiator,-samenwerkingId,eventDatumTijd\\n
Als geen sortering wordt opgegeven, worden de resultaten aflopend op eventDatumTijd gesorteerd.\n",
"example": "-samenwerkingId,-eventDatumTijd",
"in": "query",
"name": "_sort",
"required": false,
"schema": {
"type": "string",
"default": "-eventDatumTijd"
}
}, {
"description": "Max aantal notificaties per pagina. Als de parameter niet meegegeven wordt zal de standaardwaarde 1000 gebruikt worden.",
"in": "query",
"name": "aantal",
"schema": {
"type": "integer",
"default": 1000,
"minimum": 1
}
}, {
"description": "Deze parameter wordt gebruikt om de betreffende pagina op te halen. De geldige waarden zijn 1 en waarden hoger dan 1. Standaard zal de eerste pagina opgehaald worden.\n",
"in": "query",
"name": "pagina",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/NotificatieList"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"X-Pagination-Count": {
"description": "Totaal aantal pagina’s.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"X-Pagination-Limit": {
"description": "Aantal resultaten per pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Pagination-Page": {
"description": "Huidige pagina.",
"schema": {
"type": "integer",
"default": 1,
"minimum": 1
},
"style": "simple"
},
"X-Total-Count": {
"description": "Totaal aantal resultaten.",
"schema": {
"type": "integer"
},
"style": "simple"
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is geen deelnemer van de samenwerking.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de notificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal de bij de samenwerking horende notificaties van de deelnemer op.",
"tags": [ "Notificaties" ]
}
},
"/samenwerkingen/{samenwerkingId}/verzoek": {
"get": {
"description": "Via deze operatie kan een verzoek opgehaald worden. Dit kan alleen voor samenwerkingen waar een verzoek aan is gekoppeld; alleen initiators en gebruikers met volledige toegang tot de samenwerking kunnen dit doen.\nHet opgeven van de stamversie is optioneel. Als er geen stamversie opgegeven is, wordt het verzoek met de laagste stamversie opgehaald en teruggegeven. Als er wel een stamversie is opgegeven, wordt alleen het overeenkomende verzoek opgehaald.\nHet is ook mogelijk dat, ook al is de samenwerking aan een verzoek gekoppeld, er geen verzoek beschikbaar is. In dat geval wordt een 404-response teruggeven.\n",
"operationId": "getVerzoek",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor een verzoek opgehaald moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"in": "header",
"name": "X-Stam-Versie",
"required": false,
"schema": {
"type": "string"
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": { },
"schema": {
"$ref": "#/components/schemas/Verzoek"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker heeft geen (volledige) toegang tot de samenwerking.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer), of het verzoek is niet aanwezig.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is niet gekoppeld aan een verzoek of de samenwerking heeft niet de samenwerkvorm 'Samenwerken aan behandelen',\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haalt één verzoek op.",
"tags": [ "Verzoek" ]
},
"patch": {
"description": "Haal en (aanvulling) op een verzoek op, inclusief bijlagen, en verwerk deze in de samenwerking.\n* De verzoek.xml en verzoek.pdf die eventueel al in de samenwerking aanwezig zijn, worden vervangen door de overeenkomende bestanden in het verzoek.\n* Documenten die nieuw zijn in het verzoek (ze bestaan niet in de samenwerking) worden toegevoegd aan de samenwerking.\n* Documenten die in het verzoek staan en ook al aanwezig zijn in de samenwerking worden overschreven.\n* Documenten die in de samenwerking staan maar niet aanwezig zijn in het verzoek blijven ongewijzigd in de samenwerking bestaan.\nVoor elke ondersteunde stamversie wordt de verzoekinhoud (verzoek.xml) geïmporteerd.\n",
"operationId": "importVerzoekInSamenwerking",
"parameters": [ {
"description": "De identificatie van de samenwerking die aangevuld moet worden met de gegevens uit het verzoek.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"in": "header",
"name": "X-Stam-Versie",
"required": false,
"schema": {
"type": "string"
}
} ],
"responses": {
"202": {
"description": "Het verzoek is gevonden en het inlezen en verwerken ervan wordt gestart.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker is niet de initiator van de samenwerking of heeft geen rechten op het gekoppelde verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer) of het gekoppelde verzoek bestaat niet (meer).",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is (nog) niet open, heeft niet de samenwerkVorm 'Samenwerken aan behandelen', of is niet gekoppeld met een verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haal een (aanvulling op) een verzoek op.",
"tags": [ "Samenwerkingen" ]
}
},
"/samenwerkingen/{samenwerkingId}/verzoek/content": {
"get": {
"description": "Via deze operatie kan het verzoek opgehaald worden. Dit kan alleen voor samenwerkingen waar een verzoek aan is gekoppeld; alleen initiators en gebruikers met volledige toegang tot de samenwerking kunnen dit doen.\nHet opgeven van de stamversie is optioneel. Als er geen stamversie opgegeven is, wordt het verzoek met de laagste stamversie opgehaald en teruggegeven. Als er wel een stamversie is opgegeven, wordt alleen het overeenkomende verzoek opgehaald.\nHet is ook mogelijk dat, ook al is de samenwerking aan een verzoek gekoppeld, er geen verzoek beschikbaar is, of het verzoek is wel beschikbaar, maar niet voor de opgegeven stamversie. In deze gevallen wordt een 404-response teruggeven.\n",
"operationId": "getVerzoekContent",
"parameters": [ {
"description": "De identificatie van de samenwerking waarvoor het verzoek opgehaald moet worden.",
"in": "path",
"name": "samenwerkingId",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 5
}
}, {
"in": "header",
"name": "X-Stam-Versie",
"required": false,
"schema": {
"type": "string"
}
} ],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"examples": { },
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"403": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De gebruiker heeft geen (volledige) toegang tot de samenwerking.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking bestaat niet (meer), of het verzoek is niet aanwezig.\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": { },
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De samenwerking is niet gekoppeld aan een verzoek of de samenwerking heeft niet de samenwerkvorm 'Samenwerken aan behandelen',\n",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van de inhoud van het verzoek.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haalt de inhoud van één verzoek op.",
"tags": [ "Verzoek" ]
}
},
"/samenwerkingsverband": {
"delete": {
"operationId": "deleteSamenwerkingsverband",
"responses": {
"204": {
"description": "Samenwerkingsverband verwijderd.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"De organisatie heeft geen samenwerkingsverband.": {
"description": "Het te verwijderen samenwerkingsverband bestaat niet.",
"value": "{\"title\":\"De organisatie heeft geen samenwerkingsverband.\",\"status\":404,\"detail\":\"Er is geen samenwerkingsverband geregistreerd voor organisatie 00000001809249066000.\",\"instance\":\"398a86b5fcb1db3fdce6c24c9f4d01ed\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De organisatie heeft geen samenwerkingsverband.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het verwijderen van het samenwerkingsverband.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Verwijdert een samenwerkingsverband",
"tags": [ "Samenwerkingsverband" ]
},
"get": {
"description": "Geeft het samenwerkingsverband terug voor de huidige gebruiker, mits deze eerder een samenwerkingsverband heeft vastgelegd.",
"operationId": "getSamenwerkingsverband",
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": {
"Succes.": {
"description": "Het gevraagde samenwerkingsverband bestaat.",
"value": "{\"behandelOrganisatie\":{\"id\":\"00000001001915794000\",\"naam\":\"Gemeente Dordrecht\",\"laatstGezien\":\"2025-11-10T09:55:25.203+01:00\",\"links\":[]},\"opdrachtgevendeOrganisatie\":{\"id\":\"00000001809249066000\",\"naam\":\"Gemeente Steenwijkerland\",\"laatstGezien\":\"2025-11-10T10:16:49.028+01:00\",\"links\":[]}}\n"
}
},
"schema": {
"$ref": "#/components/schemas/Samenwerkingsverband"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"404": {
"content": {
"application/problem+json": {
"examples": {
"De organisatie heeft geen samenwerkingsverband.": {
"description": "Het gevraagde samenwerkingsverband bestaat niet.",
"value": "{\"title\":\"De organisatie heeft geen samenwerkingsverband.\",\"status\":404,\"detail\":\"Er is geen samenwerkingsverband geregistreerd voor organisatie 00000001809249066000.\",\"instance\":\"398a86b5fcb1db3fdce6c24c9f4d01ed\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De organisatie heeft geen samenwerkingsverband.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het ophalen van het samenwerkingsverband.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Haalt het samenwerkingsverband op.",
"tags": [ "Samenwerkingsverband" ]
}
},
"/samenwerkingsverband/{oinBehandelorganisatie}": {
"put": {
"description": "Er wordt een nieuw samenwerkingsverband vastgelegd tussen de huidige gebruiker en de in de url opgegeven organisatie. Als er al een samenwerkingsverband was vastgelegd, wordt deze overschreven.\n",
"operationId": "putSamenwerkingsverband",
"parameters": [ {
"in": "path",
"name": "oinBehandelorganisatie",
"required": true,
"schema": {
"type": "string",
"maxLength": 20,
"minLength": 20
}
} ],
"responses": {
"200": {
"content": {
"application/hal+json": {
"examples": {
"Het samenwerkingsverband is opgeslagen.": {
"description": "Er is met succes een nieuw samenwerkingsverband opgeslagen of een bestaand gewijzigd.",
"value": "{\"behandelOrganisatie\":{\"id\":\"00000001008340560000\",\"naam\":\"Gemeente Waterland\",\"laatstGezien\":\"2025-11-04T15:17:27.424+01:00\",\"links\":[]},\"opdrachtgevendeOrganisatie\":{\"id\":\"00000001809249066000\",\"naam\":\"Gemeente Steenwijkerland\",\"laatstGezien\":\"2025-11-10T10:16:49.028+01:00\",\"links\":[]}}\n"
}
},
"schema": {
"$ref": "#/components/schemas/Samenwerkingsverband"
}
}
},
"description": "Succes.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"400": {
"content": {
"application/problem+json": {
"examples": {
"Invalide oin": {
"description": "Het id van de opgegeven organisatie is niet 20 cijfers lang.",
"value": "{\"type\":\"https://content.omgevingswet.overheid.nl/id//ValidatieMislukt\",\"title\":\"De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.\",\"status\":400,\"instance\":\"e24b63cc2b97cc81609cf8d13f9287c4\",\"invalid-params\":[{\"type\":\"https://content.omgevingswet.overheid.nl/id//validatie/oinBehandelorganisatie\",\"name\":\"oinBehandelorganisatie\",\"reason\":\"De lengte moet tussen 20 en 20 tekens zijn.\"}]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"401": {
"content": {
"application/problem+json": {
"examples": {
"Invalide token": {
"description": "Het JWT-token dat als request-header wordt meegestuurd is corrupt.",
"value": "{\"title\": \"Authenticatie is niet correct.\",\"status\": 401,\"instance\": \"407a3a28f9ed4fda1861d7b277597e8e\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Authenticatiegegevens ontbreken of zijn onjuist.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"409": {
"content": {
"application/problem+json": {
"examples": {
"Samenwerkingsverband met zichzelf.": {
"description": "De organisatie geeft zichzelf op als behandelorganisatie bij het opslaan van een samenwerkingsverband.",
"value": "{\"title\":\"De organisatie mag niet zichzelf als behandelorganisatie opgeven.\",\"status\":409,\"detail\":\"00000001809249066000 mag niet zichzelf als behandelorganisatie opgeven.\",\"instance\":\"540e169ceea283072ed7f8a83b4fd9ae\",\"invalid-params\":[]}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "De organisatie mag niet zichzelf als behandelorganisatie opgeven.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
},
"500": {
"content": {
"application/problem+json": {
"examples": {
"Voorbeeld 500-response": {
"description": "Deze response wordt teruggegeven wanneer er een storing is in het systeem zelf. De waarde in het detail-veld geeft aan welke actie uitgevoerd wordt.",
"value": "{\"title\": \"Onverwachte fout\",\"status\": 500,\"detail\": \"Uitgevoerde operatie: post samenwerking\",\"instance\": \"38769b1388b764114bf4a26c943085a7\",\"invalid-params\": []}\n"
}
},
"schema": {
"type": "object",
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Er is een probleem opgetreden bij het toekennen van het samenwerkingsverband.",
"headers": {
"Warning": {
"description": "Deze header waarschuwt voor een aanstaande uitfasering van een verouderde versie.",
"example": "299 https://service/api/v1 Deze versie van de api is verouderd en zal worden uitgefaseerd. Update naar de laatste versie.",
"schema": { }
},
"api-version": {
"description": "Bevat het versienummer van de Samenwerken-API.",
"example": "5.7.3",
"schema": { }
}
}
}
},
"summary": "Legt een samenwerkingsverband vast.",
"tags": [ "Samenwerkingsverband" ]
}
}
},
"components": {
"schemas": {
"API": {
"type": "object",
"description": "levert metadata over de API.",
"properties": {
"app-info": {
"$ref": "#/components/schemas/app-info"
}
}
},
"Actieverzoek": {
"type": "object",
"description": "Alle beschikbare data over een actieverzoek.",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"aantalBerichten": {
"type": "integer",
"format": "int32",
"description": "Aantal berichten verzonden voor het actieverzoek.",
"examples": [ "1" ]
},
"actieverzoekId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het actieverzoek",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De (Nederlandse) datum en tijd van het aanmaken van het actieverzoek.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"documenten": {
"type": "array",
"description": "Documenten uit de samenwerking die gekoppeld zijn aan het actieverzoek.",
"items": {
"$ref": "#/components/schemas/Document"
}
},
"laatstAangepastDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd waarop het actieverzoek voor het laatst is bijgewerkt.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"laatstAangepastDoor": {
"type": "string",
"description": "De organisatieId van de ketenpartner die de laatste aanpassing heeft gemaakt in het actieverzoek.",
"examples": [ "00000001003214412000" ],
"pattern": "\\d{20}"
},
"laatstAangepastDoorNaam": {
"type": "string",
"description": "De naam van de ketenpartner die de laatste aanpassing heeft gemaakt in het actieverzoek.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200
},
"melding": {
"type": "string",
"description": "De melding m.b.t. gereed melden / intrekken actieverzoek. Bij het aanmaken van een actieverzoek zal dit veld initieel altijd leeg zijn.",
"examples": [ "Het gevraagde advies is toegevoegd aan het dossier" ],
"maxLength": 6144,
"minLength": 1
},
"omschrijving": {
"type": "string",
"description": "Het bericht aan de ontvanger van het actieverzoek.",
"examples": [ "Graag het advies toevoegen aan het dossier" ],
"maxLength": 6144,
"minLength": 1
},
"ontvanger": {
"type": "string",
"description": "De organisatieId van de ontvanger van het actieverzoek.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"ontvangerNaam": {
"type": "string",
"description": "De naam van de ontvanger van het actieverzoek.",
"examples": [ "Ministerie van Infrastructuur en Waterstaat (LVO - Departement)" ],
"maxLength": 200,
"minLength": 1
},
"productId": {
"type": "string",
"description": "De productId van het actieverzoek",
"examples": [ "urn:advies:12345" ],
"maxLength": 2048,
"minLength": 0
},
"samenwerkingId": {
"type": "string",
"description": "De identificatie van de samenwerking.",
"examples": [ "SAM-12345" ],
"maxLength": 20,
"minLength": 5
},
"status": {
"type": "string",
"description": "De status van het actieverzoek.",
"enum": [ "OPEN", "IN_BEHANDELING", "GEWEIGERD", "INGETROKKEN", "GEREEDGEMELD", "GEREED" ]
},
"titel": {
"type": "string",
"description": "De titel van het actieverzoek.",
"examples": [ "Advies toevoegen" ],
"maxLength": 80,
"minLength": 1
},
"zender": {
"type": "string",
"description": "De organisatieId van de initiator van het actieverzoek.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"zenderNaam": {
"type": "string",
"description": "De naam van de initiator van het actieverzoek.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
}
}
},
"ActieverzoekEvent": {
"allOf": [ {
"$ref": "#/components/schemas/EventMetadata"
}, {
"type": "object",
"properties": {
"actieverzoekId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het actieverzoek",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"melding": {
"type": "string",
"description": "De melding m.b.t. gereed melden / intrekken actieverzoek. Bij het aanmaken van een actieverzoek zal dit veld initieel altijd leeg zijn.",
"examples": [ "Het gevraagde advies is toegevoegd aan het dossier" ],
"maxLength": 6144,
"minLength": 1
},
"omschrijving": {
"type": "string",
"description": "Het bericht aan de ontvanger van het actieverzoek.",
"examples": [ "Graag het advies toevoegen aan het dossier" ],
"maxLength": 6144,
"minLength": 1
},
"ontvanger": {
"type": "string",
"description": "De organisatieId van de ontvanger van het actieverzoek.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"ontvangerNaam": {
"type": "string",
"description": "De naam van de ontvanger van het actieverzoek.",
"examples": [ "Ministerie van Infrastructuur en Waterstaat (LVO - Departement)" ],
"maxLength": 200,
"minLength": 1
},
"productId": {
"type": "string",
"description": "De productId van het actieverzoek",
"examples": [ "urn:advies:12345" ],
"maxLength": 2048,
"minLength": 0
},
"status": {
"type": "string",
"description": "De status van het actieverzoek.",
"enum": [ "OPEN", "IN_BEHANDELING", "GEWEIGERD", "INGETROKKEN", "GEREEDGEMELD", "GEREED" ]
},
"titel": {
"type": "string",
"description": "De titel van het actieverzoek.",
"examples": [ "Advies toevoegen" ],
"maxLength": 80,
"minLength": 1
},
"uitersteLeverdatum": {
"type": "string",
"format": "date-time",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"zender": {
"type": "string",
"description": "De organisatieId van de initiator van het actieverzoek.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"zenderNaam": {
"type": "string",
"description": "De naam van de initiator van het actieverzoek.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
}
}
} ],
"description": "Een mutatie op een actieverzoek."
},
"ActieverzoekList": {
"type": "object",
"description": "Een lijst actieverzoeken.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"actieverzoeken": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Actieverzoek"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
}
}
},
"AllOtherDatumTijdParameters": {
"type": "object",
"properties": {
"gt": {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
},
"gte": {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
},
"lt": {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
},
"lte": {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
},
"not": {
"type": "string",
"format": "date-time",
"examples": [ "2024-08-16T10%3A49%3A44.457%2B0200" ]
}
}
},
"AllOtherParameters": {
"type": "object",
"properties": {
"gt": {
"type": "string"
},
"gte": {
"type": "string"
},
"lt": {
"type": "string"
},
"lte": {
"type": "string"
},
"not": {
"type": "string"
}
}
},
"Bericht": {
"type": "object",
"description": "Een bericht gekoppeld aan een actieverzoek",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"actieverzoekId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het actieverzoek",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"berichtId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het bericht",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De (Nederlandse) datum en tijd van het aanmaken van het bericht.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"inhoud": {
"type": "string",
"description": "De inhoud van een bericht.",
"examples": [ "Dit is de inhoud van het bericht." ],
"maxLength": 512,
"minLength": 0
},
"ontvanger": {
"type": "string",
"description": "De organisatieId van de ontvanger van het bericht.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"ontvangerNaam": {
"type": "string",
"description": "De naam van de ontvanger van het bericht.",
"examples": [ "Ministerie van Infrastructuur en Waterstaat (LVO - Departement)" ],
"maxLength": 200,
"minLength": 1
},
"samenwerkingId": {
"type": "string",
"description": "Een door het systeem gegenereerd unieke identificatie van de samenwerking.\nDit ID wordt gebruikt bij het doen van mutaties op een samenwerking.",
"examples": [ "SAM-1" ],
"maxLength": 20,
"minLength": 5
},
"zender": {
"type": "string",
"description": "De organisatieId van de zender van het bericht.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"zenderNaam": {
"type": "string",
"description": "De naam van de zender van het bericht.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
}
},
"required": [ "ontvanger" ]
},
"BerichtEvent": {
"allOf": [ {
"$ref": "#/components/schemas/EventMetadata"
}, {
"type": "object",
"properties": {
"actieverzoekId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het actieverzoek",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"berichtId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het bericht",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"inhoud": {
"type": "string",
"description": "De inhoud van een bericht.",
"examples": [ "Dit is de inhoud van het bericht." ]
}
}
} ],
"description": "Een mutatie op een bericht."
},
"BerichtList": {
"type": "object",
"description": "Een lijst berichten.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"berichten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bericht"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
}
}
},
"CreateActieverzoek": {
"type": "object",
"description": "Details benodigd voor het aanmaken van het actieverzoek.",
"properties": {
"documenten": {
"type": "array",
"description": "Een lijst van identifiers van relevante documenten in het samenwerkdossier.",
"examples": [ "[\"7a749408-3bd8-11eb-adc1-0242ac120002\", \"f5dc008c-47b4-454d-b4fa-57869c45b6d6\"]" ],
"items": {
"type": "string",
"format": "uuid",
"description": "Een lijst van identifiers van relevante documenten in het samenwerkdossier.",
"examples": [ "[\"7a749408-3bd8-11eb-adc1-0242ac120002\", \"f5dc008c-47b4-454d-b4fa-57869c45b6d6\"]" ]
},
"uniqueItems": true
},
"omschrijving": {
"type": "string",
"description": "De omschrijving van het actieverzoek.",
"examples": [ "Graag het advies toevoegen aan het dossier" ],
"maxLength": 6144,
"minLength": 0
},
"ontvanger": {
"type": "string",
"description": "De organisatieId van de ontvanger van het actieverzoek.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"productId": {
"type": "string",
"description": "De productId van het actieverzoek.",
"examples": [ "urn:advies:12345" ],
"maxLength": 2048,
"minLength": 0
},
"titel": {
"type": "string",
"description": "De titel van het actieverzoek.",
"examples": [ "Advies toevoegen" ],
"maxLength": 80,
"minLength": 1
}
},
"required": [ "ontvanger", "titel" ]
},
"CreateBericht": {
"type": "object",
"description": "Parameters r.b.v. het aanmaken van een bericht",
"properties": {
"bericht": {
"type": "string",
"description": "De inhoud van een bericht.",
"examples": [ "Dit is de inhoud van het bericht." ],
"maxLength": 512,
"minLength": 1
}
},
"required": [ "bericht" ]
},
"CreateKetenpartner": {
"type": "object",
"description": "De nieuw toe te voegen ketenpartner en diens privilege binnen de samenwerking",
"properties": {
"organisatie": {
"$ref": "#/components/schemas/OrganisatieId",
"description": "De details van de ketenpartner die geautoriseerd wordt."
},
"privilege": {
"type": "string",
"description": "* VT - Volledige toegang, toegang tot alle documenten in het samenwerkdossier. \n* BT - Beperkte toegang, toegang tot documenten in het samenwerkdossier die geen persoonsgegevens en/of bedrijfsgevoelige gegevens bevatten.",
"enum": [ "BT", "VT" ]
}
},
"required": [ "organisatie", "privilege" ]
},
"CreateSamenwerking": {
"type": "object",
"description": "Parameters t.b.v. het aanmaken van een Samenwerking.",
"properties": {
"beschrijving": {
"type": "string",
"description": "Beschrijving van de samenwerking.",
"examples": [ "Discussie omtrent wenselijkheid dakkapellen in deze buurt" ],
"maxLength": 6144,
"minLength": 0
},
"bronVerzoek": {
"type": "string",
"description": "Bron van het verzoek: DSO_LV of OLO. Als bij het aanmaken van een samenwerking op basis van een verzoek 1 verzoeknummer is ingevuld, kan de bron daaruit worden afgeleid en mag bronVerzoek leeg worden gelaten.",
"enum": [ "DSO_LV", "OLO" ]
},
"contactpersoonEmailadres": {
"type": "string",
"description": "Het e-mailadres van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "e.dijkstra@samenwerken.nl" ],
"maxLength": 256,
"minLength": 0
},
"contactpersoonNaam": {
"type": "string",
"description": "De naam van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "E. Dijkstra" ],
"maxLength": 200,
"minLength": 0
},
"contactpersoonTelefoonnummer": {
"type": "string",
"description": "Het telefoonnummer van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "0612345678" ],
"maxLength": 20,
"minLength": 0
},
"globaleLocatie": {
"type": "string",
"description": "Globale locatie van het verzoek.",
"examples": [ "Tunnelstraatweg 7, 1234AB Gouda" ],
"maxLength": 200,
"minLength": 0
},
"importVerzoekApplicable": {
"type": "boolean"
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80,
"minLength": 0
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het nummer van de samenwerking binnen de organisatie van de initiator.",
"examples": [ "ZS-000-123" ],
"maxLength": 80,
"minLength": 0
},
"oloVerzoeknummer": {
"type": "string",
"description": "Het nummer van het OLO-verzoek. Kan niet worden gebruikt i.c.m. DSO-verzoeknummer. Als het ingevuld is, moet bronVerzoek OLO zijn of leeg worden gelaten.",
"examples": [ "0000001" ],
"pattern": "(?=^\\d{7}$)\\d*[1-9]"
},
"samenwerkDoel": {
"type": "string",
"description": "Het doel van de samenwerking, de default waarde is 'BEHANDELEN'.",
"enum": [ "CONCEPTVERZOEK", "BEHANDELEN", "TOEZICHT_EN_HANDHAVING" ]
},
"titel": {
"type": "string",
"description": "De naam van de samenwerking.",
"examples": [ "Voorbeeld samenwerking" ],
"maxLength": 200,
"minLength": 1
},
"typeVerzoek": {
"type": "string",
"description": "Het type van het verzoek. Bij een DSO-verzoek is de waarde leeg of één van de volgende waarden:\n* 'Aanvraag vergunning' (de default)\n* 'Melding'\n* 'Informatie'\n* 'Informatie ongewoon voorval'\n* 'Aanvraag maatwerkvoorschrift'\n* 'Melding gelijkwaardige maatregel'\n* 'Aanvraag toestemming gelijkwaardige maatregel'\n",
"examples": [ "Informatie ongewoon voorval" ],
"maxLength": 80,
"minLength": 0
},
"verzoeknummer": {
"type": "string",
"description": "Verzoeknummer van de samenwerking. Kan niet worden gebruikt i.c.m. OLO-verzoeknummer. Als het ingevuld is, moet bronVerzoek DSO_LV zijn of leeg worden gelaten.",
"examples": [ "1234567890123" ],
"pattern": "\\d{13}"
}
},
"required": [ "titel" ]
},
"Deelnemer": {
"type": "object",
"description": "Een deelnemer en diens privilege binnen een samenwerking.",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd dat de organisatie deelnemer is geworden in de samenwerking.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"laatstAangepastDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd dat er metadata van de deelnemer in de samenwerking aangepast is, bijvoorbeeld de privilege.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"opdrachtgevendeOrganisatie": {
"$ref": "#/components/schemas/OpdrachtgevendeOrganisatie",
"description": "De organisatie namens welke deze organisatie deelnemer is."
},
"organisatie": {
"$ref": "#/components/schemas/KetenpartnerDetails",
"description": "De geautoriseerde ketenpartner."
},
"privilege": {
"type": "string",
"description": "* VT - Volledige toegang, toegang tot alle documenten in het samenwerkdossier. \n* BT - Beperkte toegang, toegang tot documenten in het samenwerkdossier die geen persoonsgegevens en/of bedrijfsgevoelige gegevens bevatten.\n * INITIATOR - Volledige toegang en rechten om het dossier en alle documenten te wijzigen of te verwijderen.",
"enum": [ "VT", "BT", "INITIATOR" ]
}
}
},
"DeelnemerEvent": {
"allOf": [ {
"$ref": "#/components/schemas/EventMetadata"
}, {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "De identificatie van een ketenpartner (OIN of HRN)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"idOpdrachtgevendeOrganisatie": {
"type": "string",
"description": "De identificatie (OIN of HRN) van de organisatie namens wie de ketenpartner handelt (als er sprake is van een samenwerkingsverband)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"naam": {
"type": "string",
"description": "De naam van de ketenpartner.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"naamOpdrachtgevendeOrganisatie": {
"type": "string",
"description": "De naam van de organisatie van de organisatie namens wie de ketenpartner handelt (als er sprake is van een samenwerkingsverband).",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"privilege": {
"type": "string",
"description": "* VT - Volledige toegang, toegang tot alle documenten in het samenwerkdossier. \n* BT - Beperkte toegang, toegang tot documenten in het samenwerkdossier die geen persoonsgegevens en/of bedrijfsgevoelige gegevens bevatten.\n * INITIATOR - Volledige toegang en rechten om het dossier en alle documenten te wijzigen of te verwijderen.",
"enum": [ "VT", "BT", "INITIATOR" ]
}
}
} ],
"description": "Een mutatie op de lijst met deelnemers van de samenwerking."
},
"DeelnemerList": {
"type": "object",
"description": "Een lijst deelnemers.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"deelnemers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Deelnemer"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
}
}
},
"Document": {
"type": "object",
"description": "Alle beschikbare metadata van een document",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"aangemaaktDoor": {
"type": "string",
"description": "De organisatieId van de gebruiker die het document toegevoegd heeft.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"aangemaaktDoorNaam": {
"type": "string",
"description": "De naam van de gebruiker die het document toegevoegd heeft.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"bestandsNaam": {
"type": "string",
"description": "De bestandsnaam van het document.",
"examples": [ "samenwerkingdetails.pdf" ],
"maxLength": 256,
"minLength": 1
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd waarop het document is toegevoegd.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"documentHash": {
"type": "string",
"description": "De documenthash.",
"examples": [ "cccf5e546c899cce0accc8ac07d91688a7ad0136439c7fb9ccf02b9e39e0eaf3" ],
"maxLength": 80
},
"documentId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het document.",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"documentOmschrijving": {
"type": "string",
"description": "Een tekstuele beschrijving van het document.",
"examples": [ "Samenwerking overzicht" ],
"maxLength": 200,
"minLength": 1
},
"formaat": {
"type": "string",
"description": "Het MIME type van het document.",
"examples": [ "application/pdf" ],
"maxLength": 80
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80
},
"laatstAangepastDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd waarop het document voor het laatst is aangepast.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"laatstAangepastDoor": {
"type": "string",
"description": "De organisatieId van de gebruiker die het document voor het laatst heeft aangepast.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"laatstAangepastDoorNaam": {
"type": "string",
"description": "De naam van de gebruiker die het document voor het laatst heeft aangepast.",
"examples": [ "Gemeente Amsterdam" ],
"maxLength": 200,
"minLength": 1
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het identificerend nummer binnen een extern systeem.",
"examples": [ "ZS-000-123" ],
"maxLength": 80
},
"samenwerkingId": {
"type": "string",
"description": "De identificatie van de samenwerking.",
"examples": [ "SAM-12345" ],
"maxLength": 20,
"minLength": 5
},
"taal": {
"type": "string",
"description": "De taal waarin het document is opgesteld.",
"examples": [ "Nederlands" ],
"maxLength": 80,
"minLength": 1
},
"vertrouwelijkheidsAanduiding": {
"type": "string",
"description": "De vertrouwelijkheidsaanduiding van het document.",
"enum": [ "SV", "RV" ]
}
}
},
"DocumentAutorisatie": {
"type": "object",
"description": "De rechten die een ketenpartner heeft op een bepaald document.",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"organisatie": {
"$ref": "#/components/schemas/KetenpartnerDetails",
"description": "De geautoriseerde ketenpartner."
},
"rechten": {
"type": "string",
"description": "* N - geen rechten \n * R - leesrechten \n * RUD - lees- en wijzigrechten",
"enum": [ "N", "R", "RUD" ]
}
}
},
"DocumentAutorisatieList": {
"type": "object",
"description": "De lijst met autorisaties van een document.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"autorisaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentAutorisatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
}
}
},
"DocumentEvent": {
"allOf": [ {
"$ref": "#/components/schemas/EventMetadata"
}, {
"type": "object",
"properties": {
"aangemaaktDoor": {
"type": "string",
"description": "De organisatieId van de gebruiker die het document toegevoegd heeft.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"aangemaaktDoorNaam": {
"type": "string",
"description": "De naam van de gebruiker die het document toegevoegd heeft.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"bestandsNaam": {
"type": "string",
"description": "De bestandsnaam van het document.",
"examples": [ "samenwerkingdetails.pdf" ],
"maxLength": 256,
"minLength": 1
},
"documentAutorisaties": {
"type": "array",
"description": "Een lijst met autorisaties die van toepassing zijn op het document.",
"items": {
"$ref": "#/components/schemas/DocumentAutorisatie"
}
},
"documentHash": {
"type": "string",
"description": "De documenthash.",
"examples": [ "cccf5e546c899cce0accc8ac07d91688a7ad0136439c7fb9ccf02b9e39e0eaf3" ],
"maxLength": 80
},
"documentId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van het document.",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"documentOmschrijving": {
"type": "string",
"description": "Een tekstuele beschrijving van het document.",
"examples": [ "Samenwerking overzicht" ],
"maxLength": 200,
"minLength": 1
},
"formaat": {
"type": "string",
"description": "Het MIME type van het document.",
"examples": [ "application/pdf" ],
"maxLength": 80
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80
},
"laatstAangepastDoor": {
"type": "string",
"description": "De organisatieId van de gebruiker die het document voor het laatst heeft aangepast.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"laatstAangepastDoorNaam": {
"type": "string",
"description": "De naam van de gebruiker die het document voor het laatst heeft aangepast.",
"examples": [ "Gemeente Amsterdam" ],
"maxLength": 200,
"minLength": 1
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het identificerend nummer binnen een extern systeem.",
"examples": [ "ZS-000-123" ],
"maxLength": 80
},
"taal": {
"type": "string",
"description": "De taal waarin het document is opgesteld.",
"examples": [ "Nederlands" ],
"maxLength": 80,
"minLength": 1
},
"vertrouwelijkheidsAanduiding": {
"type": "string",
"description": "De vertrouwelijkheidsaanduiding van het document.",
"enum": [ "SV", "RV" ]
}
}
} ],
"description": "Een mutatie op een document."
},
"DocumentenList": {
"type": "object",
"description": "Een gepagineerde lijst documenten.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"documenten": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"ErrorResponse": {
"type": "object",
"description": "Details waarom een request niet met succes uitgevoerd kan worden.",
"properties": {
"detail": {
"type": "string",
"description": "Meer details over de foutsituatie, indien van toepassing",
"examples": [ "De service is aangeroepen met invalide data. De opgegeven data voldoet niet aan de specificaties." ]
},
"instance": {
"type": "string",
"description": "Een unieke identificatie die hoort bij het specifieke voorkomen van de fout.",
"examples": [ "f5dc008c-47b4-454d-b4fa-57869c45b6d6" ]
},
"invalid-params": {
"type": "array",
"description": "Validatiefouten gespecificeerd per veld",
"items": {
"$ref": "#/components/schemas/InvalidParam"
}
},
"status": {
"type": "integer",
"format": "int32",
"description": "De Http Response code.",
"examples": [ "400" ]
},
"title": {
"type": "string",
"description": "Een korte leesbare melding die aangeeft wat er niet gelukt is",
"examples": [ "Actieverzoeken ophalen is mislukt" ]
},
"type": {
"type": "string",
"description": "URI van het type van de fout",
"examples": [ "https://content.omgevingswet.overheid.nl/fout/id/concept/ValidatieFout" ]
}
}
},
"EventMetadata": {
"type": "object",
"description": "Metadata van toepassing op elk type event.",
"discriminator": {
"propertyName": "eventObjectType"
},
"oneOf": [ {
"$ref": "#/components/schemas/ActieverzoekEvent"
}, {
"$ref": "#/components/schemas/BerichtEvent"
}, {
"$ref": "#/components/schemas/DeelnemerEvent"
}, {
"$ref": "#/components/schemas/DocumentEvent"
}, {
"$ref": "#/components/schemas/SamenwerkingEvent"
} ],
"properties": {
"eventDatumTijd": {
"type": "string",
"format": "date-time",
"description": "Tijdstip waarop het event plaatsvond.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"eventInitiatorId": {
"type": "string",
"description": "Het OIN van de organisatie die het event gestart is. Deze waarde is leeg als het systeem het event gestart is."
},
"eventInitiatorNaam": {
"type": "string",
"description": "De naam van de organisatie die het event gestart is. Deze waarde is leeg als het systeem het event gestart is."
},
"eventObjectType": {
"type": "string",
"description": "Objecttype van het gewijzigde object",
"enum": [ "SAMENWERKING", "DEELNEMER", "ACTIEVERZOEK", "DOCUMENT", "BERICHT" ]
},
"eventType": {
"type": "string",
"description": "Soort event",
"enum": [ "CREATE", "UPDATE", "DELETE" ]
}
}
},
"EventTrail": {
"type": "object",
"description": "Een gepagineerde lijst events.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventMetadata"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"InvalidParam": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "De naam van het veld of parameter waarvan de waarde niet geaccepteerd is",
"examples": [ "actieVerzoekStatus" ]
},
"reason": {
"type": "string",
"description": "De reden dat het niet geaccepteerd is",
"examples": [ "De status 'GEWEIGERD' is niet bekend" ]
},
"type": {
"type": "string",
"description": "URI van het type van de fout",
"examples": [ "https://content.omgevingswet.overheid.nl/fout/id/concept/Status" ]
}
}
},
"KetenpartnerDetails": {
"type": "object",
"description": "Details van een ketenpartner.",
"properties": {
"id": {
"type": "string",
"description": "De identificatie van een ketenpartner (OIN of HRN)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"naam": {
"type": "string",
"description": "De naam van de ketenpartner.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
}
}
},
"Link": {
"type": "object",
"properties": {
"deprecation": {
"type": "string"
},
"href": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"name": {
"type": "string"
},
"profile": {
"type": "string"
},
"templated": {
"type": "boolean"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"Links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
}
},
"NotStringParameter": {
"type": "object",
"properties": {
"not": {
"type": "string"
}
}
},
"Notificatie": {
"type": "object",
"description": "Een notificatie over een samenwerkingsgebeurtenis",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"deelnemer": {
"type": "string",
"description": "De organisatieId van de gebruiker die deze notificatie ontvangt.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"deelnemerNaam": {
"type": "string",
"description": "De naam van de gebruiker die deze notificatie ontvangt.",
"examples": [ "Gemeente Bosrijk" ],
"maxLength": 200,
"minLength": 1
},
"eventDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De (Nederlandse) datum en tijd van de gebeurtenis waar de notificatie over gaat.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"eventInitiator": {
"type": "string",
"description": "De organisatieId van de gebruiker die een actie heeft uitgevoerd met deze notificatie tot gevolg.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"eventInitiatorNaam": {
"type": "string",
"description": "De naam van de gebruiker die een actie heeft uitgevoerd met deze notificatie tot gevolg.",
"examples": [ "Gemeente Woudrichem" ],
"maxLength": 200,
"minLength": 1
},
"notificatieId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van de notificatie",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"notificatieTekst": {
"type": "string",
"description": "De detailtekst van de notificatie.",
"examples": [ "Gemeente Rotterdam heeft adviesrapport.pdf toegevoegd" ],
"maxLength": 6144,
"minLength": 1
},
"notificatieTitel": {
"type": "string",
"description": "De titel van de notificatie.",
"examples": [ "Document geüpload" ],
"maxLength": 200,
"minLength": 1
},
"notificatieType": {
"type": "string",
"description": "Het type notificatie."
},
"properties": {
"$ref": "#/components/schemas/NotificatieProperties"
},
"samenwerkVorm": {
"type": "string",
"description": "De vorm van de samenwerking."
},
"samenwerkingId": {
"type": "string",
"description": "De identificatie van de samenwerking waar deze notificatie betrekking op heeft.",
"examples": [ "SAM-12345" ],
"maxLength": 20,
"minLength": 5
}
}
},
"NotificatieList": {
"type": "object",
"description": "Een gepagineerde lijst notificaties.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"notificaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Notificatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"NotificatieProperties": {
"type": "object",
"properties": {
"actieverzoekId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van een actieverzoek. Dit veld is van toepassing voor notificaties van het type:\n* STATUS_ACTIEVERZOEK_GEWIJZIGD",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"actieverzoekStatusNieuw": {
"type": "string",
"description": "De status van het actieverzoek in de notificatie na de wijziging. Dit veld is van toepassing voor notificaties van het type:\n* STATUS_ACTIEVERZOEK_GEWIJZIGD",
"examples": [ "IN_BEHANDELING" ],
"maxLength": 50,
"minLength": 1
},
"actieverzoekStatusOud": {
"type": "string",
"description": "De status van het actieverzoek in de notificatie voor de wijziging. Dit veld is van toepassing voor notificaties van het type:\n* STATUS_ACTIEVERZOEK_GEWIJZIGD",
"examples": [ "OPEN" ],
"maxLength": 50,
"minLength": 1
},
"actieverzoekTitel": {
"type": "string",
"description": "De titel van een actieverzoek. Dit veld is van toepassing voor notificaties van het type:\n* STATUS_ACTIEVERZOEK_GEWIJZIGD",
"examples": [ "Adviesaanvraag aanleg dakkapel Zuiderhagen" ],
"maxLength": 200,
"minLength": 1
},
"berichtId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van een bericht. Dit veld is van toepassing voor notificaties van het type:\n* NIEUW_BERICHT",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"documentId": {
"type": "string",
"format": "uuid",
"description": "De identificatie van een document. Dit veld is van toepassing voor notificaties van het type:\n* DOCUMENT_TOEGEVOEGD\n* DOCUMENT_GEWIJZIGD\n* DOCUMENT_VERWIJDERD\n* RECHTEN_OP_DOCUMENT_AANGEPAST",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
},
"documentNaam": {
"type": "string",
"description": "De bestandsnaam van een document. Dit veld is van toepassing voor notificaties van het type:\n* DOCUMENT_TOEGEVOEGD\n* DOCUMENT_GEWIJZIGD\n* DOCUMENT_VERWIJDERD\n* RECHTEN_OP_DOCUMENT_AANGEPAST",
"examples": [ "Advies aanleg dakkapel.docx" ],
"maxLength": 256,
"minLength": 1
},
"duurInactiviteit": {
"type": "string",
"format": "date-time",
"description": "De duur waarin geen wijziging heeft plaatsgevonden op de samenwerking.\nDit is een vaste duur, bepaald aan de hand van de periode van inactiviteit waarna een notificatie verstuurd wordt\nen de periode van inactiviteit waarna de samenwerking verwijderd wordt (bijvoorbeeld 1 maand, 4 maanden -> 3 maanden).\nAlleen van toepassing voor notificaties van het type SAMENWERKING_WORDT_GESLOTEN.\n",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"privilege": {
"type": "string",
"description": "Het nieuw verkregen privilege binnen een samenwerking. Dit veld is van toepassing voor notificaties van het type:\n* KETENPARTNER_VERWIJDERD\n* PRIVILEGE_VOOR_KETENPARTNER_AANGEPAST\n* SAMENWERKING_OPGEHAALD\n* UITNODIGING_KETENPARTNER\n\nDe verschillende waarden hebben de volgende betekenis:\n* VT - Volledige toegang, toegang tot alle documenten in het samenwerkdossier. \n* BT - Beperkte toegang, toegang tot documenten in het samenwerkdossier die geen persoonsgegevens en/of bedrijfsgevoelige gegevens bevatten.\n * INITIATOR - Volledige toegang en rechten om het dossier en alle documenten te wijzigen of te verwijderen.",
"examples": [ "BT" ]
},
"rechten": {
"type": "string",
"description": "De nieuw verkregen rechten voor een document. Dit veld is van toepassing voor notificaties van het type RECHTEN_OP_DOCUMENT_AANGEPAST.\nDe verschillende waarden hebben de volgende betekenis:\n* N - Geen rechten\n* R - Leesrechten\n* RUD - Lees- en wijzigrechten",
"enum": [ "N", "R", "RUD" ],
"examples": [ "RUD" ]
},
"samenwerkingNaam": {
"type": "string",
"description": "De titel van een samenwerking. Dit veld is van toepassing voor notificaties van het type:\n* BEWAARTERMIJN_VERLENGD\n* BERICHT_VERSTUURD\n* EINDE_BEWAARTERMIJN_NADERT\n* INITIATOR_GEWIJZIGD\n* KETENPARTNER_VERWIJDERD\n* PRIVILEGE_VOOR_KETENPARTNER_AANGEPAST\n* RECHTEN_OP_DOCUMENT_AANGEPAST\n* SAMENWERKING_GEWIJZIGD\n* SAMENWERKING_GESTOPT\n* SAMENWERKING_OPGEHAALD\n* SAMENWERKING_VERWIJDERD\n* STATUS_ACTIEVERZOEK_GEWIJZIGD\n* UITNODIGING_KETENPARTNER\n* VERZOEK_OPHALEN_GESLAAGD\n* VERZOEK_OPHALEN_MISLUKT",
"examples": [ "Behandeling verzoek bewoners Zuiderhagen" ],
"maxLength": 200,
"minLength": 1
},
"sluitDatum": {
"type": "string",
"format": "date-time",
"description": "Het (Nederlandse) tijdstip waarop de samenwerking gesloten zal worden. Dit veld is van toepassing voor alle notificaties waarvan de samenwerking bestaat\n",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"verwijderDatum": {
"type": "string",
"format": "date-time",
"description": "Het (Nederlandse) tijdstip waarop de samenwerking verloopt en verwijderd zal worden. Dit veld is van toepassing voor notificaties van het type:\n* EINDE_BEWAARTERMIJN_NADERT\n* SAMENWERKING_VERWIJDERD",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"verzoeknummer": {
"type": "string",
"description": "Het verzoeknummer van het aan de samenwerking gekoppelde verzoek. Dit veld is van toepassing voor notificaties van het type:\n* BEWAARTERMIJN_VERLENGD\n* BERICHT_VERSTUURD\n* EINDE_BEWAARTERMIJN_NADERT\n* INITIATOR_GEWIJZIGD\n* KETENPARTNER_VERWIJDERD\n* PRIVILEGE_VOOR_KETENPARTNER_AANGEPAST\n* RECHTEN_OP_DOCUMENT_AANGEPAST\n* SAMENWERKING_GEWIJZIGD\n* SAMENWERKING_GESTOPT\n* SAMENWERKING_OPGEHAALD\n* SAMENWERKING_VERWIJDERD\n* STATUS_ACTIEVERZOEK_GEWIJZIGD\n* UITNODIGING_KETENPARTNER\n* VERZOEK_OPHALEN_GESLAAGD\n* VERZOEK_OPHALEN_MISLUKT\n\nmaar zal alleen ingevuld zijn wanneer de betreffende samenwerking daadwerkelijk gekoppeld is aan een verzoek.",
"examples": [ "12345678" ],
"maxLength": 80,
"minLength": 1
}
}
},
"OpdrachtgevendeOrganisatie": {
"type": "object",
"description": "Een organisatie die een samenwerkingsverband is aangegaan met een behandelorganisatie.",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"id": {
"type": "string",
"description": "De identificatie van de opdrachtgevende organisatie (OIN of HRN)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"naam": {
"type": "string",
"description": "De naam van de opdrachtgevende organisatie",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
}
}
},
"Organisatie": {
"type": "object",
"description": "Een organisatie zoals gedefinieerd in het OIN-register",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"id": {
"type": "string",
"description": "De identificatie van een organisatie (OIN of HRN)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"laatstGezien": {
"type": "string",
"format": "date-time",
"description": "De laatste keer dat deze organisatie een lijst met samenwerkingen heeft opgehaald.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"naam": {
"type": "string",
"description": "De naam van een organisatie",
"examples": [ "Gemeente Rotterdam" ]
}
},
"required": [ "id", "naam" ]
},
"OrganisatieId": {
"type": "object",
"description": "Gebruikt bij het aanmaken van autorisaties.",
"properties": {
"id": {
"type": "string",
"description": "De identificatie van een organisatie (OIN of HRN)",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
}
},
"required": [ "id" ]
},
"OrganisatieList": {
"type": "object",
"description": "Een gepagineerde lijst organisaties.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"organisaties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organisatie"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"PageMetadata": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int64"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int64"
}
}
},
"PostActieverzoekDocument": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"format": "uuid",
"description": "De identifier van het document in het samenwerkdossier dat gekoppeld wordt aan het actieverzoek.",
"examples": [ "7a749408-3bd8-11eb-adc1-0242ac120002" ]
}
},
"required": [ "documentId" ]
},
"Samenwerking": {
"type": "object",
"description": "Een samenwerking met alle beschikbare metadata (zonder onderliggende objecten)",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"aangemaaktDoor": {
"type": "string",
"description": "De organisatieId van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"aangemaaktDoorNaam": {
"type": "string",
"description": "De naam van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"aantalActieverzoeken": {
"type": "integer",
"format": "int32",
"description": "Aantal openstaande actieverzoeken voor de gebruiker. \nDit veld wordt alleen teruggegeven bij het ophalen van een lijst van samenwerkingen.",
"examples": [ "1" ]
},
"aantalNotificaties": {
"type": "integer",
"format": "int32",
"description": "Aantal notificaties voor de gebruiker. \nDit veld wordt alleen teruggegeven bij het ophalen van een lijst van samenwerkingen.",
"examples": [ "1" ]
},
"beschrijving": {
"type": "string",
"description": "Beschrijving van de samenwerking.",
"examples": [ "Discussie omtrent wenselijkheid dakkapellen in deze buurt" ],
"maxLength": 6144,
"minLength": 1
},
"bronVerzoek": {
"type": "string",
"description": "Bron van het verzoek: DSO_LV of OLO. Als bij het aanmaken van een samenwerking op basis van een verzoek 1 verzoeknummer is ingevuld, kan de bron daaruit worden afgeleid en mag bronVerzoek leeg worden gelaten.",
"enum": [ "DSO_LV", "OLO" ]
},
"contactpersoonEmailadres": {
"type": "string",
"description": "Het e-mailadres van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "e.dijkstra@samenwerken.nl" ],
"maxLength": 256
},
"contactpersoonNaam": {
"type": "string",
"description": "De naam van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "E. Dijkstra" ],
"maxLength": 200
},
"contactpersoonTelefoonnummer": {
"type": "string",
"description": "Het telefoonnummer van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "0612345678" ],
"maxLength": 20
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De creatiedatum en -tijd van de samenwerking.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"eindDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en -tijd waarop de samenwerking verwijderd zal gaan worden.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"globaleLocatie": {
"type": "string",
"description": "Globale locatie van het verzoek.",
"examples": [ "Tunnelstraatweg 7, 1234AB Gouda" ],
"maxLength": 200
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80
},
"laatstAangepastDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De datum en tijd van de laatste aanpassing in de samenwerking.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"laatstAangepastDoor": {
"type": "string",
"description": "De organisatieId van de ketenpartner die de laatste aanpassing heeft gemaakt in de samenwerking.",
"examples": [ "00000001003214412000" ],
"pattern": "\\d{20}"
},
"laatstAangepastDoorNaam": {
"type": "string",
"description": "De naam van de ketenpartner die de laatste aanpassing heeft gemaakt in de samenwerking.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het nummer van de samenwerking binnen de organisatie van de initiator.",
"examples": [ "ZS-000-123" ],
"maxLength": 80
},
"oloVerzoeknummer": {
"type": "string",
"description": "Het nummer van het OLO-verzoek. Kan niet worden gebruikt i.c.m. DSO-verzoeknummer. Als het ingevuld is, moet bronVerzoek OLO zijn of leeg worden gelaten.",
"examples": [ "0000001" ],
"pattern": "(?=^\\d{7}$)\\d*[1-9]"
},
"samenwerkDoel": {
"type": "string",
"description": "Het doel van de samenwerking, de default waarde is 'BEHANDELEN'.",
"enum": [ "CONCEPTVERZOEK", "BEHANDELEN", "TOEZICHT_EN_HANDHAVING" ]
},
"samenwerkVorm": {
"type": "string",
"description": "De vorm van de samenwerking.",
"enum": [ "SAMENWERKEN_AAN_BEHANDELEN", "SAMENWERKEN_AAN_TOEZICHT_EN_HANDHAVING" ]
},
"samenwerkingId": {
"type": "string",
"description": "Een door het systeem gegenereerd unieke identificatie van de samenwerking.\nDit ID wordt gebruikt bij het doen van mutaties op een samenwerking.",
"examples": [ "SAM-1" ],
"maxLength": 20,
"minLength": 5
},
"status": {
"type": "string",
"description": "De status van de samenwerking.",
"enum": [ "INITIALISATIE", "OPEN", "GESLOTEN" ]
},
"taal": {
"type": "string",
"description": "De taal van de samenwerking.",
"examples": [ "Nederlands" ],
"maxLength": 80,
"minLength": 1
},
"titel": {
"type": "string",
"description": "De naam van de samenwerking.",
"examples": [ "Voorbeeld samenwerking" ],
"maxLength": 200,
"minLength": 1
},
"typeVerzoek": {
"type": "string",
"description": "Het type van het verzoek. Bij een DSO-verzoek is de waarde leeg of één van de volgende waarden:\n* 'Aanvraag vergunning' (de default)\n* 'Melding'\n* 'Informatie'\n* 'Informatie ongewoon voorval'\n* 'Aanvraag maatwerkvoorschrift'\n* 'Melding gelijkwaardige maatregel'\n* 'Aanvraag toestemming gelijkwaardige maatregel'\n",
"examples": [ "Informatie ongewoon voorval" ],
"maxLength": 80
},
"verzoeknummer": {
"type": "string",
"description": "Verzoeknummer van de samenwerking. Kan niet worden gebruikt i.c.m. OLO-verzoeknummer. Als het ingevuld is, moet bronVerzoek DSO_LV zijn of leeg worden gelaten.",
"examples": [ "1234567890123" ],
"pattern": "\\d{13}"
}
}
},
"SamenwerkingEvent": {
"allOf": [ {
"$ref": "#/components/schemas/EventMetadata"
}, {
"type": "object",
"properties": {
"aangemaaktDoor": {
"type": "string",
"description": "De organisatieId van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "00000001821699180000" ],
"pattern": "\\d{20}"
},
"aangemaaktDoorNaam": {
"type": "string",
"description": "De naam van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "Gemeente Rotterdam" ],
"maxLength": 200,
"minLength": 1
},
"beschrijving": {
"type": "string",
"description": "Beschrijving van de samenwerking.",
"examples": [ "Discussie omtrent wenselijkheid dakkapellen in deze buurt" ],
"maxLength": 6144,
"minLength": 1
},
"contactpersoonEmailadres": {
"type": "string",
"description": "Het e-mailadres van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "e.dijkstra@samenwerken.nl" ],
"maxLength": 256
},
"contactpersoonNaam": {
"type": "string",
"description": "De naam van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "E. Dijkstra" ],
"maxLength": 200
},
"contactpersoonTelefoonnummer": {
"type": "string",
"description": "Het telefoonnummer van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "0612345678" ],
"maxLength": 20
},
"creatieDatumTijd": {
"type": "string",
"format": "date-time",
"description": "De creatiedatum en -tijd van de samenwerking.",
"examples": [ "2024-01-31T23:59:59.999+01:00" ]
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het nummer van de samenwerking binnen de organisatie van de initiator.",
"examples": [ "ZS-000-123" ],
"maxLength": 80
},
"samenwerkDoel": {
"type": "string",
"description": "Het doel van de samenwerking, de default waarde is 'BEHANDELEN'.",
"enum": [ "CONCEPTVERZOEK", "BEHANDELEN", "TOEZICHT_EN_HANDHAVING" ]
},
"samenwerkVorm": {
"type": "string",
"description": "De vorm van de samenwerking.",
"enum": [ "SAMENWERKEN_AAN_BEHANDELEN", "SAMENWERKEN_AAN_TOEZICHT_EN_HANDHAVING" ]
},
"samenwerkingId": {
"type": "string",
"description": "Een door het systeem gegenereerd unieke identificatie van de samenwerking.\nDit ID wordt gebruikt bij het doen van mutaties op een samenwerking.",
"examples": [ "SAM-1" ],
"maxLength": 20,
"minLength": 5
},
"status": {
"type": "string",
"description": "De status van de samenwerking.",
"enum": [ "INITIALISATIE", "OPEN", "GESLOTEN" ]
},
"taal": {
"type": "string",
"description": "De taal van de samenwerking.",
"examples": [ "Nederlands" ],
"maxLength": 80,
"minLength": 1
},
"titel": {
"type": "string",
"description": "De naam van de samenwerking.",
"examples": [ "Voorbeeld samenwerking" ],
"maxLength": 200,
"minLength": 1
},
"typeVerzoek": {
"type": "string",
"description": "Het type van het verzoek. Bij een DSO-verzoek is de waarde leeg of één van de volgende waarden:\n* 'Aanvraag vergunning' (de default)\n* 'Melding'\n* 'Informatie'\n* 'Informatie ongewoon voorval'\n* 'Aanvraag maatwerkvoorschrift'\n* 'Melding gelijkwaardige maatregel'\n* 'Aanvraag toestemming gelijkwaardige maatregel'\n",
"examples": [ "Informatie ongewoon voorval" ],
"maxLength": 80
},
"verzoeknummer": {
"type": "string",
"description": "Verzoeknummer van de samenwerking. Kan niet worden gebruikt i.c.m. OLO-verzoeknummer. Als het ingevuld is, moet bronVerzoek DSO_LV zijn of leeg worden gelaten.",
"examples": [ "1234567890123" ],
"pattern": "\\d{13}"
}
}
} ],
"description": "Een mutatie op een samenwerking."
},
"SamenwerkingenList": {
"type": "object",
"description": "Een gepagineerde lijst samenwerkingen.",
"properties": {
"_embedded": {
"type": "object",
"properties": {
"samenwerkingen": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Samenwerking"
}
}
}
},
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"Samenwerkingsverband": {
"type": "object",
"description": "Een samenwerkingsverband die twee organisaties met elkaar zijn aangegaan.",
"properties": {
"behandelOrganisatie": {
"$ref": "#/components/schemas/Organisatie"
},
"opdrachtgevendeOrganisatie": {
"$ref": "#/components/schemas/Organisatie"
}
}
},
"UpdateActieverzoek": {
"type": "object",
"description": "De nieuwe gegevens van het te wijzigen actieverzoek.",
"properties": {
"melding": {
"type": "string",
"description": "De melding bij gereedmelden / intrekken actieverzoek.",
"examples": [ "Het gevraagde advies is toegevoegd aan het dossier" ],
"maxLength": 6144,
"minLength": 0
},
"omschrijving": {
"type": "string",
"description": "De omschrijving van het actieverzoek.",
"examples": [ "Graag het advies toevoegen aan het dossier" ],
"maxLength": 6144,
"minLength": 0
},
"productId": {
"type": "string",
"description": "De productId van het product in de PDC waar actieverzoek betrekking op heeft.",
"examples": [ "urn:advies:12345" ],
"maxLength": 2048,
"minLength": 0
},
"status": {
"type": "string",
"description": "De gewenste status van het actieverzoek.",
"enum": [ "GEREEDGEMELD", "GEREED", "GEWEIGERD", "IN_BEHANDELING", "INGETROKKEN" ]
},
"titel": {
"type": "string",
"description": "De titel van het actieverzoek.",
"examples": [ "Advies toevoegen" ],
"maxLength": 80,
"minLength": 1
}
}
},
"UpdateActieverzoekDocumenten": {
"type": "object",
"properties": {
"documenten": {
"type": "array",
"description": "De volledige lijst van identifiers van relevante documenten in het samenwerkdossier die relevant zijn voor het te wijzigen actieverzoek. Documenten die voorheen gekoppeld waren aan het actieverzoek, maar niet in de opgegeven lijst staan, worden hiermee ontkoppeld van het actieverzoek.",
"examples": [ "[\"7a749408-3bd8-11eb-adc1-0242ac120002\", \"f5dc008c-47b4-454d-b4fa-57869c45b6d6\"]" ],
"items": {
"type": "string",
"format": "uuid",
"description": "De volledige lijst van identifiers van relevante documenten in het samenwerkdossier die relevant zijn voor het te wijzigen actieverzoek. Documenten die voorheen gekoppeld waren aan het actieverzoek, maar niet in de opgegeven lijst staan, worden hiermee ontkoppeld van het actieverzoek.",
"examples": [ "[\"7a749408-3bd8-11eb-adc1-0242ac120002\", \"f5dc008c-47b4-454d-b4fa-57869c45b6d6\"]" ]
},
"uniqueItems": true
}
}
},
"UpdateDocument": {
"type": "object",
"description": "Het aanpasbaar deel van de metadata van een document",
"properties": {
"bestandsNaam": {
"type": "string",
"description": "De bestandsnaam van het document.",
"examples": [ "Bouwtekening-dakkapel.jpg" ],
"maxLength": 256
},
"documentOmschrijving": {
"type": "string",
"description": "Een tekstuele beschrijving van het document.",
"examples": [ "Bouwtekeningen dakkapel B. Bolderbast incl. sterkteberekening" ],
"maxLength": 200,
"minLength": 1
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80,
"minLength": 0
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het identificerend nummer binnen een extern systeem.",
"examples": [ "ZS-000-123" ],
"maxLength": 80,
"minLength": 0
},
"vertrouwelijkheidsAanduiding": {
"type": "string",
"description": "De vertrouwelijkheidsaanduiding van het document.",
"enum": [ "SV", "RV" ]
}
}
},
"UpdateDocumentAutorisatie": {
"type": "object",
"description": "De toegangsrechten voor het document (toegestane waarden zijn: N (=geen rechten),R (=Leesrechten),RUD (=Lees- en wijzigrechten)).",
"properties": {
"rechten": {
"type": "string",
"enum": [ "N", "R", "RUD" ]
}
}
},
"UpdatePrivilegeKetenpartner": {
"type": "object",
"description": "Nieuw toe te kennen privilege voor betreffende organisatie.",
"properties": {
"privilege": {
"type": "string",
"description": "* VT - Volledige toegang, toegang tot alle documenten in het samenwerkdossier. \n* BT - Beperkte toegang, toegang tot documenten in het samenwerkdossier die geen persoonsgegevens en/of bedrijfsgevoelige gegevens bevatten.",
"enum": [ "VT", "BT" ]
}
}
},
"UpdateSamenwerking": {
"type": "object",
"description": "Nieuwe details van de samenwerking.",
"properties": {
"beschrijving": {
"type": "string",
"description": "Beschrijving van de samenwerking.",
"examples": [ "Discussie omtrent wenselijkheid dakkapellen in deze buurt" ],
"maxLength": 6144,
"minLength": 0
},
"bronVerzoek": {
"type": "string",
"description": "Bron van het verzoek: DSO_LV of OLO. Als bij het aanmaken van een samenwerking op basis van een verzoek 1 verzoeknummer is ingevuld, kan de bron daaruit worden afgeleid en mag bronVerzoek leeg worden gelaten.",
"enum": [ "DSO_LV", "OLO" ]
},
"contactpersoonEmailadres": {
"type": "string",
"description": "Het e-mailadres van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "e.dijkstra@samenwerken.nl" ],
"maxLength": 256,
"minLength": 0
},
"contactpersoonNaam": {
"type": "string",
"description": "De naam van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "E. Dijkstra" ],
"maxLength": 200,
"minLength": 0
},
"contactpersoonTelefoonnummer": {
"type": "string",
"description": "Het telefoonnummer van de contactpersoon van de ketenpartner die initiator is van de samenwerking.",
"examples": [ "0612345678" ],
"maxLength": 20,
"minLength": 0
},
"globaleLocatie": {
"type": "string",
"description": "Globale locatie van het verzoek.",
"examples": [ "Tunnelstraatweg 7, 1234AB Gouda" ],
"maxLength": 200,
"minLength": 0
},
"kenmerkSysteem": {
"type": "string",
"description": "Het kenmerk van een extern systeem.",
"examples": [ "zaaksysteem Rotterdam" ],
"maxLength": 80,
"minLength": 0
},
"nummerBinnenSysteem": {
"type": "string",
"description": "Het nummer van de samenwerking binnen de organisatie van de initiator.",
"examples": [ "ZS-000-123" ],
"maxLength": 80,
"minLength": 0
},
"oloVerzoeknummer": {
"type": "string",
"description": "Het nummer van het OLO-verzoek. Kan niet worden gebruikt i.c.m. DSO-verzoeknummer. Als het ingevuld is, moet bronVerzoek OLO zijn of leeg worden gelaten.",
"examples": [ "0000001" ],
"pattern": "(?=^\\d{7}$)\\d*[1-9]"
},
"status": {
"type": "string",
"description": "De status van de samenwerking.",
"enum": [ "OPEN", "GESLOTEN" ]
},
"titel": {
"type": "string",
"description": "De naam van de samenwerking.",
"examples": [ "Voorbeeld samenwerking" ],
"maxLength": 200,
"minLength": 1
},
"typeVerzoek": {
"type": "string",
"description": "Het type van het verzoek. Bij een DSO-verzoek is de waarde leeg of één van de volgende waarden:\n* 'Aanvraag vergunning' (de default)\n* 'Melding'\n* 'Informatie'\n* 'Informatie ongewoon voorval'\n* 'Aanvraag maatwerkvoorschrift'\n* 'Melding gelijkwaardige maatregel'\n* 'Aanvraag toestemming gelijkwaardige maatregel'\n",
"examples": [ "Informatie ongewoon voorval" ],
"maxLength": 80,
"minLength": 0
},
"verzoeknummer": {
"type": "string",
"description": "Verzoeknummer van de samenwerking. Kan niet worden gebruikt i.c.m. OLO-verzoeknummer. Als het ingevuld is, moet bronVerzoek DSO_LV zijn of leeg worden gelaten.",
"examples": [ "1234567890123" ],
"pattern": "\\d{13}"
}
}
},
"Verzoek": {
"type": "object",
"description": "De metadata van een verzoek",
"properties": {
"_links": {
"$ref": "#/components/schemas/Links",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links"
},
"samenwerkingId": {
"type": "string",
"description": "Een door het systeem gegenereerd unieke identificatie van de samenwerking.\nDit ID wordt gebruikt bij het doen van mutaties op een samenwerking.",
"examples": [ "SAM-1" ],
"maxLength": 20,
"minLength": 5
},
"stamversie": {
"type": "integer",
"format": "int32"
},
"verzoeknummer": {
"type": "string"
},
"volgnummer": {
"type": "string",
"description": "Volgnummer",
"examples": [ "001" ],
"maxLength": 3,
"minLength": 3,
"pattern": "^[0-9]{3}$"
}
}
},
"app-health": {
"type": "object",
"description": "Health-informatie over de API",
"properties": {
"status": {
"type": "string",
"description": "Geeft aan of de API up is",
"enum": [ "UP", "DOWN" ]
}
}
},
"app-info": {
"type": "object",
"description": "Metadata over de API",
"properties": {
"apiVersion": {
"type": "string",
"description": "De API-versie"
},
"buildVersion": {
"type": "string",
"description": "De versie van de build"
},
"description": {
"type": "string",
"description": "Een korte omschrijving van de API"
},
"name": {
"type": "string",
"description": "De naam van de API"
}
}
}
}
}
}