Files
atomic-design-poc/backend/swagger.json
Edwin van den Houdt 7ec13d8b59 feat(brief): WP-18 — ABAC capability spine (PRD-0002 phase P1)
Replace the FE-computed authorization anti-pattern in BriefStore.editable
(derived from the unverified X-Role header) with server-computed decision
flags, mirroring the existing HerregistratieDecisionsDto pattern:

- Backend: Authz.cs is the single authorization helper — the SAME check
  (Authz.CanActOn) both gates BriefStore.Review's mutations and computes
  the BriefDecisionsDto flags shipped on every brief response, so emit
  and enforce can never drift. New GET /me returns coarse, role-derived
  capabilities (PRD-0002 SS6).
- Every brief endpoint (including send, previously ungated on HttpContext)
  now returns a fresh BriefViewDto so decisions never go stale after a
  mutation.
- FE: brief.store.ts reads canEdit/canApprove/canReject/canSend off the
  loaded decisions instead of computing them from currentRole(); the
  brief.machine carries decisions through every status transition.
- New shared/domain/capability.ts + shared/application/access.store.ts +
  shared/infrastructure/me.adapter.ts: the general capability-spine
  infrastructure (AccessStore.can(), capabilityGuard) for future routes.

Deviates from the original WP-18 draft by NOT renaming auth/domain's
Session to a Principal union — ADR-0002 explicitly defers that refactor
until a second actor exists, and the brief workflow's drafter/approver
identity turned out to be a separate axis from the SSP login session
entirely. See docs/backlog/WP-18-abac-capability-spine.md for the full
as-built record.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-03 20:31:53 +02:00

1858 lines
45 KiB
JSON

{
"openapi": "3.0.4",
"info": {
"title": "BIG-register BFF",
"version": "v1"
},
"paths": {
"/health": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/health/ready": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/dashboard-view": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardViewDto"
}
}
}
}
}
}
},
"/api/v1/notes": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AantekeningDto"
}
}
}
}
}
}
}
},
"/api/v1/brp/address": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrpAddressDto"
}
}
}
}
}
}
},
"/api/v1/duo/diplomas": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuoLookupDto"
}
}
}
}
}
}
},
"/api/v1/intake/policy": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntakePolicyDto"
}
}
}
}
}
}
},
"/api/v1/registrations": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistratieRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/herregistraties": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HerregistratieRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/intakes": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntakeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/change-requests": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeRequestRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/uploads/categories": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "wizardId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "diplomaHerkomst",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "taalvaardigheid",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadCategoriesDto"
}
}
}
}
}
}
},
"/api/v1/uploads/{documentId}/content": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/uploads/status": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "localIds",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadStatusDto"
}
}
}
}
}
}
},
"/api/v1/uploads/{documentId}": {
"delete": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/admin/uploads/{documentId}": {
"delete": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/applications": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationSummaryDto"
}
}
}
}
}
}
},
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApplicationRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationDetailDto"
}
}
}
}
}
}
},
"/api/v1/applications/{id}": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationDetailDto"
}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"put": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftSyncRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/applications/{id}/submit": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitApplicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitApplicationResponse"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/v1/me": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeDto"
}
}
}
}
}
}
},
"/api/v1/brief": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
}
}
},
"put": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveBriefRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/brief/submit": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"operationId": "briefSubmit",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/brief/approve": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/brief/reject": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RejectBriefRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/brief/send": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/brief/reset": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"operationId": "briefReset",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BriefViewDto"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AantekeningDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"omschrijving": {
"type": "string",
"nullable": true
},
"datum": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AanvraagStatusDto": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"nullable": true
},
"stepIndex": {
"type": "integer",
"format": "int32",
"nullable": true
},
"stepCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"referentie": {
"type": "string",
"nullable": true
},
"manual": {
"type": "boolean",
"nullable": true
},
"reden": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AdresDto": {
"type": "object",
"properties": {
"straat": {
"type": "string",
"nullable": true
},
"postcode": {
"type": "string",
"nullable": true
},
"woonplaats": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ApplicationDetailDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/AanvraagStatusDto"
},
"draft": {
"nullable": true
},
"documentIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"createdAt": {
"type": "string",
"nullable": true
},
"updatedAt": {
"type": "string",
"nullable": true
},
"submittedAt": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ApplicationSummaryDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/AanvraagStatusDto"
},
"documentIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"createdAt": {
"type": "string",
"nullable": true
},
"updatedAt": {
"type": "string",
"nullable": true
},
"submittedAt": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BriefDecisionsDto": {
"type": "object",
"properties": {
"canEdit": {
"type": "boolean"
},
"canApprove": {
"type": "boolean"
},
"canReject": {
"type": "boolean"
},
"canSend": {
"type": "boolean"
}
},
"additionalProperties": false
},
"BriefDto": {
"type": "object",
"properties": {
"briefId": {
"type": "string",
"nullable": true
},
"beroep": {
"type": "string",
"nullable": true
},
"templateId": {
"type": "string",
"nullable": true
},
"placeholders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlaceholderDefDto"
},
"nullable": true
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LetterSectionDto"
},
"nullable": true
},
"status": {
"$ref": "#/components/schemas/BriefStatusDto"
},
"drafterId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BriefStatusDto": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"nullable": true
},
"submittedBy": {
"type": "string",
"nullable": true
},
"submittedAt": {
"type": "string",
"nullable": true
},
"approvedBy": {
"type": "string",
"nullable": true
},
"approvedAt": {
"type": "string",
"nullable": true
},
"rejectedBy": {
"type": "string",
"nullable": true
},
"rejectedAt": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"sentAt": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BriefViewDto": {
"type": "object",
"properties": {
"brief": {
"$ref": "#/components/schemas/BriefDto"
},
"availablePassages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryPassageDto"
},
"nullable": true
},
"decisions": {
"$ref": "#/components/schemas/BriefDecisionsDto"
}
},
"additionalProperties": false
},
"BrpAddressDto": {
"type": "object",
"properties": {
"gevonden": {
"type": "boolean"
},
"adres": {
"$ref": "#/components/schemas/AdresDto"
}
},
"additionalProperties": false
},
"ChangeRequestRequest": {
"type": "object",
"properties": {
"straat": {
"type": "string",
"nullable": true
},
"postcode": {
"type": "string",
"nullable": true
},
"woonplaats": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreateApplicationRequest": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DashboardViewDto": {
"type": "object",
"properties": {
"registration": {
"$ref": "#/components/schemas/RegistrationDto"
},
"person": {
"$ref": "#/components/schemas/PersonDto"
},
"decisions": {
"$ref": "#/components/schemas/HerregistratieDecisionsDto"
}
},
"additionalProperties": false
},
"DocumentCategoryDto": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"required": {
"type": "boolean"
},
"acceptedTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"maxSizeMb": {
"type": "integer",
"format": "int32"
},
"multiple": {
"type": "boolean"
},
"allowPostDelivery": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DocumentRefDto": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"nullable": true
},
"channel": {
"type": "string",
"nullable": true
},
"documentId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DraftSyncRequest": {
"type": "object",
"properties": {
"draft": { },
"stepIndex": {
"type": "integer",
"format": "int32"
},
"stepCount": {
"type": "integer",
"format": "int32"
},
"documentIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"DuoDiplomaDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"naam": {
"type": "string",
"nullable": true
},
"instelling": {
"type": "string",
"nullable": true
},
"jaar": {
"type": "integer",
"format": "int32"
},
"beroep": {
"type": "string",
"nullable": true
},
"policyQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyQuestionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DuoLookupDto": {
"type": "object",
"properties": {
"diplomas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DuoDiplomaDto"
},
"nullable": true
},
"handmatig": {
"$ref": "#/components/schemas/ManualDiplomaPolicyDto"
}
},
"additionalProperties": false
},
"HerregistratieDecisionsDto": {
"type": "object",
"properties": {
"eligibleForHerregistratie": {
"type": "boolean"
},
"herregistratieReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HerregistratieRequest": {
"type": "object",
"properties": {
"uren": {
"type": "integer",
"format": "int32"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRefDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"IntakePolicyDto": {
"type": "object",
"properties": {
"scholingThreshold": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IntakeRequest": {
"type": "object",
"properties": {
"uren": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"LetterBlockDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"blockId": {
"type": "string",
"nullable": true
},
"content": {
"$ref": "#/components/schemas/RichTextBlockDto"
},
"sourcePassageId": {
"type": "string",
"nullable": true
},
"sourceVersion": {
"type": "integer",
"format": "int32",
"nullable": true
},
"edited": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"LetterSectionDto": {
"type": "object",
"properties": {
"sectionKey": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"required": {
"type": "boolean"
},
"blocks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LetterBlockDto"
},
"nullable": true
},
"locked": {
"type": "boolean"
}
},
"additionalProperties": false
},
"LibraryPassageDto": {
"type": "object",
"properties": {
"passageId": {
"type": "string",
"nullable": true
},
"scope": {
"type": "string",
"nullable": true
},
"sectionKey": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"content": {
"$ref": "#/components/schemas/RichTextBlockDto"
},
"version": {
"type": "integer",
"format": "int32"
},
"beroep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ManualDiplomaPolicyDto": {
"type": "object",
"properties": {
"beroepen": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"policyQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyQuestionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"MeDto": {
"type": "object",
"properties": {
"capabilities": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ParagraphDto": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RichTextNodeDto"
},
"nullable": true
},
"list": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PersonDto": {
"type": "object",
"properties": {
"naam": {
"type": "string",
"nullable": true
},
"geboortedatum": {
"type": "string",
"nullable": true
},
"adres": {
"$ref": "#/components/schemas/AdresDto"
}
},
"additionalProperties": false
},
"PlaceholderDefDto": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"label": {
"type": "string",
"nullable": true
},
"autoResolvable": {
"type": "boolean"
},
"fillable": {
"type": "boolean",
"nullable": true
},
"deprecated": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"PolicyQuestionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"vraag": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ReferentieResponse": {
"type": "object",
"properties": {
"referentie": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RegistratieRequest": {
"type": "object",
"properties": {
"diplomaHerkomst": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRefDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RegistrationDto": {
"type": "object",
"properties": {
"bigNummer": {
"type": "string",
"nullable": true
},
"naam": {
"type": "string",
"nullable": true
},
"beroep": {
"type": "string",
"nullable": true
},
"registratiedatum": {
"type": "string",
"nullable": true
},
"geboortedatum": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/RegistrationStatusDto"
}
},
"additionalProperties": false
},
"RegistrationStatusDto": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"nullable": true
},
"herregistratieDatum": {
"type": "string",
"nullable": true
},
"geschorstTot": {
"type": "string",
"nullable": true
},
"reden": {
"type": "string",
"nullable": true
},
"doorgehaaldOp": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RejectBriefRequest": {
"type": "object",
"properties": {
"comments": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RichTextBlockDto": {
"type": "object",
"properties": {
"paragraphs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParagraphDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"RichTextNodeDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"marks": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"key": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SaveBriefRequest": {
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LetterSectionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"SubmitApplicationRequest": {
"type": "object",
"properties": {
"diplomaHerkomst": {
"type": "string",
"nullable": true
},
"uren": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentRefDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"SubmitApplicationResponse": {
"type": "object",
"properties": {
"referentie": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/AanvraagStatusDto"
}
},
"additionalProperties": false
},
"UploadCategoriesDto": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentCategoryDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"UploadStatusDto": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UploadStatusItemDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"UploadStatusItemDto": {
"type": "object",
"properties": {
"localId": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"documentId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"tags": [
{
"name": "BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
}
]
}