v1.json

{"openapi":"3.0.0","info":{"title":"Verzoeken-Afhandelen","description":"Tbv ophalen verzoek en wijzigen van het bevoegd gezag.\nHet ophalen van een reeds ingediend verzoek (aanvraag/melding). Een verzoek kan worden opgehaald door het opgeven van het verzoeknummer. Het opgehaalde verzoek bevat referenties naar documenten (formulieren en bijlagen).\nHet wijzigen van het bevoegd gezag voor een reeds ingediend verzoek (aanvraag/melding).","contact":{"name":"DSO Team PR12","url":"https://aandeslagmetdeomgevingswet.nl/ontwikkelaarsportaal/","email":"info@aandeslagmetdeomgevingswet.nl"},"version":"1.0.0"},"tags":[{"name":"Documenten","description":"Documentgerelateerde acties"},{"name":"Verzoeken","description":"Verzoekgerelateerde acties"}],"paths":{"/verzoeken/{verzoeknummer}":{"get":{"operationId":"haalVerzoekOp","summary":"Haalt een verzoek op.","description":"Haalt een reeds ingediend verzoek op met opgegeven 'verzoeknummer'.","tags":["Verzoeken"],"parameters":[{"name":"verzoeknummer","in":"path","description":"nummer van het verzoek","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Het verzoek","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/Verzoek"}}}},"401":{"description":"Gebruiker heeft geen toestemming om deze actie uit te voeren","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"404":{"description":"Verzoek niet gevonden","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}}},"delete":{"operationId":"verwijderVerzoek","summary":"Verwijdert het verzoek.","description":"Verwijdert het verzoek met opgegeven 'verzoeknummer' inclusief alle bijbehorende documenten.","tags":["Verzoeken"],"parameters":[{"name":"verzoeknummer","in":"path","description":"nummer van het verzoek","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Verzoek verwijderd"},"401":{"description":"Gebruiker heeft geen toestemming om deze actie uit te voeren","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"404":{"description":"Verzoek niet gevonden","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}}}},"/verzoeken/{verzoeknummer}/samenvatting":{"get":{"operationId":"haalVerzoeksamenvattingOp","summary":"Haalt de samenvatting van een verzoek op.","description":"Haalt de samenvatting van een reeds ingediend verzoek op met opgegeven 'verzoeknummer'.","tags":["Verzoeken"],"parameters":[{"name":"verzoeknummer","in":"path","description":"nummer van het verzoek","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"formaat van de samenvatting","required":true,"schema":{"type":"string","enum":["xml","pdf"]}}],"responses":{"200":{"description":"De verzoek samenvatting","content":{"application/xml":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Verzoek niet gevonden","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}}}},"/verzoeken/{verzoeknummer}/documenten/{documentId}":{"get":{"operationId":"haalMetadataVanDocumentOp","summary":"Haalt de metadata van een document bij een verzoek op.","description":"Haalt de metagegevens van een document op behorende bij het verzoek.","tags":["Documenten"],"parameters":[{"name":"verzoeknummer","in":"path","description":"nummer van het verzoek","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"id van het document","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"De documentgegevens","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"401":{"description":"Gebruiker heeft geen toestemming om deze actie uit te voeren","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"404":{"description":"Document niet gevonden","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}}}},"/verzoeken/{verzoeknummer}/documenten/{documentId}/content":{"get":{"operationId":"haalInhoudVanDocumentOp","summary":"Haalt de content van het document op.","description":"Geeft het daadwerkelijke bestand (content) terug van het opgegeven document. Dit kan een door de aanvrager toegevoegd document zijn of een formulier.","tags":["Documenten"],"parameters":[{"name":"verzoeknummer","in":"path","description":"nummer van het verzoek","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","description":"id van het document","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Content van het document","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Gebruiker heeft geen toestemming om deze actie uit te voeren","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"404":{"description":"Document niet gevonden","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}}}},"/verzoeken/{verzoeknummer}/bevoegdgezagen":{"patch":{"operationId":"wijzigenBevoegdGezag","summary":"Wijzigen van het bevoegd gezag bij een verzoek.","description":"Het wijzigen van een bevoegd gezag voor een verzoek op basis van de meegestuurde gegevens.","tags":["Verzoeken"],"parameters":[{"name":"verzoeknummer","in":"path","description":"het verzoeknummer","required":true,"schema":{"type":"string","maxLength":13,"example":2019090600002}}],"responses":{"204":{"description":"Wijzigen geslaagd"},"400":{"description":"Mogelijk foutsituaties:\n  - Het OIN van het nieuwe Bevoegd gezag is niet correct\n  - Het verzoek is ingetrokken","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"401":{"description":"U bent niet geautoriseerd voor dit verzoek","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"404":{"description":"Het verzoek bestaat niet","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}},"500":{"description":"Onverwachte fout","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AlgemeneFout"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BevoegdGezag"}}},"description":"Nieuwe OIN van het BevoegdGezag.","required":true}}}},"servers":[{"url":"https://service.pre.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v1"},{"url":"http://service.pre.omgevingswet.overheid.nl/overheid/verzoeken/api/afhandelen/v1"}],"components":{"schemas":{"AlgemeneFout":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int64"},"detail":{"type":"string"},"instance":{"type":"string"}},"example":{"type":"/fouten/server-fout","title":"Interne Server Fout","status":500,"detail":"Er komt rook uit de server. Probeer het later nog eens.","instance":"/verzoeken/123"}},"Verzoek":{"type":"object","required":["verzoeknummer"],"properties":{"verzoeknummer":{"type":"string"},"_embedded":{"type":"object","properties":{"documenten":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"verzoekXml":{"$ref":"#/components/schemas/Link"},"verzoekPdf":{"$ref":"#/components/schemas/Link"}}}},"example":{"verzoeknummer":"2017010100001","_embedded":{"documenten":[{"documentId":"51c4275449f3760f9cabad9e6c1478764e19be6802a900b188248b068403f912","metadata":{"bestandsnaam":"Tekening_van_de_uitbouw.pdf","vertrouwelijkAanduiding":"Vertrouwelijk","createdByUser":"Gebruiker DSO-LV","modifiedByUser":"Gebruiker DSO-LV","creatieapplicatie":"DSO-LV","documentOmschrijving":"Overig","formaat":"application/pdf"},"_links":{"self":{"href":"https://api.dso.nl/verzoeken/2017010100001/documenten/51c4275449f3760f9cabad9e6c1478764e19be6802a900b188248b068403f912"},"content":{"href":"https://api.dso.nl/verzoeken/2017010100001/documenten/51c4275449f3760f9cabad9e6c1478764e19be6802a900b188248b068403f912/content"}}}]},"_links":{"self":{"href":"https://api.dso.nl/verzoeken/2017010100001"},"verzoekXml":{"href":"https://api.dso.nl/verzoeken/2017010100001/samenvatting?format=xml"},"verzoekPdf":{"href":"https://api.dso.nl/verzoeken/2017010100001/samenvatting?format=pdf"}}}},"Document":{"type":"object","required":["id","documentId - metadata"],"properties":{"id":{"type":"integer"},"documentId":{"type":"string","maxLength":128},"metadata":{"description":"metadata","type":"object","required":["bestandsnaam","vertrouwelijkAanduiding","createdByUser","modifiedByUser","creatieapplicatie","documentOmschrijving","formaat"],"properties":{"bestandsnaam":{"type":"string"},"vertrouwelijkAanduiding":{"description":"geeft aan of het document als vertrouwelijk moet worden behandeld.","type":"string","enum":["Vertrouwelijk","Niet vertrouwelijk"]},"createdByUser":{"description":"algemene aanduiding voor gebruikers van DSO-LV","type":"string","enum":["Gebruiker DSO-LV"]},"modifiedByUser":{"description":"algemene aanduiding voor gebruikers van DSO-LV","type":"string","enum":["Gebruiker DSO-LV"]},"creatieapplicatie":{"description":"algemene aanduiding voor DSO-LV","type":"string","enum":["DSO-LV"]},"documentOmschrijving":{"description":"aanduiding van de aard van de gevraagde bijlage zoals gehanteerd door de zaakbehandelende organisatie, gebaseerd op 'documenttypeGeneriek'. Bevat een lege string als de documentOmschrijving niet bekend is.","type":"string"},"formaat":{"description":"het MIME-type","type":"string"}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"content":{"$ref":"#/components/schemas/Link"}}}},"example":{"documentId":"51c4275449f3760f9cabad9e6c1478764e19be6802a900b188248b068403f912","metadata":{"bestandsnaam":"Tekening_van_de_uitbouw.pdf","vertrouwelijkAanduiding":"Vertrouwelijk","createdByUser":"Gebruiker DSO-LV","modifiedByUser":"Gebruiker DSO-LV","creatieapplicatie":"DSO-LV","documentOmschrijving":"Overig","formaat":"application/pdf"},"_links":{"self":{"href":"https://api.dso.nl/verzoeken/2017010100001/documenten/1"},"content":{"href":"https://api.dso.nl/verzoeken/2017010100001/documenten/1/content"}}}},"BevoegdGezag":{"type":"object","required":["organisatieIdentificatieNummer"],"properties":{"organisatieIdentificatieNummer":{"type":"string","pattern":"^\\d{20}$"},"naam":{"type":"string","maxLength":128,"deprecated":true}},"example":{"organisatieIdentificatieNummer":"00000000000123456789","naam":"Provincie Zuid-Holland"}},"Link":{"required":["href"],"properties":{"href":{"type":"string"}},"example":{"href":"https://api.dso.nl/verzoeken/2017010100001"}}},"securitySchemes":{"default":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":" ","scopes":{}}}}}}}