459 lines
9.6 KiB
JSON
459 lines
9.6 KiB
JSON
{
|
|
"openapi": "3.1.1",
|
|
"info": {
|
|
"title": "Bff.Api | v1",
|
|
"version": "1.0.0"
|
|
},
|
|
"paths": {
|
|
"/self-service/registrations": {
|
|
"post": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"responses": {
|
|
"202": {
|
|
"description": "Accepted",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SubmitAccepted"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CurrentRegistration"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"204": {
|
|
"description": "No Content"
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self-service/registrations/{id}/withdraw": {
|
|
"post": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "No Content"
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/self-service/registrations/{id}/documents": {
|
|
"post": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProvideDocumentsRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "No Content"
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not Found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/openbaar/register": {
|
|
"get": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "q",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/OpenbaarEntry"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/behandel/werkbak": {
|
|
"get": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/WerkbakItem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/behandel/registrations/{id}/decide": {
|
|
"post": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DecideRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "No Content"
|
|
},
|
|
"400": {
|
|
"description": "Bad Request"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/beheer/catalogi/zaaktypen": {
|
|
"get": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/BeheerZaaktype"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/beheer/default-fill": {
|
|
"get": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BeheerDefaultFill"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Bff.Api"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BeheerDefaultFill"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "No Content"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"403": {
|
|
"description": "Forbidden"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"BeheerDefaultFill": {
|
|
"required": [
|
|
"bronorganisatie",
|
|
"verantwoordelijkeOrganisatie",
|
|
"vertrouwelijkheidaanduiding"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"bronorganisatie": {
|
|
"type": "string"
|
|
},
|
|
"verantwoordelijkeOrganisatie": {
|
|
"type": "string"
|
|
},
|
|
"vertrouwelijkheidaanduiding": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"BeheerZaaktype": {
|
|
"required": [
|
|
"identificatie",
|
|
"omschrijving"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"identificatie": {
|
|
"type": "string"
|
|
},
|
|
"omschrijving": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"CurrentRegistration": {
|
|
"required": [
|
|
"registrationId",
|
|
"status"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"registrationId": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"DecideRequest": {
|
|
"required": [
|
|
"besluit"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"besluit": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"OpenbaarEntry": {
|
|
"required": [
|
|
"id",
|
|
"status",
|
|
"reference"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
},
|
|
"reference": {
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"ProvideDocumentsRequest": {
|
|
"required": [
|
|
"contentBase64"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"contentBase64": {
|
|
"type": "string"
|
|
},
|
|
"fileName": {
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
},
|
|
"contentType": {
|
|
"type": [
|
|
"null",
|
|
"string"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"SubmitAccepted": {
|
|
"required": [
|
|
"registrationId",
|
|
"status"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"registrationId": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"WerkbakItem": {
|
|
"required": [
|
|
"registrationId",
|
|
"bsn",
|
|
"status"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"registrationId": {
|
|
"type": "string"
|
|
},
|
|
"bsn": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Bff.Api"
|
|
}
|
|
]
|
|
} |