From f8d47080947572d3afee2f38179d5c3c95262953 Mon Sep 17 00:00:00 2001 From: Nico Koprowski Date: Mon, 13 May 2024 08:40:07 +0200 Subject: [PATCH] docs(EDC): replace EDC consumer postman collection with newest version --- .../EDC BPDM Consumer.postman_collection.json | 5151 +++++------------ 1 file changed, 1508 insertions(+), 3643 deletions(-) diff --git a/docs/postman/EDC BPDM Consumer.postman_collection.json b/docs/postman/EDC BPDM Consumer.postman_collection.json index 1302c94dc..8ac2f3283 100644 --- a/docs/postman/EDC BPDM Consumer.postman_collection.json +++ b/docs/postman/EDC BPDM Consumer.postman_collection.json @@ -33,8 +33,8 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var offerId = responseJson[\"odrl:hasPolicy\"][\"@id\"];", - "var assetId = responseJson[\"odrl:hasPolicy\"][\"odrl:target\"][ \"@id\"];", + "var offerId = responseJson[\"dcat:dataset\"][\"odrl:hasPolicy\"][\"@id\"];", + "var assetId = responseJson[\"dcat:dataset\"][\"id\"];", "pm.collectionVariables.set(\"OFFER\", offerId);", "pm.collectionVariables.set(\"SELECTED_ASSET\", assetId)", "pm.collectionVariables.set(\"SELECTED_PURPOSE\", \"cx.bpdm.pool:1\")" @@ -49,7 +49,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"DatasetRequest\",\r\n \"@id\": \"{{ASSET_ID_POOL_CX_MEMBER_READ}}\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\"\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:ReadAccessPoolForCatenaXMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -57,14 +57,13 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/dataset/request", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/request", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ "v2", "catalog", - "dataset", "request" ] } @@ -92,8 +91,8 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var offerId = responseJson[\"odrl:hasPolicy\"][\"@id\"];", - "var assetId = responseJson[\"odrl:hasPolicy\"][\"odrl:target\"][ \"@id\"];", + "var offerId = responseJson[\"dcat:dataset\"][\"odrl:hasPolicy\"][\"@id\"];", + "var assetId = responseJson[\"dcat:dataset\"][\"id\"];", "pm.collectionVariables.set(\"OFFER\", offerId);", "pm.collectionVariables.set(\"SELECTED_ASSET\", assetId)", "pm.collectionVariables.set(\"SELECTED_PURPOSE\", \"cx.bpdm.gate.upload:1\")" @@ -108,7 +107,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"DatasetRequest\",\r\n \"@id\": \"{{ASSET_ID_GATE_SHARING_MEMBER_FULL_INPUT}}\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\"\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:FullAccessGateInputForSharingMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -116,14 +115,13 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/dataset/request", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/request", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ "v2", "catalog", - "dataset", "request" ] } @@ -151,11 +149,11 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var offerId = responseJson[\"odrl:hasPolicy\"][\"@id\"];", - "var assetId = responseJson[\"odrl:hasPolicy\"][\"odrl:target\"][ \"@id\"];", + "var offerId = responseJson[\"dcat:dataset\"][\"odrl:hasPolicy\"][\"@id\"];", + "var assetId = responseJson[\"dcat:dataset\"][\"id\"];", "pm.collectionVariables.set(\"OFFER\", offerId);", "pm.collectionVariables.set(\"SELECTED_ASSET\", assetId)", - "pm.collectionVariables.set(\"SELECTED_PURPOSE\", \"cx.bpdm.gate.upload:1\")" + "pm.collectionVariables.set(\"SELECTED_PURPOSE\", \"cx.bpdm.gate.download:1\")" ], "type": "text/javascript", "packages": {} @@ -167,7 +165,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"DatasetRequest\",\r\n \"@id\": \"{{ASSET_ID_GATE_SHARING_MEMBER_READ_INPUT}}\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\"\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:ReadAccessGateInputForSharingMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -175,14 +173,13 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/dataset/request", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/request", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ "v2", "catalog", - "dataset", "request" ] } @@ -210,8 +207,8 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var offerId = responseJson[\"odrl:hasPolicy\"][\"@id\"];", - "var assetId = responseJson[\"odrl:hasPolicy\"][\"odrl:target\"][ \"@id\"];", + "var offerId = responseJson[\"dcat:dataset\"][\"odrl:hasPolicy\"][\"@id\"];", + "var assetId = responseJson[\"dcat:dataset\"][\"id\"];", "pm.collectionVariables.set(\"OFFER\", offerId);", "pm.collectionVariables.set(\"SELECTED_ASSET\", assetId)", "pm.collectionVariables.set(\"SELECTED_PURPOSE\", \"cx.bpdm.gate.download:1\")" @@ -226,7 +223,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"DatasetRequest\",\r\n \"@id\": \"{{ASSET_ID_GATE_SHARING_MEMBER_READ_OUTPUT}}\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\"\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:ReadAccessGateOutputForSharingMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -234,14 +231,13 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/dataset/request", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/request", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ "v2", "catalog", - "dataset", "request" ] } @@ -277,7 +273,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"odrl\": \"http://www.w3.org/ns/odrl/2/\"\n },\n \"@type\": \"NegotiationInitiateRequestDto\",\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\n \"protocol\": \"dataspace-protocol-http\",\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\n \"offer\": {\n \"offerId\": \"{{OFFER}}\",\n \"assetId\": \"{{SELECTED_ASSET}}\",\n \"policy\": {\n \"@type\": \"odrl:Set\",\n \"odrl:permission\": {\n \"odrl:target\": \"{{SELECTED_ASSET}}\",\n \"odrl:action\": {\n \"odrl:type\": \"USE\"\n },\n \"odrl:constraint\": {\n \"odrl:and\": [\n {\n \"odrl:leftOperand\": \"cx-policy:Membership\",\n \"odrl:operator\": {\n \"@id\": \"odrl:eq\"\n },\n \"odrl:rightOperand\": \"active\"\n },\n {\n \"odrl:leftOperand\": \"cx-policy:BusinessPartnerNumber\",\n \"odrl:operator\": {\n \"@id\": \"odrl:eq\"\n },\n \"odrl:rightOperand\": \"{{CONSUMER_BPNL}}\"\n },\n {\n \"odrl:leftOperand\": \"cx-policy:FrameworkAgreement\",\n \"odrl:operator\": {\n \"@id\": \"odrl:eq\"\n },\n \"odrl:rightOperand\": \"businesspartner:1.0\"\n },\n {\n \"odrl:leftOperand\": \"cx-policy:UsagePurpose\",\n \"odrl:operator\": {\n \"@id\": \"odrl:eq\"\n },\n \"odrl:rightOperand\": \"{{SELECTED_PURPOSE}}\"\n }\n ]\n }\n },\n \"odrl:prohibition\": [],\n \"odrl:obligation\": [],\n \"odrl:target\": \"{{SELECTED_ASSET}}\"\n }\n }\n}", + "raw": "{\n \"@context\": [\n \"https://w3id.org/tractusx/policy/v1.0.0\",\n \"http://www.w3.org/ns/odrl.jsonld\",\n {\n \"edc\": \"https://w3id.org/edc/v0.0.1/ns/\"\n }\n ],\n \"@type\": \"ContractRequest\",\n \"edc:counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\n \"edc:protocol\": \"dataspace-protocol-http\",\n \"edc:counterPartyId\": \"{{PROVIDER_BPNL}}\",\n \"edc:policy\": {\n \"@id\": \"{{OFFER}}\",\n \"@type\": \"Offer\",\n \"permission\": [\n {\n \"action\": \"use\",\n \"constraint\": {\n \"and\": [\n {\n \"leftOperand\": \"FrameworkAgreement\",\n \"operator\": \"eq\",\n \"rightOperand\": \"businessPartner:1.0\"\n },\n {\n \"leftOperand\": \"UsagePurpose\",\n \"operator\": \"eq\",\n \"rightOperand\": \"{{SELECTED_PURPOSE}}\"\n }\n ]\n }\n }\n ],\n \"target\": \"{{SELECTED_ASSET}}\",\n \"assigner\": \"{{PROVIDER_BPNL}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -285,11 +281,12 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/edrs", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/edrs", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ + "v2", "edrs" ] } @@ -297,13 +294,13 @@ "response": [] }, { - "name": "Get Negotiation", + "name": "Get Agreement", "event": [ { "listen": "prerequest", "script": { "exec": [ - "pm.sendRequest('https://postman-echo.com/delay/3');" + "pm.sendRequest('https://postman-echo.com/delay/5');" ], "type": "text/javascript", "packages": {} @@ -343,8 +340,18 @@ "response": [] }, { - "name": "Get EDR", + "name": "Get Transferprocess", "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript", + "packages": {} + } + }, { "listen": "test", "script": { @@ -353,23 +360,20 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var transferId = responseJson[0][\"transferProcessId\"];", - "pm.collectionVariables.set(\"TRANSFER\", transferId);" + "var transferProcessId = responseJson[0][\"transferProcessId\"];", + "pm.collectionVariables.set(\"TRANSFERPROCESS\", transferProcessId);" ], "type": "text/javascript", "packages": {} } } ], - "protocolProfileBehavior": { - "disableBodyPruning": true - }, "request": { - "method": "GET", + "method": "POST", "header": [], "body": { "mode": "raw", - "raw": "", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\n },\n \"@type\": \"QuerySpec\",\n \"offset\": 0,\n \"limit\": 1,\n \"filterExpression\": [\n {\n \"operandLeft\": \"agreementId\",\n \"operator\": \"=\",\n \"operandRight\": \"{{AGREEMENT}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -377,25 +381,21 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/edrs?agreementId={{AGREEMENT}}", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/edrs/request", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ - "edrs" - ], - "query": [ - { - "key": "agreementId", - "value": "{{AGREEMENT}}" - } + "v2", + "edrs", + "request" ] } }, "response": [] }, { - "name": "Get EDR Token", + "name": "Get Authorization", "event": [ { "listen": "test", @@ -405,8 +405,8 @@ " pm.response.to.have.status(200);", "});", "var responseJson = pm.response.json();", - "var token = responseJson[\"authCode\"];", - "pm.collectionVariables.set(\"TRANSFER_TOKEN\", token);" + "var transferToken = responseJson[\"authorization\"];", + "pm.collectionVariables.set(\"TRANSFER_TOKEN\", transferToken);" ], "type": "text/javascript", "packages": {} @@ -429,81 +429,85 @@ } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/edrs/{{TRANSFER}}", + "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/edrs/{{TRANSFERPROCESS}}/dataaddress?auto_refresh=true", "host": [ "{{CONSUMER_EDC_MANAGEMENT_API}}" ], "path": [ + "v2", "edrs", - "{{TRANSFER}}" + "{{TRANSFERPROCESS}}", + "dataaddress" + ], + "query": [ + { + "key": "auto_refresh", + "value": "true" + } ] } }, "response": [] } ] - }, + } + ] + }, + { + "name": "Pool Member Read", + "item": [ { - "name": "Query Available Offers", - "event": [ - { - "listen": "prerequest", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - }, - { - "listen": "test", - "script": { - "exec": [ - "" - ], - "type": "text/javascript", - "packages": {} - } - } - ], + "name": "/members/changelog/search", "request": { "method": "POST", - "header": [], + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 100,\r\n \"range\": {\r\n \"from\": 0,\r\n \"to\": 100\r\n },\r\n \"criterion\": \"\"\r\n }\r\n}", + "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", "options": { "raw": { + "headerFamily": "json", "language": "json" } } }, "url": { - "raw": "{{CONSUMER_EDC_MANAGEMENT_API}}/v2/catalog/request", + "raw": "{{baseUrl}}/members/changelog/search?page=0&size=10", "host": [ - "{{CONSUMER_EDC_MANAGEMENT_API}}" + "{{baseUrl}}" ], "path": [ - "v2", - "catalog", - "request" + "members", + "changelog", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] } }, - "response": [] - } - ] - }, - { - "name": "Pool API", - "item": [ - { - "name": "Changelog Controller", - "item": [ + "response": [ { - "name": "/members/changelog/search", - "request": { + "name": "OK", + "originalRequest": { "method": "POST", "header": [ { @@ -549,72 +553,72 @@ ] } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/members/changelog/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "members", - "changelog", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"changelogType\": \"CREATE\",\n \"timestamp\": \"\"\n },\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"SITE\",\n \"changelogType\": \"UPDATE\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "key": "Content-Type", + "value": "application/json" } - ] + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"changelogType\": \"CREATE\",\n \"timestamp\": \"\"\n },\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"SITE\",\n \"changelogType\": \"UPDATE\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + }, + { + "name": "/members/legal-entities/search", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, + "url": { + "raw": "{{baseUrl}}/members/legal-entities/search?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "members", + "legal-entities", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } + ] + } + }, + "response": [ { - "name": "/business-partners/changelog/search", - "request": { + "name": "OK", + "originalRequest": { "method": "POST", "header": [ { @@ -628,7 +632,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", + "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -637,13 +641,13 @@ } }, "url": { - "raw": "{{baseUrl}}/business-partners/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/members/legal-entities/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "business-partners", - "changelog", + "members", + "legal-entities", "search" ], "query": [ @@ -660,208 +664,104 @@ ] } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "The specified changelog entries", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/business-partners/changelog/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "business-partners", - "changelog", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AT\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"KH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RW\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"QA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"UM\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"JE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GP\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + }, + { + "name": "/members/sites/search", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/members/sites/search?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "members", + "sites", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"changelogType\": \"CREATE\",\n \"timestamp\": \"\"\n },\n {\n \"bpn\": \"\",\n \"businessPartnerType\": \"SITE\",\n \"changelogType\": \"UPDATE\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } }, - { - "name": "On malformed pagination request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/business-partners/changelog/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "business-partners", - "changelog", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "No business partner found for specified bpn", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"bpns\": [\n \"\",\n \"\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\",\n \"GENERIC\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/business-partners/changelog/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "business-partners", - "changelog", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Read change events of business partner data" - }, - { - "name": "Legal Entity Controller", - "item": [ - { - "name": "/legal-entities", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], "url": { - "raw": "{{baseUrl}}/legal-entities?bpnLs=&bpnLs=&legalName=&page=0&size=10", + "raw": "{{baseUrl}}/members/sites/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities" + "members", + "sites", + "search" ], "query": [ - { - "key": "bpnLs", - "value": "" - }, - { - "key": "bpnLs", - "value": "" - }, - { - "key": "legalName", - "value": "" - }, { "key": "page", "value": "0", @@ -873,110 +773,75 @@ "description": "Size of each page" } ] - }, - "description": "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. " + } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "Page of business partners matching the search criteria, may be empty", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-entities?bpnLs=&legalName=&page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ], - "query": [ - { - "key": "bpnLs", - "value": "" - }, - { - "key": "legalName", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AT\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"KH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RW\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"QA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"UM\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"JE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GP\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"KY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IL\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AI\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"XU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LB\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"PS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + }, + { + "name": "/members/addresses/search", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/members/addresses/search?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "members", + "addresses", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" }, { - "name": "On malformed search or pagination request", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities?bpnLs=&legalName=&page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ], - "query": [ - { - "key": "bpnLs", - "value": "" - }, - { - "key": "legalName", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "size", + "value": "10", + "description": "Size of each page" } ] - }, + } + }, + "response": [ { - "name": "/legal-entities", - "request": { - "method": "PUT", + "name": "OK", + "originalRequest": { + "method": "POST", "header": [ { "key": "Content-Type", @@ -989,7 +854,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"CH\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SX\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MT\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n }\n]", + "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", @@ -998,256 +863,217 @@ } }, "url": { - "raw": "{{baseUrl}}/legal-entities", + "raw": "{{baseUrl}}/members/addresses/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities" + "members", + "addresses", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] - }, - "description": "Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change." + } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "Update legal entities request was processed successfully, possible errors are returned", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"CH\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SX\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MT\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-entities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"CO\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SM\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"BT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"CW\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SN\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"BZ\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"LegalAddressDuplicateIdentifier\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"LegalFormNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"VG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"ZR\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SR\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + }, + { + "name": "/legal-forms", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/legal-forms?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legal-forms" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" }, { - "name": "On malformed requests", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"CH\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SX\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MT\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-entities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "size", + "value": "10", + "description": "Size of each page" } ] }, + "description": "Lists all currently known legal forms in a paginated result" + }, + "response": [ { - "name": "/legal-entities", - "request": { - "method": "POST", + "name": "Page of existing legal forms, may be empty", + "originalRequest": { + "method": "GET", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"IN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"MN\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"XU\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KZ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/legal-entities", + "raw": "{{baseUrl}}/legal-forms?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities" + "legal-forms" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] - }, - "description": "Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." + } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "New legal entities request was processed successfully, possible errors are returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"IN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"MN\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"XU\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KZ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + }, + { + "name": "On malformed request parameters", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/legal-forms?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "legal-forms" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" }, - "url": { - "raw": "{{baseUrl}}/legal-entities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ { - "key": "Content-Type", - "value": "application/json" + "key": "size", + "value": "10", + "description": "Size of each page" } - ], - "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"UY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"BB\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"QA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"JO\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SZ\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"BI\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"DE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"LegalAddressIdentifierNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"LegalAddressRegionNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "/identifier-types", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "identifier-types" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" }, { - "name": "On malformed requests", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"IN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"MN\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"XU\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"KZ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"legalName\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"legalShortName\": \"\",\n \"legalForm\": \"\",\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-entities", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "size", + "value": "10", + "description": "Size of each page" + }, + { + "key": "businessPartnerType", + "value": "LEGAL_ENTITY", + "description": "(Required) " + }, + { + "key": "country", + "value": "FJ" } ] }, + "description": "Lists all matching identifier types including validity details in a paginated result" + }, + "response": [ { - "name": "/members/legal-entities/search", - "request": { - "method": "POST", + "name": "Page of existing identifier types, may be empty", + "originalRequest": { + "method": "GET", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/members/legal-entities/search?page=0&size=10", + "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", "host": [ "{{baseUrl}}" ], "path": [ - "members", - "legal-entities", - "search" + "identifier-types" ], "query": [ { @@ -1259,105 +1085,43 @@ "key": "size", "value": "10", "description": "Size of each page" + }, + { + "key": "businessPartnerType", + "value": "LEGAL_ENTITY", + "description": "(Required) " + }, + { + "key": "country", + "value": "FJ" } ] } }, - "response": [ + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/members/legal-entities/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "members", - "legal-entities", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AT\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"KH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RW\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"QA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"UM\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"JE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GP\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "key": "Content-Type", + "value": "application/json" } - ] + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"SA\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"MX\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n {\n \"businessPartnerType\": \"ADDRESS\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"GN\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"LR\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { - "name": "/legal-entities/search", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, + "name": "On malformed request parameters", + "originalRequest": { + "method": "GET", + "header": [], "url": { - "raw": "{{baseUrl}}/legal-entities/search?page=0&size=10", + "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities", - "search" + "identifier-types" ], "query": [ { @@ -1369,126 +1133,61 @@ "key": "size", "value": "10", "description": "Size of each page" - } - ] - }, - "description": "Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries." - }, - "response": [ - { - "name": "Found legal entites", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } }, - "url": { - "raw": "{{baseUrl}}/legal-entities/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AT\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"KH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RW\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"QA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n },\n {\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"UM\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"JE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GP\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_PREDECESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed request parameters or if number of requested bpns exceeds limit", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"bpnLs\": [\n \"\",\n \"\"\n ],\n \"legalName\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } + "key": "businessPartnerType", + "value": "LEGAL_ENTITY", + "description": "(Required) " }, - "url": { - "raw": "{{baseUrl}}/legal-entities/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] + { + "key": "country", + "value": "FJ" } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "/field-quality-rules/", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "field-quality-rules", + "" + ], + "query": [ + { + "key": "country", + "value": "FJ", + "description": "(Required) ISO 3166-1 alpha-2 country code" } ] }, + "description": "List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden." + }, + "response": [ { - "name": "/legal-entities/:idValue", - "request": { + "name": "List of the existing rules for the given country", + "originalRequest": { "method": "GET", "header": [ { @@ -1497,152 +1196,104 @@ } ], "url": { - "raw": "{{baseUrl}}/legal-entities/:idValue?idType=BPN", + "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities", - ":idValue" + "field-quality-rules", + "" ], "query": [ { - "key": "idType", - "value": "BPN", - "description": "Type of identifier to use, defaults to BPN when omitted" + "key": "country", + "value": "FJ", + "description": "(Required) ISO 3166-1 alpha-2 country code" } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"country\": \"PS\",\n \"fieldPath\": \"\",\n \"qualityLevel\": \"MANDATORY\",\n \"schemaName\": \"\"\n },\n {\n \"country\": \"IL\",\n \"fieldPath\": \"\",\n \"qualityLevel\": \"FORBIDDEN\",\n \"schemaName\": \"\"\n }\n]" + }, + { + "name": "On malformed request parameters", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", + "host": [ + "{{baseUrl}}" ], - "variable": [ + "path": [ + "field-quality-rules", + "" + ], + "query": [ { - "key": "idValue", - "value": "", - "description": "(Required) Identifier value" + "key": "country", + "value": "FJ", + "description": "(Required) ISO 3166-1 alpha-2 country code" } ] - }, - "description": "This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type." + } }, - "response": [ + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "/administrative-areas-level1", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "administrative-areas-level1" + ], + "query": [ { - "name": "Found business partner with specified identifier", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-entities/:idValue?idType=BPN", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":idValue" - ], - "query": [ - { - "key": "idType", - "value": "BPN", - "description": "Type of identifier to use, defaults to BPN when omitted" - } - ], - "variable": [ - { - "key": "idValue" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"bpnl\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"currentness\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"legalAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"DG\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"RU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LA\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"legalName\": \"\",\n \"relations\": [\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"endBpnl\": \"\",\n \"startBpnl\": \"\",\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"CX_LEGAL_SUCCESSOR_OF\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"legalShortName\": \"\",\n \"legalForm\": {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:idValue?idType=BPN", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":idValue" - ], - "query": [ - { - "key": "idType", - "value": "BPN", - "description": "Type of identifier to use, defaults to BPN when omitted" - } - ], - "variable": [ - { - "key": "idValue" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "page", + "value": "0", + "description": "Number of page to get results from" }, { - "name": "No business partner found under specified identifier or specified identifier type not found", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:idValue?idType=BPN", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":idValue" - ], - "query": [ - { - "key": "idType", - "value": "BPN", - "description": "Type of identifier to use, defaults to BPN when omitted" - } - ], - "variable": [ - { - "key": "idValue" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "size", + "value": "10", + "description": "Size of each page" } ] }, + "description": "Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result" + }, + "response": [ { - "name": "/legal-entities/:bpnl/sites", - "request": { + "name": "Page of existing country subdivisions, may be empty", + "originalRequest": { "method": "GET", "header": [ { @@ -1651,14 +1302,12 @@ } ], "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/sites?page=0&size=10", + "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities", - ":bpnl", - "sites" + "administrative-areas-level1" ], "query": [ { @@ -1671,172 +1320,33 @@ "value": "10", "description": "Size of each page" } - ], - "variable": [ - { - "key": "bpnl", - "value": "", - "description": "(Required) BPNL value" - } ] - }, - "description": "Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case." + } }, - "response": [ - { - "name": "The sites for the specified bpnl", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/sites?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "sites" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed pagination request", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/sites?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "sites" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "name": "No business partner found for specified bpnl", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/sites?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "sites" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "key": "Content-Type", + "value": "application/json" } - ] + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"code\": \"\",\n \"countryCode\": \"BL\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"countryCode\": \"BV\",\n \"name\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { - "name": "/legal-entities/:bpnl/addresses", - "request": { + "name": "On malformed request parameters", + "originalRequest": { "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], + "header": [], "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/addresses?page=0&size=10", + "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "legal-entities", - ":bpnl", - "addresses" + "administrative-areas-level1" ], "query": [ { @@ -1849,2030 +1359,132 @@ "value": "10", "description": "Size of each page" } - ], - "variable": [ - { - "key": "bpnl", - "value": "", - "description": "(Required) BPNL value" - } ] - }, - "description": "Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case." + } }, - "response": [ - { - "name": "The addresses for the specified BPNL", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/addresses?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "addresses" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"VG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"ZR\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SR\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed pagination request", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/addresses?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "addresses" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "No business partner found for specified BPNL", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-entities/:bpnl/addresses?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-entities", - ":bpnl", - "addresses" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ], - "variable": [ - { - "key": "bpnl" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Read, create and update business partner of type legal entity" - }, - { - "name": "Metadata Controller", - "item": [ - { - "name": "/legal-forms", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-forms?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - }, - "description": "Lists all currently known legal forms in a paginated result" - }, - "response": [ - { - "name": "Page of existing legal forms, may be empty", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/legal-forms?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n },\n {\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/legal-forms?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/legal-forms", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-forms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ] - }, - "description": "Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." - }, - "response": [ - { - "name": "New legal form successfully created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-forms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-forms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "Legal form with specified technical key already exists", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"technicalKey\": \"\",\n \"abbreviation\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/legal-forms", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "legal-forms" - ] - } - }, - "status": "Conflict", - "code": 409, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/identifier-types", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - }, - { - "key": "businessPartnerType", - "value": "LEGAL_ENTITY", - "description": "(Required) " - }, - { - "key": "country", - "value": "FJ" - } - ] - }, - "description": "Lists all matching identifier types including validity details in a paginated result" - }, - "response": [ - { - "name": "Page of existing identifier types, may be empty", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - }, - { - "key": "businessPartnerType", - "value": "LEGAL_ENTITY", - "description": "(Required) " - }, - { - "key": "country", - "value": "FJ" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"SA\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"MX\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n {\n \"businessPartnerType\": \"ADDRESS\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"GN\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"LR\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY&country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - }, - { - "key": "businessPartnerType", - "value": "LEGAL_ENTITY", - "description": "(Required) " - }, - { - "key": "country", - "value": "FJ" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/identifier-types", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"HT\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"XI\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identifier-types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ] - }, - "description": "Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." - }, - "response": [ - { - "name": "New identifier type successfully created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"HT\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"XI\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identifier-types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"HT\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"XI\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"HT\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"XI\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identifier-types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "Identifier type with specified technical key already exists", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"details\": [\n {\n \"mandatory\": \"\",\n \"country\": \"HT\"\n },\n {\n \"mandatory\": \"\",\n \"country\": \"XI\"\n }\n ],\n \"name\": \"\",\n \"technicalKey\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/identifier-types", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "identifier-types" - ] - } - }, - "status": "Conflict", - "code": 409, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/field-quality-rules/", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "field-quality-rules", - "" - ], - "query": [ - { - "key": "country", - "value": "FJ", - "description": "(Required) ISO 3166-1 alpha-2 country code" - } - ] - }, - "description": "List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden." - }, - "response": [ - { - "name": "List of the existing rules for the given country", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "field-quality-rules", - "" - ], - "query": [ - { - "key": "country", - "value": "FJ", - "description": "(Required) ISO 3166-1 alpha-2 country code" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"country\": \"PS\",\n \"fieldPath\": \"\",\n \"qualityLevel\": \"MANDATORY\",\n \"schemaName\": \"\"\n },\n {\n \"country\": \"IL\",\n \"fieldPath\": \"\",\n \"qualityLevel\": \"FORBIDDEN\",\n \"schemaName\": \"\"\n }\n]" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/field-quality-rules/?country=FJ", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "field-quality-rules", - "" - ], - "query": [ - { - "key": "country", - "value": "FJ", - "description": "(Required) ISO 3166-1 alpha-2 country code" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/administrative-areas-level1", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "administrative-areas-level1" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - }, - "description": "Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result" - }, - "response": [ - { - "name": "Page of existing country subdivisions, may be empty", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "administrative-areas-level1" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"code\": \"\",\n \"countryCode\": \"BL\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"countryCode\": \"BV\",\n \"name\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/administrative-areas-level1?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "administrative-areas-level1" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Read and create supporting data that is referencable in business partner data" - }, - { - "name": "Site Controller", - "item": [ - { - "name": "/sites", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sites?siteBpns=&siteBpns=&legalEntityBpns=&legalEntityBpns=&name=&page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ], - "query": [ - { - "key": "siteBpns", - "value": "" - }, - { - "key": "siteBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - }, - "description": "This endpoint retrieves all existing business partners of type sites." - }, - "response": [ - { - "name": "Page of business partners matching the search criteria, may be empty", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sites?siteBpns=&legalEntityBpns=&name=&page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ], - "query": [ - { - "key": "siteBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"KY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IL\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AI\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"XU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LB\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"PS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed pagination request", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/sites?siteBpns=&legalEntityBpns=&name=&page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ], - "query": [ - { - "key": "siteBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/sites", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n },\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"VN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - }, - "description": "Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change." - }, - "response": [ - { - "name": "Update sites request was processed successfully, possible errors are returned", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n },\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"VN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"FK\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"UNDEFINED\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"AdditionalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"index\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"IT\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"LB\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GN\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"BE\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"AdditionalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"index\": \"\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"MainAddressIdentifierNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"MainAddressDuplicateIdentifier\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" - }, - { - "name": "On malformed requests", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n },\n {\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"VN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"JE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ]\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/sites", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BJ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"TV\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - }, - "description": "Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." - }, - "response": [ - { - "name": "New sites request was processed successfully, possible errors are returned", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BJ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"TV\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"DZ\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"UK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"TD\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CA\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"index\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YU\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AW\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"BS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"MG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"AdditionalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"index\": \"\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"MainAddressRegionNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"MainAddressRegionNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" - }, - { - "name": "On malformed requests", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AR\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SO\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnlParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"mainAddress\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"BJ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"TV\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/sites/search", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - }, - "description": "Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities" - }, - "response": [ - { - "name": "Found sites that belong to specified legal entites", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"KY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IL\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AI\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"XU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LB\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"PS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/sites/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "/members/sites/search", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/members/sites/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "members", - "sites", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "response": [ - { - "name": "OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/members/sites/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "members", - "sites", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"KY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IL\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AI\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"XU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LB\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"PS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"AT\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - } - ] - }, - { - "name": "/sites/:bpns", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sites/:bpns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - ":bpns" - ], - "variable": [ - { - "key": "bpns", - "value": "", - "description": "(Required) BPNS value" - } - ] - }, - "description": "Get business partners of type site by BPNS ignoring case." - }, - "response": [ - { - "name": "Found site with specified BPNS", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/sites/:bpns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - ":bpns" - ], - "variable": [ - { - "key": "bpns" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"bpnLegalEntity\": \"\",\n \"bpns\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"isCatenaXMemberData\": \"\",\n \"mainAddress\": {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GH\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SC\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AX\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"IN\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"name\": \"\",\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/sites/:bpns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - ":bpns" - ], - "variable": [ - { - "key": "bpns" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "No site found under specified BPNS", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/sites/:bpns", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "sites", - ":bpns" - ], - "variable": [ - { - "key": "bpns" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" } - ], - "description": "Read, create and update business partner of type site" - }, + ] + } + ], + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "{{TRANSFER_TOKEN}}", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "event": [ { - "name": "Bpn Controller", - "item": [ - { - "name": "/bpn/search", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"idType\": \"\",\n \"idValues\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/bpn/search", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "bpn", - "search" - ] - }, - "description": "Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries." - }, - "response": [ - { - "name": "Found bpn to identifier value mappings", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"idType\": \"\",\n \"idValues\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/bpn/search", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "bpn", - "search" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"bpn\": \"\",\n \"idValue\": \"\"\n },\n {\n \"bpn\": \"\",\n \"idValue\": \"\"\n }\n]" - }, - { - "name": "On malformed request parameters or if number of requested bpns exceeds limit", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"idType\": \"\",\n \"idValues\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/bpn/search", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "bpn", - "search" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "Specified identifier type not found", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"idType\": \"\",\n \"idValues\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/bpn/search", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "bpn", - "search" - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Support functionality for BPN operations" + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } }, { - "name": "Address Controller", + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Gate Input Full Access", + "item": [ + { + "name": "business-partner-controller", "item": [ { - "name": "/addresses", + "name": "/input/business-partners", "request": { - "method": "GET", + "method": "PUT", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "url": { - "raw": "{{baseUrl}}/addresses?addressBpns=&addressBpns=&legalEntityBpns=&legalEntityBpns=&siteBpns=&siteBpns=&name=&page=0&size=10", + "raw": "{{baseUrl}}/input/business-partners", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" - ], - "query": [ - { - "key": "addressBpns", - "value": "" - }, - { - "key": "addressBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "siteBpns", - "value": "" - }, - { - "key": "siteBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } + "input", + "business-partners" ] }, - "description": "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. " + "description": "Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries." }, "response": [ { - "name": "Page of addresses matching the search criteria, may be empty", + "name": "Business partner were successfully updated or created", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "Accept", "value": "application/json" } ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "url": { - "raw": "{{baseUrl}}/addresses?addressBpns=&legalEntityBpns=&siteBpns=&name=&page=0&size=10", + "raw": "{{baseUrl}}/input/business-partners", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" - ], - "query": [ - { - "key": "addressBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "siteBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } + "input", + "business-partners" ] } }, @@ -3886,48 +1498,36 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"VG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"ZR\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SR\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"FJ\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"FM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": -9176603.042994812,\n \"bpnL\": true,\n \"postalAddress\": 59945913.54383382\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"UA\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"PM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": 14856837.366659284,\n \"bpnL\": true,\n \"postalAddress\": 19278217\n }\n]" }, { - "name": "On malformed search or pagination request", + "name": "On malformed legal entity request", "originalRequest": { - "method": "GET", - "header": [], + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, "url": { - "raw": "{{baseUrl}}/addresses?addressBpns=&legalEntityBpns=&siteBpns=&name=&page=0&size=10", + "raw": "{{baseUrl}}/input/business-partners", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" - ], - "query": [ - { - "key": "addressBpns", - "value": "" - }, - { - "key": "legalEntityBpns", - "value": "" - }, - { - "key": "siteBpns", - "value": "" - }, - { - "key": "name", - "value": "" - }, - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } + "input", + "business-partners" ] } }, @@ -3941,9 +1541,9 @@ ] }, { - "name": "/addresses", + "name": "/input/business-partners/search", "request": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -3956,7 +1556,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"PE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MY\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -3965,21 +1565,35 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "input", + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] }, - "description": "Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change." + "description": "Get page of business partners filtered by a collection of external IDs." }, "response": [ { - "name": "The successfully updated records, possible errors are returned", + "name": "The requested page of busines partners", "originalRequest": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -3992,7 +1606,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"PE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MY\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -4001,12 +1615,26 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "input", + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] } }, @@ -4020,12 +1648,12 @@ } ], "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"MY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"HK\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"VI\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"GH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"GY\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CC\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"IdentifierNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"AddressNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" + "body": "{\n \"content\": [\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"DO\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"BM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": 15810926.717978239,\n \"bpnL\": \"dolore aliquip voluptate adipisicing\",\n \"postalAddress\": \"est non cupidatat\"\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MX\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"IL\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": \"incididunt velit proident\",\n \"bpnL\": -92389775,\n \"postalAddress\": 23082811\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { - "name": "On malformed requests", + "name": "On malformed pagination request", "originalRequest": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -4034,7 +1662,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"PE\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"MY\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"requestKey\": \"\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"SY\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n }\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -4043,12 +1671,26 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "input", + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] } }, @@ -4060,24 +1702,25 @@ "body": "" } ] - }, + } + ] + }, + { + "name": "sharing-state-controller", + "item": [ { - "name": "/addresses", + "name": "/sharing-state/ready", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"RS\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"GN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"UA\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", + "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4086,34 +1729,31 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/sharing-state/ready", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "sharing-state", + "ready" ] }, - "description": "Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." + "description": "The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach)." }, "response": [ { - "name": "New business partner record successfully created, possible errors are returned", + "name": "All business partners put in ready to be shared state", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" } ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"RS\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"GN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"UA\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", + "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4122,29 +1762,25 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/sharing-state/ready", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "sharing-state", + "ready" ] } }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [], "cookie": [], - "body": "{\n \"entities\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SH\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"UZ\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"LS\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"EG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"AdditionalAddress\",\n \"index\": \"\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"AX\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SU\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SE\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"PL\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"AdditionalAddress\",\n \"index\": \"\"\n }\n ],\n \"entityCount\": \"\",\n \"errorCount\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"AddressDuplicateIdentifier\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"BpnNotValid\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ]\n}" + "body": "" }, { - "name": "On malformed requests", + "name": "Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)", "originalRequest": { "method": "POST", "header": [ @@ -4155,7 +1791,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"RS\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"INACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"AQ\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n },\n {\n \"bpnParent\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": \"GN\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": \"UA\",\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"index\": \"\",\n \"requestKey\": \"\"\n }\n]", + "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4164,12 +1800,13 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses", + "raw": "{{baseUrl}}/sharing-state/ready", "host": [ "{{baseUrl}}" ], "path": [ - "addresses" + "sharing-state", + "ready" ] } }, @@ -4183,38 +1820,22 @@ ] }, { - "name": "/members/addresses/search", + "name": "/sharing-state", "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" } - }, + ], "url": { - "raw": "{{baseUrl}}/members/addresses/search?page=0&size=10", + "raw": "{{baseUrl}}/sharing-state?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "members", - "addresses", - "search" + "sharing-state" ], "query": [ { @@ -4232,38 +1853,22 @@ }, "response": [ { - "name": "OK", + "name": "Page of sharing states", "originalRequest": { - "method": "POST", + "method": "GET", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/members/addresses/search?page=0&size=10", + "raw": "{{baseUrl}}/sharing-state?page=0&size=10&businessPartnerType=ADDRESS&externalIds=", "host": [ "{{baseUrl}}" ], "path": [ - "members", - "addresses", - "search" + "sharing-state" ], "query": [ { @@ -4275,6 +1880,16 @@ "key": "size", "value": "10", "description": "Size of each page" + }, + { + "key": "businessPartnerType", + "value": "ADDRESS", + "description": "Business partner type" + }, + { + "key": "externalIds", + "value": "", + "description": "External IDs" } ] } @@ -4289,12 +1904,17 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"VG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"ZR\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SR\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "{\n \"content\": [\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Initial\",\n \"sharingErrorCode\": \"MissingTaskID\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n },\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Pending\",\n \"sharingErrorCode\": \"BpnNotInPool\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" } ] - }, + } + ] + }, + { + "name": "changelog-controller", + "item": [ { - "name": "/addresses/search", + "name": "/input/changelog/search", "request": { "method": "POST", "header": [ @@ -4309,7 +1929,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4318,12 +1938,13 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses", + "input", + "changelog", "search" ], "query": [ @@ -4339,11 +1960,11 @@ } ] }, - "description": "Search business partners of type address by their BPNA or their parents' BPNL or BPNS." + "description": "Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type." }, "response": [ { - "name": "Found sites for the specified sites and legal entities", + "name": "The changelog entries for the specified parameters", "originalRequest": { "method": "POST", "header": [ @@ -4358,7 +1979,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4367,12 +1988,13 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses", + "input", + "changelog", "search" ], "query": [ @@ -4399,7 +2021,7 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"RE\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"VG\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"YT\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SK\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n {\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"ZR\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CH\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"SR\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"SO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"LegalAddress\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "{\n \"content\": [\n {\n \"changelogType\": \"CREATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"changelogType\": \"UPDATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ],\n \"invalidEntries\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { "name": "On malformed pagination request", @@ -4413,7 +2035,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"addressBpns\": [\n \"\",\n \"\"\n ],\n \"legalEntityBpns\": [\n \"\",\n \"\"\n ],\n \"siteBpns\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4422,12 +2044,13 @@ } }, "url": { - "raw": "{{baseUrl}}/addresses/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "addresses", + "input", + "changelog", "search" ], "query": [ @@ -4452,9 +2075,199 @@ "body": "" } ] + } + ] + }, + { + "name": "stats-controller", + "item": [ + { + "name": "/stats/:stage/address-types", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/:stage/address-types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + ":stage", + "address-types" + ], + "variable": [ + { + "key": "stage", + "value": "Input", + "description": "(Required) " + } + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/:stage/address-types", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + ":stage", + "address-types" + ], + "variable": [ + { + "key": "stage" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"additionalTotal\": \"\",\n \"legalAndSiteTotal\": \"\",\n \"legalTotal\": \"\",\n \"siteTotal\": \"\"\n}" + } + ] + }, + { + "name": "/stats/stages", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/stages", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "stages" + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/stages", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "stages" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"inputTotal\": \"\",\n \"outputTotal\": \"\"\n}" + } + ] + }, + { + "name": "/stats/sharing-states", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/sharing-states", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "sharing-states" + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/sharing-states", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "sharing-states" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"errorTotal\": \"\",\n \"initialTotal\": \"\",\n \"pendingTotal\": \"\",\n \"readyTotal\": \"\",\n \"successTotal\": \"\"\n}" + } + ] }, { - "name": "/addresses/:bpna", + "name": "/stats/confidence-criteria", "request": { "method": "GET", "header": [ @@ -4464,27 +2277,19 @@ } ], "url": { - "raw": "{{baseUrl}}/addresses/:bpna", + "raw": "{{baseUrl}}/stats/confidence-criteria", "host": [ "{{baseUrl}}" ], "path": [ - "addresses", - ":bpna" - ], - "variable": [ - { - "key": "bpna", - "value": "", - "description": "(Required) BPNA value" - } + "stats", + "confidence-criteria" ] - }, - "description": "Get business partners of type address by BPNA ignoring case." + } }, "response": [ { - "name": "Found address with specified BPNA", + "name": "OK", "originalRequest": { "method": "GET", "header": [ @@ -4494,18 +2299,13 @@ } ], "url": { - "raw": "{{baseUrl}}/addresses/:bpna", + "raw": "{{baseUrl}}/stats/confidence-criteria", "host": [ "{{baseUrl}}" ], "path": [ - "addresses", - ":bpna" - ], - "variable": [ - { - "key": "bpna" - } + "stats", + "confidence-criteria" ] } }, @@ -4519,68 +2319,11 @@ } ], "cookie": [], - "body": "{\n \"bpna\": \"\",\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"createdAt\": \"\",\n \"identifiers\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"\"\n },\n \"value\": \"\"\n }\n ],\n \"isCatenaXMemberData\": \"\",\n \"physicalPostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"MY\"\n },\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"CF\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"district\": \"\",\n \"street\": {\n \"name\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\",\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"ACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n },\n {\n \"type\": {\n \"name\": \"\",\n \"technicalKey\": \"INACTIVE\"\n },\n \"validFrom\": \"\",\n \"validTo\": \"\"\n }\n ],\n \"updatedAt\": \"\",\n \"name\": \"\",\n \"alternativePostalAddress\": {\n \"city\": \"\",\n \"country\": {\n \"name\": \"\",\n \"technicalKey\": \"DZ\"\n },\n \"deliveryServiceNumber\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"administrativeAreaLevel1\": {\n \"countryCode\": \"BO\",\n \"regionCode\": \"\",\n \"regionName\": \"\"\n },\n \"postalCode\": \"\",\n \"deliveryServiceQualifier\": \"\"\n },\n \"bpnLegalEntity\": \"\",\n \"bpnSite\": \"\",\n \"addressType\": \"SiteMainAddress\"\n}" - }, - { - "name": "On malformed request parameters", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/addresses/:bpna", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "addresses", - ":bpna" - ], - "variable": [ - { - "key": "bpna" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" - }, - { - "name": "No address found under specified BPNA", - "originalRequest": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/addresses/:bpna", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "addresses", - ":bpna" - ], - "variable": [ - { - "key": "bpna" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "text", - "header": [], - "cookie": [], - "body": "" + "body": "{\n \"checkedByExternalDataSourceTotal\": \"\",\n \"confidenceLevelAverage\": \"\",\n \"numberOfBusinessPartnersAverage\": \"\",\n \"sharedByOwnerTotal\": \"\",\n \"uniqueTotal\": \"\"\n}" } ] } - ], - "description": "Read, create and update business partner of type address" + ] } ], "auth": { @@ -4622,15 +2365,15 @@ ] }, { - "name": "Gate API", + "name": "Gate Input Read Access", "item": [ { "name": "business-partner-controller", "item": [ { - "name": "/input/business-partners", + "name": "/input/business-partners/search", "request": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -4643,7 +2386,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -4652,22 +2395,35 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners" + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] }, - "description": "Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries." + "description": "Get page of business partners filtered by a collection of external IDs." }, "response": [ { - "name": "Business partner were successfully updated or created", + "name": "The requested page of busines partners", "originalRequest": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -4680,7 +2436,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -4689,13 +2445,26 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners" + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] } }, @@ -4709,12 +2478,12 @@ } ], "cookie": [], - "body": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"FJ\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"FM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": -9176603.042994812,\n \"bpnL\": true,\n \"postalAddress\": 59945913.54383382\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"UA\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"PM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": 14856837.366659284,\n \"bpnL\": true,\n \"postalAddress\": 19278217\n }\n]" + "body": "{\n \"content\": [\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"DO\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"BM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": 15810926.717978239,\n \"bpnL\": \"dolore aliquip voluptate adipisicing\",\n \"postalAddress\": \"est non cupidatat\"\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MX\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"IL\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": \"incididunt velit proident\",\n \"bpnL\": -92389775,\n \"postalAddress\": 23082811\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { - "name": "On malformed legal entity request", + "name": "On malformed pagination request", "originalRequest": { - "method": "PUT", + "method": "POST", "header": [ { "key": "Content-Type", @@ -4723,7 +2492,7 @@ ], "body": { "mode": "raw", - "raw": "[\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"AF\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"SD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ]\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"TP\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MD\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ]\n }\n]", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -4732,13 +2501,26 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners", + "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners" + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } ] } }, @@ -4750,40 +2532,29 @@ "body": "" } ] - }, + } + ] + }, + { + "name": "sharing-state-controller", + "item": [ { - "name": "/output/business-partners/search", + "name": "/sharing-state", "request": { - "method": "POST", + "method": "GET", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", + "raw": "{{baseUrl}}/sharing-state?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "output", - "business-partners", - "search" + "sharing-state" ], "query": [ { @@ -4797,43 +2568,26 @@ "description": "Size of each page" } ] - }, - "description": "Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners." + } }, "response": [ { - "name": "The requested page of business partners", + "name": "Page of sharing states", "originalRequest": { - "method": "POST", + "method": "GET", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", + "raw": "{{baseUrl}}/sharing-state?page=0&size=10&businessPartnerType=ADDRESS&externalIds=", "host": [ "{{baseUrl}}" ], "path": [ - "output", - "business-partners", - "search" + "sharing-state" ], "query": [ { @@ -4845,77 +2599,41 @@ "key": "size", "value": "10", "description": "Size of each page" + }, + { + "key": "businessPartnerType", + "value": "ADDRESS", + "description": "Business partner type" + }, + { + "key": "externalIds", + "value": "", + "description": "External IDs" } ] } }, "status": "OK", "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"content\": [\n {\n \"address\": {\n \"addressBpn\": \"\",\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"ZA\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"EA\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"legalEntityBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"site\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"siteBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\"\n }\n },\n {\n \"address\": {\n \"addressBpn\": \"\",\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"JM\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"KE\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"legalEntityBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"site\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"siteBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" - }, - { - "name": "On malformed pagination request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "output", - "business-partners", - "search" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - } - ] + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], + ], "cookie": [], - "body": "" + "body": "{\n \"content\": [\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Initial\",\n \"sharingErrorCode\": \"MissingTaskID\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n },\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Pending\",\n \"sharingErrorCode\": \"BpnNotInPool\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" } ] - }, + } + ] + }, + { + "name": "changelog-controller", + "item": [ { - "name": "/input/business-partners/search", + "name": "/input/changelog/search", "request": { "method": "POST", "header": [ @@ -4930,7 +2648,7 @@ ], "body": { "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4939,13 +2657,13 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners", + "changelog", "search" ], "query": [ @@ -4961,11 +2679,11 @@ } ] }, - "description": "Get page of business partners filtered by a collection of external IDs." + "description": "Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type." }, "response": [ { - "name": "The requested page of busines partners", + "name": "The changelog entries for the specified parameters", "originalRequest": { "method": "POST", "header": [ @@ -4980,7 +2698,7 @@ ], "body": { "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -4989,13 +2707,13 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners", + "changelog", "search" ], "query": [ @@ -5022,7 +2740,7 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"DO\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"BM\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": 15810926.717978239,\n \"bpnL\": \"dolore aliquip voluptate adipisicing\",\n \"postalAddress\": \"est non cupidatat\"\n },\n {\n \"address\": {\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"MX\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"BOITE_POSTALE\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"IL\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"addressBpn\": \"\",\n \"name\": \"\",\n \"addressType\": \"LegalAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"legalEntityBpn\": \"\",\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"CUSTOMER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"site\": {\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"siteBpn\": \"\",\n \"name\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"bpnA\": \"incididunt velit proident\",\n \"bpnL\": -92389775,\n \"postalAddress\": 23082811\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "{\n \"content\": [\n {\n \"changelogType\": \"CREATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"changelogType\": \"UPDATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ],\n \"invalidEntries\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { "name": "On malformed pagination request", @@ -5036,7 +2754,7 @@ ], "body": { "mode": "raw", - "raw": "[\n \"\",\n \"\"\n]", + "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -5045,13 +2763,13 @@ } }, "url": { - "raw": "{{baseUrl}}/input/business-partners/search?page=0&size=10", + "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "input", - "business-partners", + "changelog", "search" ], "query": [ @@ -5080,121 +2798,138 @@ ] }, { - "name": "sharing-state-controller", + "name": "stats-controller", "item": [ { - "name": "/sharing-state/ready", + "name": "/stats/:stage/address-types", "request": { - "method": "POST", + "method": "GET", "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/sharing-state/ready", + "raw": "{{baseUrl}}/stats/:stage/address-types", "host": [ "{{baseUrl}}" ], "path": [ - "sharing-state", - "ready" + "stats", + ":stage", + "address-types" + ], + "variable": [ + { + "key": "stage", + "value": "Input", + "description": "(Required) " + } ] - }, - "description": "The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach)." + } }, "response": [ { - "name": "All business partners put in ready to be shared state", + "name": "OK", "originalRequest": { - "method": "POST", + "method": "GET", "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/sharing-state/ready", + "raw": "{{baseUrl}}/stats/:stage/address-types", "host": [ "{{baseUrl}}" ], "path": [ - "sharing-state", - "ready" + "stats", + ":stage", + "address-types" + ], + "variable": [ + { + "key": "stage" + } ] } }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [], + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "cookie": [], - "body": "" - }, + "body": "{\n \"additionalTotal\": \"\",\n \"legalAndSiteTotal\": \"\",\n \"legalTotal\": \"\",\n \"siteTotal\": \"\"\n}" + } + ] + }, + { + "name": "/stats/stages", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/stages", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "stages" + ] + } + }, + "response": [ { - "name": "Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)", + "name": "OK", "originalRequest": { - "method": "POST", + "method": "GET", "header": [ { - "key": "Content-Type", + "key": "Accept", "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "headerFamily": "json", - "language": "json" - } - } - }, "url": { - "raw": "{{baseUrl}}/sharing-state/ready", + "raw": "{{baseUrl}}/stats/stages", "host": [ "{{baseUrl}}" ], "path": [ - "sharing-state", - "ready" + "stats", + "stages" ] } }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "text", - "header": [], + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], "cookie": [], - "body": "" + "body": "{\n \"inputTotal\": \"\",\n \"outputTotal\": \"\"\n}" } ] }, { - "name": "/sharing-state", + "name": "/stats/sharing-states", "request": { "method": "GET", "header": [ @@ -5204,45 +2939,76 @@ } ], "url": { - "raw": "{{baseUrl}}/sharing-state?page=0&size=10&businessPartnerType=ADDRESS&externalIds=&externalIds=", + "raw": "{{baseUrl}}/stats/sharing-states", "host": [ "{{baseUrl}}" ], "path": [ - "sharing-state" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - }, - { - "key": "businessPartnerType", - "value": "ADDRESS", - "description": "Business partner type" - }, - { - "key": "externalIds", - "value": "", - "description": "External IDs" - }, + "stats", + "sharing-states" + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/sharing-states", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "sharing-states" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ { - "key": "externalIds", - "value": "", - "description": "External IDs" + "key": "Content-Type", + "value": "application/json" } + ], + "cookie": [], + "body": "{\n \"errorTotal\": \"\",\n \"initialTotal\": \"\",\n \"pendingTotal\": \"\",\n \"readyTotal\": \"\",\n \"successTotal\": \"\"\n}" + } + ] + }, + { + "name": "/stats/confidence-criteria", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/stats/confidence-criteria", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "stats", + "confidence-criteria" ] } }, "response": [ { - "name": "Page of sharing states", + "name": "OK", "originalRequest": { "method": "GET", "header": [ @@ -5252,34 +3018,13 @@ } ], "url": { - "raw": "{{baseUrl}}/sharing-state?page=0&size=10&businessPartnerType=ADDRESS&externalIds=", + "raw": "{{baseUrl}}/stats/confidence-criteria", "host": [ "{{baseUrl}}" ], "path": [ - "sharing-state" - ], - "query": [ - { - "key": "page", - "value": "0", - "description": "Number of page to get results from" - }, - { - "key": "size", - "value": "10", - "description": "Size of each page" - }, - { - "key": "businessPartnerType", - "value": "ADDRESS", - "description": "Business partner type" - }, - { - "key": "externalIds", - "value": "", - "description": "External IDs" - } + "stats", + "confidence-criteria" ] } }, @@ -5293,17 +3038,59 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Initial\",\n \"sharingErrorCode\": \"MissingTaskID\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n },\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Pending\",\n \"sharingErrorCode\": \"BpnNotInPool\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "{\n \"checkedByExternalDataSourceTotal\": \"\",\n \"confidenceLevelAverage\": \"\",\n \"numberOfBusinessPartnersAverage\": \"\",\n \"sharedByOwnerTotal\": \"\",\n \"uniqueTotal\": \"\"\n}" } ] } ] + } + ], + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "{{TRANSFER_TOKEN}}", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } }, { - "name": "changelog-controller", + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Gate Output Read Access", + "item": [ + { + "name": "business-partner-controller", "item": [ { - "name": "/output/changelog/search", + "name": "/output/business-partners/search", "request": { "method": "POST", "header": [ @@ -5318,7 +3105,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -5327,13 +3114,13 @@ } }, "url": { - "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "output", - "changelog", + "business-partners", "search" ], "query": [ @@ -5349,11 +3136,11 @@ } ] }, - "description": "Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type." + "description": "Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners." }, "response": [ { - "name": "The changelog entries for the specified parameters", + "name": "The requested page of business partners", "originalRequest": { "method": "POST", "header": [ @@ -5368,7 +3155,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -5377,13 +3164,13 @@ } }, "url": { - "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "output", - "changelog", + "business-partners", "search" ], "query": [ @@ -5410,7 +3197,7 @@ } ], "cookie": [], - "body": "{\n \"content\": [\n {\n \"changelogType\": \"CREATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"changelogType\": \"UPDATE\",\n \"externalId\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n },\n {\n \"errorCode\": \"ExternalIdNotFound\",\n \"message\": \"\",\n \"entityKey\": \"\"\n }\n ],\n \"invalidEntries\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + "body": "{\n \"content\": [\n {\n \"address\": {\n \"addressBpn\": \"\",\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"ZA\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PRIVATE_BAG\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"EA\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\",\n \"addressType\": \"SiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"legalEntityBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"ONE_TIME_SUPPLIER\",\n \"ONE_TIME_CUSTOMER\"\n ],\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"site\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"siteBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\"\n }\n },\n {\n \"address\": {\n \"addressBpn\": \"\",\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"JM\",\n \"administrativeAreaLevel1\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"\",\n \"deliveryServiceNumber\": \"\"\n },\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"altitude\": \"\"\n },\n \"country\": \"KE\",\n \"administrativeAreaLevel1\": \"\",\n \"administrativeAreaLevel2\": \"\",\n \"administrativeAreaLevel3\": \"\",\n \"postalCode\": \"\",\n \"city\": \"\",\n \"district\": \"\",\n \"street\": {\n \"namePrefix\": \"\",\n \"additionalNamePrefix\": \"\",\n \"name\": \"\",\n \"nameSuffix\": \"\",\n \"additionalNameSuffix\": \"\",\n \"houseNumber\": \"\",\n \"houseNumberSupplement\": \"\",\n \"milestone\": \"\",\n \"direction\": \"\"\n },\n \"companyPostalCode\": \"\",\n \"industrialZone\": \"\",\n \"building\": \"\",\n \"floor\": \"\",\n \"door\": \"\"\n },\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"name\": \"\",\n \"addressType\": \"LegalAndSiteMainAddress\"\n },\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"identifiers\": [\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n },\n {\n \"type\": \"\",\n \"value\": \"\",\n \"issuingBody\": \"\"\n }\n ],\n \"isOwnCompanyData\": \"\",\n \"legalEntity\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"legalEntityBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"INACTIVE\"\n }\n ],\n \"legalName\": \"\",\n \"shortName\": \"\",\n \"legalForm\": \"\"\n },\n \"nameParts\": [\n \"\",\n \"\"\n ],\n \"roles\": [\n \"SUPPLIER\",\n \"ONE_TIME_SUPPLIER\"\n ],\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"updatedAt\": \"\",\n \"site\": {\n \"confidenceCriteria\": {\n \"checkedByExternalDataSource\": \"\",\n \"confidenceLevel\": \"\",\n \"lastConfidenceCheckAt\": \"\",\n \"nextConfidenceCheckAt\": \"\",\n \"numberOfSharingMembers\": \"\",\n \"sharedByOwner\": \"\"\n },\n \"siteBpn\": \"\",\n \"states\": [\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n },\n {\n \"validFrom\": \"\",\n \"validTo\": \"\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"name\": \"\"\n }\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" }, { "name": "On malformed pagination request", @@ -5424,7 +3211,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"timestampAfter\": \"\",\n \"externalIds\": [\n \"\",\n \"\"\n ]\n}", + "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", @@ -5433,13 +3220,13 @@ } }, "url": { - "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/business-partners/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ "output", - "changelog", + "business-partners", "search" ], "query": [ @@ -5464,9 +3251,108 @@ "body": "" } ] - }, + } + ] + }, + { + "name": "sharing-state-controller", + "item": [ { - "name": "/input/changelog/search", + "name": "/sharing-state", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/sharing-state?page=0&size=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sharing-state" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + } + ] + } + }, + "response": [ + { + "name": "Page of sharing states", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/sharing-state?page=0&size=10&businessPartnerType=ADDRESS&externalIds=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "sharing-state" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "10", + "description": "Size of each page" + }, + { + "key": "businessPartnerType", + "value": "ADDRESS", + "description": "Business partner type" + }, + { + "key": "externalIds", + "value": "", + "description": "External IDs" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Initial\",\n \"sharingErrorCode\": \"MissingTaskID\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n },\n {\n \"externalId\": \"\",\n \"sharingStateType\": \"Pending\",\n \"sharingErrorCode\": \"BpnNotInPool\",\n \"sharingErrorMessage\": \"\",\n \"sharingProcessStarted\": \"\",\n \"taskId\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "changelog-controller", + "item": [ + { + "name": "/output/changelog/search", "request": { "method": "POST", "header": [ @@ -5490,12 +3376,12 @@ } }, "url": { - "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "input", + "output", "changelog", "search" ], @@ -5512,7 +3398,7 @@ } ] }, - "description": "Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type." + "description": "Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type." }, "response": [ { @@ -5540,12 +3426,12 @@ } }, "url": { - "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "input", + "output", "changelog", "search" ], @@ -5596,12 +3482,12 @@ } }, "url": { - "raw": "{{baseUrl}}/input/changelog/search?page=0&size=10", + "raw": "{{baseUrl}}/output/changelog/search?page=0&size=10", "host": [ "{{baseUrl}}" ], "path": [ - "input", + "output", "changelog", "search" ], @@ -5974,23 +3860,18 @@ "type": "string" }, { - "key": "ASSET_ID_POOL_CX_MEMBER_READ", - "value": "b38da99b-bbac-4bcb-8a0b-589b0dc45ddc", - "type": "string" - }, - { - "key": "ASSET_ID_GATE_SHARING_MEMBER_FULL_INPUT", - "value": "08069c44-750b-415d-8469-0fb293bf5d08", + "key": "CONSUMER_BPNL", + "value": "BPNL0000000001XF", "type": "string" }, { - "key": "ASSET_ID_GATE_SHARING_MEMBER_READ_INPUT", - "value": "e5d8962f-6873-4693-8c58-56f53871438e", + "key": "PROVIDER_EDC_PUBLIC_API", + "value": "https://www.bpdm-edc.net/api/public", "type": "string" }, { - "key": "ASSET_ID_GATE_SHARING_MEMBER_READ_OUTPUT", - "value": "940546d7-e4a0-44d4-9c03-e3274c403985", + "key": "baseUrl", + "value": "{{PROVIDER_EDC_PUBLIC_API}}", "type": "string" }, { @@ -5998,11 +3879,6 @@ "value": "", "type": "string" }, - { - "key": "CONSUMER_BPNL", - "value": "BPNL0000000001XF", - "type": "string" - }, { "key": "NEGOTIATION", "value": "" @@ -6012,35 +3888,24 @@ "value": "", "type": "string" }, - { - "key": "TRANSFER", - "value": "", - "type": "string" - }, { "key": "TRANSFER_TOKEN", "value": "", "type": "string" }, - { - "key": "PROVIDER_EDC_PUBLIC_API", - "value": "https://www.bpdm-edc.net/api/public", - "type": "string" - }, { "key": "SELECTED_ASSET", "value": "", "type": "string" }, - { - "key": "baseUrl", - "value": "{{PROVIDER_EDC_PUBLIC_API}}", - "type": "string" - }, { "key": "SELECTED_PURPOSE", "value": "", "type": "string" + }, + { + "key": "TRANSFERPROCESS", + "value": "" } ] } \ No newline at end of file