diff --git a/api/public/schema/openapi.yaml b/api/public/schema/openapi.yaml index 1095b37b..fee138e9 100644 --- a/api/public/schema/openapi.yaml +++ b/api/public/schema/openapi.yaml @@ -1726,11 +1726,9 @@ components: description: 'The RSIN of the organization that owns this process' type: string name: - readOnly: true description: 'The name of this RequestType' type: string description: - readOnly: true description: 'An short description of this RequestType' type: string properties: @@ -1742,15 +1740,23 @@ components: readOnly: true required: - source_organization + - name RequestType-write: type: object description: 'All properties contained in the RequestType type' required: - source_organization + - name properties: source_organization: description: 'The RSIN of the organization that owns this process' type: string + name: + description: 'The name of this RequestType' + type: string + description: + description: 'An short description of this RequestType' + type: string properties: description: 'The properties for this request type' type: array @@ -1779,11 +1785,9 @@ components: description: 'The RSIN of the organization that owns this process' type: string name: - readOnly: true description: 'The name of this RequestType' type: string description: - readOnly: true description: 'An short description of this RequestType' type: string properties: @@ -1795,11 +1799,13 @@ components: readOnly: true required: - source_organization + - name 'RequestType:jsonld-write': type: object description: 'All properties contained in the RequestType type' required: - source_organization + - name properties: '@context': readOnly: true @@ -1813,6 +1819,12 @@ components: source_organization: description: 'The RSIN of the organization that owns this process' type: string + name: + description: 'The name of this RequestType' + type: string + description: + description: 'An short description of this RequestType' + type: string properties: description: 'The properties for this request type' type: array @@ -1961,12 +1973,12 @@ definitions: availableFrom: description: 'The moment from which this value is available' type: string - example: '2020-01-13 20:28:20' + example: '2020-01-14 14:56:33' format: date-time availableUntil: description: '*should be used in combination with deprecated* The moment where until this value is available' type: string - example: '2020-01-13 20:28:20' + example: '2020-01-14 14:56:33' format: date-time minDate: description: 'The minimal date for value, either a date, datetime or duration (ISO_8601)' @@ -2133,12 +2145,12 @@ definitions: availableFrom: description: 'The moment from which this value is available' type: string - example: '2020-01-13 20:28:20' + example: '2020-01-14 14:56:33' format: date-time availableUntil: description: '*should be used in combination with deprecated* The moment where until this value is available' type: string - example: '2020-01-13 20:28:20' + example: '2020-01-14 14:56:33' format: date-time minDate: description: 'The minimal date for value, either a date, datetime or duration (ISO_8601)' @@ -2205,6 +2217,16 @@ definitions: example: '002851234' maxLength: 11 minLength: 8 + name: + description: 'The name of this RequestType' + type: string + example: 'My RequestType' + maxLength: 255 + description: + description: 'An short description of this RequestType' + type: string + example: 'This is the best request ever' + maxLength: 2550 properties: description: 'The properties for this request type' type: '\Property[]|\ArrayCollection' diff --git a/api/public/schema/publiccode.yaml b/api/public/schema/publiccode.yaml index f60afa33..65303acc 100644 --- a/api/public/schema/publiccode.yaml +++ b/api/public/schema/publiccode.yaml @@ -6,7 +6,7 @@ url: "https://github.com/ConductionNL/verzoektypecatalogus" landingURL: "vtc.zaakonline.nl" isBasedOn: "https://github.com/ConductionNL/Proto-component-commonground.git" softwareVersion: "V.0.1" -releaseDate: "2020-13-01" +releaseDate: "2020-14-01" logo: pc.zaakonline.nl monochromeLogo: img/logo-mono.svg diff --git a/api/public/schema/vtc.postman_collection.json b/api/public/schema/vtc.postman_collection.json new file mode 100644 index 00000000..eac4d834 --- /dev/null +++ b/api/public/schema/vtc.postman_collection.json @@ -0,0 +1,3139 @@ +{ + "info": { + "_postman_id": "05351a7f-7993-4fd2-acef-b55bc27ccf98", + "name": "Verzoek Type Catalogus", + "description": "API Details\n- Component: Verzoek Type Catalogus\n- Reference: vtc\n- Enviroment: dev\n- Version: V.0.1\n- Repository: [online](https://github.com/ConductionNL/verzoektypecatalogus) / [zip](https://github.com/ConductionNL/verzoektypecatalogus/archive/master.zip)\n- Docker Image: [online](https://hub.docker.com/repository/docker/conduction/vtc-php) \n- Datamodel: [postman](/schema/vtc.postman_collection.json) / [oas](/schema/openapi.yaml) / [pdf](/schema/datamodel.pdf) / [mwb](/schema/datamodel.mwb) \n\n'Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.' \n", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "request types", + "item": [ + { + "name": "Retrieves the collection of RequestType resources.", + "event": [ + { + "listen": "test", + "script": { + "id": "9a97307a-33b5-4215-ae8a-61cb151a03d0", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(200);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types?", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ], + "query": [ + { + "key": "source_organization", + "value": "", + "disabled": true + }, + { + "key": "source_organization[]", + "value": "", + "disabled": true + }, + { + "key": "source_organization[]", + "value": "", + "disabled": true + }, + { + "key": "page", + "value": "1", + "description": "The collection page number", + "disabled": true + }, + { + "key": "extend[]", + "value": "", + "description": "An array of nested objects to include in the return object", + "disabled": true + }, + { + "key": "fields[]", + "value": "", + "description": "An array of fields to return in output, wil return all fields is not supplied", + "disabled": true + }, + { + "key": "validOn", + "value": "", + "description": "Returns object as valid on a given date time", + "disabled": true + }, + { + "key": "validFrom", + "value": "", + "description": "Returns objects valid from a given date time", + "disabled": true + }, + { + "key": "validUntil", + "value": "", + "description": "Returns objects valid until a given date time", + "disabled": true + } + ] + } + }, + "response": [ + { + "name": "RequestType collection response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types?source_organization=&source_organization[]=&source_organization[]=&page=1&extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ], + "query": [ + { + "key": "source_organization", + "value": "" + }, + { + "key": "source_organization[]", + "value": "" + }, + { + "key": "source_organization[]", + "value": "" + }, + { + "key": "page", + "value": "1" + }, + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "[\n {\n \"source_organization\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ],\n \"stages\": \"schema type not provided\"\n },\n {\n \"source_organization\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ],\n \"stages\": \"schema type not provided\"\n }\n]" + } + ] + }, + { + "name": "Creates a RequestType resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "e6e4e299-3dce-42a0-bdf0-aec6bfdb2ec7", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(201);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " // pm.response.to.be.created; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});\r", + "\r", + "\r", + "pm.test(\"Set ID\", function () {\r", + " var jsonData = pm.response.json();\r", + " console.log(jsonData);\r", + " //var payloadData = JSON.parse(jsonData.Payload); //parsed payload\r", + "\r", + " //console.log(payloadData.Id);\r", + "\r", + " pm.environment.set(\"requestType\", jsonData.id);\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"sourceOrganization\": \"002851234\",\n\t\"name\": \"My RequestType\",\n\t\"description\": \"This is the best RequestType ever\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ] + } + }, + "response": [ + { + "name": "RequestType resource created", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"source_organization\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ],\n \"stages\": \"schema type not provided\"\n}" + }, + { + "name": "Invalid input", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Resource not found", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "protocolProfileBehavior": {} + }, + { + "name": "request types/{id}", + "item": [ + { + "name": "Retrieves a RequestType resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "d08252a2-d9b7-4c77-a296-69e88aa47b07", + "exec": [ + "// example using pm.response.to.have", + "pm.test(\"response is ok\", function () {", + " pm.response.to.have.status(200);", + "});", + "", + "// example using response assertions", + "pm.test(\"response should be okay to process\", function () {", + " pm.response.to.not.be.error;", + " pm.response.to.not.have.jsonBody(\"error\");", + "});", + "", + "// example using pm.response.to.be*", + "pm.test(\"response must be valid and have a body\", function () {", + " // assert that the status code is 200", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants", + " // assert that the response has a valid JSON body", + " pm.response.to.be.withBody;", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types/{{requestType}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + "{{requestType}}" + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types/:id?extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "query": [ + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "RequestType resource response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/request_types/:id?extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "query": [ + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"source_organization\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ],\n \"stages\": \"schema type not provided\"\n}" + } + ] + }, + { + "name": "Replaces the RequestType resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "e70c61ef-78a0-4910-97d3-abb094c45796", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(200);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"sourceOrganization\": \"002851234\",\n\t\"name\": \"My RequestType\",\n\t\"description\": \"This is the best RequestType ever\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types/{{requestType}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + "{{requestType}}" + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Invalid input", + "originalRequest": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "RequestType resource updated", + "originalRequest": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"source_organization\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ]\n}" + }, + "url": { + "raw": "{{baseUrl}}/request_types/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"source_organization\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"properties\": [\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n ],\n \"stages\": \"schema type not provided\"\n}" + } + ] + } + ], + "protocolProfileBehavior": {} + }, + { + "name": "properties", + "item": [ + { + "name": "Retrieves the collection of Property resources.", + "event": [ + { + "listen": "test", + "script": { + "id": "a3145263-a331-45e8-a400-db44b0e7bfef", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(200);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/properties?", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ], + "query": [ + { + "key": "page", + "value": "1", + "description": "The collection page number", + "disabled": true + }, + { + "key": "extend[]", + "value": "", + "description": "An array of nested objects to include in the return object", + "disabled": true + }, + { + "key": "fields[]", + "value": "", + "description": "An array of fields to return in output, wil return all fields is not supplied", + "disabled": true + }, + { + "key": "validOn", + "value": "", + "description": "Returns object as valid on a given date time", + "disabled": true + }, + { + "key": "validFrom", + "value": "", + "description": "Returns objects valid from a given date time", + "disabled": true + }, + { + "key": "validUntil", + "value": "", + "description": "Returns objects valid until a given date time", + "disabled": true + } + ] + } + }, + "response": [ + { + "name": "Property collection response", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/properties?page=1&extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ], + "query": [ + { + "key": "page", + "value": "1" + }, + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "[\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n },\n {\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n }\n]" + } + ] + }, + { + "name": "Creates a Property resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "2fe7e1cc-8091-4d36-9840-3a05ab79e7dd", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(201);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " // pm.response.to.be.created; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});\r", + "\r", + "\r", + "pm.test(\"Set ID\", function () {\r", + " var jsonData = pm.response.json();\r", + " console.log(jsonData);\r", + " //var payloadData = JSON.parse(jsonData.Payload); //parsed payload\r", + "\r", + " //console.log(payloadData.Id);\r", + "\r", + " pm.environment.set(\"property\", jsonData.id);\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"requestType\": \"/request_types/{{requestType}}\",\n\t\"title\": \"My precious Property\",\n\t\"name\": \"my_precious\",\n\t\"type\": \"string\",\n\t\"format\": \"string\",\n\t\"maxLength\": 255,\n\t\"minLength\": 3,\n\t\"required\": true,\n\t\"nullable\": false,\n\t\"readOnly\": false,\n\t\"writeOnly\": false,\n\t\"example\": \"my value\",\n\t\"deprecated\": false,\n\t\"slug\": \"my-precious-ring\",\n\t\"start\": true\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ] + } + }, + "response": [ + { + "name": "Invalid input", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Property resource created", + "originalRequest": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + { + "name": "Resource not found", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "protocolProfileBehavior": {} + }, + { + "name": "properties/{id}", + "item": [ + { + "name": "Retrieves a Property resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "4d6587a3-dee4-430f-9d7d-8f65054ae12e", + "exec": [ + "// example using pm.response.to.have", + "pm.test(\"response is ok\", function () {", + " pm.response.to.have.status(200);", + "});", + "", + "// example using response assertions", + "pm.test(\"response should be okay to process\", function () {", + " pm.response.to.not.be.error;", + " pm.response.to.not.have.jsonBody(\"error\");", + "});", + "", + "// example using pm.response.to.be*", + "pm.test(\"response must be valid and have a body\", function () {", + " // assert that the status code is 200", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants", + " // assert that the response has a valid JSON body", + " pm.response.to.be.withBody;", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/properties/{{property}}?", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + "{{property}}" + ], + "query": [ + { + "key": "extend[]", + "value": "", + "description": "An array of nested objects to include in the return object", + "disabled": true + }, + { + "key": "fields[]", + "value": "", + "description": "An array of fields to return in output, wil return all fields is not supplied", + "disabled": true + }, + { + "key": "validOn", + "value": "", + "description": "Returns object as valid on a given date time", + "disabled": true + }, + { + "key": "validFrom", + "value": "", + "description": "Returns objects valid from a given date time", + "disabled": true + }, + { + "key": "validUntil", + "value": "", + "description": "Returns objects valid until a given date time", + "disabled": true + } + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Link", + "value": "", + "description": "A [websub](https://www.w3.org/TR/websub/#discovery) header like ; rel=\"hub\"" + } + ], + "url": { + "raw": "{{baseUrl}}/properties/:id?extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "query": [ + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Property resource response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/properties/:id?extend[]=&fields[]=&validOn=&validFrom=&validUntil=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "query": [ + { + "key": "extend[]", + "value": "" + }, + { + "key": "fields[]", + "value": "" + }, + { + "key": "validOn", + "value": "" + }, + { + "key": "validFrom", + "value": "" + }, + { + "key": "validUntil", + "value": "" + } + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + } + ] + }, + { + "name": "Replaces the Property resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "df9edb3e-2f5f-49a3-b834-d3bc032f08c6", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(200);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"requestType\": \"/request_types/{{requestType}}\",\n\t\"title\": \"My precious Property\",\n\t\"name\": \"my_precious\",\n\t\"type\": \"string\",\n\t\"format\": \"string\",\n\t\"maxLength\": 255,\n\t\"minLength\": 3,\n\t\"required\": true,\n\t\"nullable\": false,\n\t\"readOnly\": false,\n\t\"writeOnly\": false,\n\t\"example\": \"my value\",\n\t\"deprecated\": false,\n\t\"slug\": \"my-precious-ring\",\n\t\"start\": true\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/{{property}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + "{{property}}" + ] + } + }, + "response": [ + { + "name": "Property resource updated", + "originalRequest": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + { + "name": "Resource not found", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Invalid input", + "originalRequest": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Updates the Property resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "c98a30fa-559a-45e9-9b39-f20e266916ab", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(200);\r", + "});\r", + "\r", + "// example using response assertions\r", + "pm.test(\"response should be okay to process\", function () {\r", + " pm.response.to.not.be.error;\r", + " pm.response.to.not.have.jsonBody(\"error\");\r", + "});\r", + "\r", + "// example using pm.response.to.be*\r", + "pm.test(\"response must be valid and have a body\", function () {\r", + " // assert that the status code is 200\r", + " pm.response.to.be.ok; // info, success, redirection, clientError, serverError, are other variants\r", + " // assert that the response has a valid JSON body\r", + " pm.response.to.be.withBody;\r", + " pm.response.to.be.json; // this assertion also checks if a body exists, so the above check is not needed\r", + "});" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Content-Type", + "value": "application/vnd.api+json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n\t\"maxLength\": 16,\n\t\"minLength\": 4\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/{{property}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + "{{property}}" + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Invalid input", + "originalRequest": { + "method": "PATCH", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Property resource updated", + "originalRequest": { + "method": "PATCH", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + }, + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/hal+json" + } + ], + "cookie": [], + "body": "{\n \"description\": \"An example of the value that should be supplied\",\n \"type\": \"string\",\n \"default\": \"\"\n}" + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "id": "e3be5b9c-caaa-47cb-9976-8a1e907bc642", + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "id": "5ea57b0b-1d7e-4845-bad3-1f193516a2d8", + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "protocolProfileBehavior": {} + }, + { + "name": "cleanup", + "item": [ + { + "name": "Removes the Property resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "67878c27-7dee-4930-b557-34fdf48ffedc", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(204);\r", + "});\r", + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "url": { + "raw": "{{baseUrl}}/properties/{{property}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + "{{property}}" + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Property resource deleted", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{baseUrl}}/properties/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "properties", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Removes the RequestType resource.", + "event": [ + { + "listen": "test", + "script": { + "id": "267f4134-cd12-4162-b639-9ad844a4e436", + "exec": [ + "// example using pm.response.to.have\r", + "pm.test(\"response is ok\", function () {\r", + " pm.response.to.have.status(204);\r", + "});\r", + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types/{{requestType}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + "{{requestType}}" + ] + } + }, + "response": [ + { + "name": "Resource not found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + }, + { + "key": "Authorization", + "value": "", + "description": "The JWT of the entity performing the request" + }, + { + "key": "API-Version", + "value": "", + "description": "The version of the API conform [Landelijke API-strategie.](https://geonovum.github.io/KP-APIs/#versioning)" + }, + { + "key": "X-NLX-Logrecord-ID", + "value": "", + "description": "A globally unique id of the request, which makes a request traceable throughout the network." + }, + { + "key": "X-NLX-Request-Process-Id", + "value": "", + "description": "A process id for purpose registration (doelbinding)" + }, + { + "key": "X-NLX-Request-Data-Elements", + "value": "", + "description": "A list of requested data elements" + }, + { + "key": "X-NLX-Request-Data-Subject", + "value": "", + "description": "A key-value list of data subjects related to this request. e.g. `bsn=12345678, kenteken=ab-12-fg`" + }, + { + "key": "X-NLX-Audit-Clarification", + "value": "", + "description": "A clarification as to why a request has been made (doelbinding)" + } + ], + "url": { + "raw": "{{baseUrl}}/request_types/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "RequestType resource deleted", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{baseUrl}}/request_types/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "request_types", + ":id" + ], + "variable": [ + { + "key": "id" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "protocolProfileBehavior": {} + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "id": "b6c8b1f1-e3d9-4f35-b879-926a39e19e6c", + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "id": "47ae64e1-5a1a-4963-a7e9-8e69b5e8be98", + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "id": "7ed0ed0f-3e50-42f6-9dca-aed2d333928f", + "key": "baseUrl", + "value": "http://localhost:8080", + "type": "string" + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file diff --git a/api/src/Entity/RequestType.php b/api/src/Entity/RequestType.php index 3056ca18..96d4770b 100644 --- a/api/src/Entity/RequestType.php +++ b/api/src/Entity/RequestType.php @@ -96,7 +96,7 @@ class RequestType * @Assert\Length( * max = 2550 * ) - * @Groups({"read"}) + * @Groups({"read", "write"}) * @ORM\Column(type="text", nullable=true) */ private $description;