diff --git a/.tractusx b/.tractusx index 29bd32e6ce5..4620c25dfd5 100644 --- a/.tractusx +++ b/.tractusx @@ -7,3 +7,7 @@ repositories: url: "https://github.com/eclipse-tractusx/eclipse-tractusx.github.io" openApiSpecs: - "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/dt/kit_digital-twin-kit-submodel-api_openAPI.yaml" +- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/bpdm/kit_business-partner-kit-cleaning-dummy_openAPI.yaml" +- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/bpdm/kit_business-partner-kit-gate_openAPI.yaml" +- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/bpdm/kit_business-partner-kit-orchestrator_openAPI.yaml" +- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/bpdm/kit_business-partner-kit-pool_openAPI.yaml" \ No newline at end of file diff --git a/DEPENDENCIES b/DEPENDENCIES index 37fe425a765..74fc085ec63 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -144,7 +144,7 @@ npm/npmjs/-/cose-base/2.2.0, MIT, approved, clearlydefined npm/npmjs/-/cosmiconfig/6.0.0, MIT, approved, clearlydefined npm/npmjs/-/cosmiconfig/7.1.0, MIT, approved, #4975 npm/npmjs/-/cross-fetch/3.1.5, MIT, approved, clearlydefined -npm/npmjs/-/cross-spawn/7.0.3, MIT, approved, clearlydefined +npm/npmjs/-/cross-spawn/7.0.3, MIT, approved, #17146 npm/npmjs/-/crypto-js/4.1.1, MIT AND BSD-2-Clause, approved, #6630 npm/npmjs/-/crypto-random-string/2.0.0, MIT, approved, clearlydefined npm/npmjs/-/css-declaration-sorter/6.3.1, ISC, approved, clearlydefined diff --git a/blog-meeting-minutes/2024-11-08-community-hour.md b/blog-meeting-minutes/2024-11-08-community-hour.md new file mode 100644 index 00000000000..756912a570f --- /dev/null +++ b/blog-meeting-minutes/2024-11-08-community-hour.md @@ -0,0 +1,42 @@ +--- +slug: community-office-hour-2024-11-08 +title: Community Office Hour 2024-11-08 +authors: + - tom-rm-meyer-ISST +tags: [community, meeting-minutes] +--- + +## Office Hour meeting minutes + +### Infrastructure + +- Test Environments: + - STABLE environment24.12 installations in early december + - Test Management: Reference Quality Gate Checks and walkthrough them in "Test Management" + - Resolved Issue with SAP DIV -> Onboarding should work now + +### Release Management + +- Reminders + - use TX EDC 0.8.0 RC5 -> RC6 is on its way -> Rediscuss in testmanagement daily during next week + - we should improve test automation -> the umbrella helm chart targets to support that + - reminder for open planning + +### Security + +- GitGuardian will be removed soon. + +### FOSS + +- [TRG 7.09](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/pull/1045) +- discuss how to document releases between ecosystem releases and deployment experiences -> ongoing / announcement +- TRG about testing will come up +- Mano's election ended. Reminders + - small amount of participations + - points that would have been great: participation in community & handling of TRGs etc. +- ClearlyDefined is down: revisit on next week and then ask via IP matrix check +- MDX files in KITs: only if needed, is CC-BY-4.0 + +### Community/Open Planning + +- remove the .cal file and just state the time (in an international time format) diff --git a/blog/2024-11-06-tx-edc-bugfix.md b/blog/2024-11-06-tx-edc-bugfix.md new file mode 100644 index 00000000000..4fde01ebd1c --- /dev/null +++ b/blog/2024-11-06-tx-edc-bugfix.md @@ -0,0 +1,32 @@ +--- +title: Tractus-X EDC Bugfix Release 0.7.7 +description: Release of a new Tractus-X EDC bugfix version +slug: new-bugfix-release-edc-077 +date: 2024-11-06 +hide_table_of_contents: false +authors: + - name: Lars Geyer-Blaumeiser + title: EDC Responsible + url: https://github.com/lgblaumeiser + image_url: https://github.com/lgblaumeiser.png + email: lars.blaumeiser@cofinity-x.com +--- + +## New Bugfix Release 0.7.7 for Eclipse Tractus-X EDC + +The new bugfix release 0.7.7 of the Eclipse Tractus-X EDC is now available. + +The release fixes one bug: + +- Issue: [tractusx-edc/1618](https://github.com/eclipse-tractusx/tractusx-edc/issues/1618) +- Pull Request: [tractusx-edc/1633](https://github.com/eclipse-tractusx/tractusx-edc/pull/1633) +- Summary: The fixed issue was a non-deterministic behavior in case of parallel EDR token refreshs which lead to the non-availability of a valid token at the consumer connector. +- You need to update if you operate a consumer EDC and initiate data transfers based on the same contract multiple times in parallel. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Cofinity-X GmbH +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/blog/2024-11-13-open-planning-R25.03.mdx b/blog/2024-11-13-open-planning-R25.03.mdx index 4e8581c50da..bc1dbbbc85a 100644 --- a/blog/2024-11-13-open-planning-R25.03.mdx +++ b/blog/2024-11-13-open-planning-R25.03.mdx @@ -55,16 +55,25 @@ feature requesters are encouraged to attend and actively engage in the discussio ### First Day: November 13th - **09:05 - 09:30**: Open Planning - Vision & Introduction - **09:30 - 12:00**: Joint Open Planning (all teams) + - **09:30 - 09:35**: [NSC](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+Committee) (2) + - **09:35 - 10:05**: [NSC - Dataspace Connectivity](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+Dataspace+Connectivity) (7) + - **10:05 - 10:35**: [NSC - BPDM](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+BPDM) (6) + - **10:35 - 10:45**: [NSC - DT](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+DT) (2) + - **10:45 - 11:55**: [NSC - Portal](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+Portal) (21) + - **11:55 - 12:00**: [NSC - SSI](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=NSC+-+SSI) (1) ### Second Day: November 14th - **09:05 - 11:00**: Joint Open Planning (all teams) + - **09:05 - 09:20**: [SUS](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=-status%3ADone+has%3Asupported-by+label%3A%22Prep-R25.03%22+supported-by%3A%22SUS+-+PCF+-+on+Electronics%22%2C%22SUS+-+PCF+-+Secondary+Data+Provision%22%2C%22SUS+-+Commitee%22%2C%22SUS+-+DPP%22%2C%22SUS+-+Circularity%22%2C%22SUS+-+Human+Rights%22%2C%22SUS+-+PCF+-+Methodology+%26+Verification%22%2C%22SUS+-+PCF+-+Architecture+%26+Interoperability%22%2C) (4) + - **09:20 - 09:30**: [PQR - Traceability](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=PQR+-+Traceability) (2) + - **09:30 - 09:40**: [PQR - DCM](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=PQR+-+DCM) (3) + - **09:40 - 09:50**: [PQR - Puris](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=PQR+-+PURIS) (3) + - **09:50 - 10:50**: [IC](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=IC+-+Committee) (17) + - **10:50 - 10:55**: [Test Management](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=Testmanagement) (2) + - **10:55 - 11:00**: [Architecture Management](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?sliceBy%5Bvalue%5D=ARC+-+Committee) (1) - **11:00 - 11:30**: Confidence Vote & Feedback Retro - **11:30 - 12:00**: Open Planning Wrap-Up / Summary & Next Steps -:::note -A detailed agenda will be shared with all participants before the event. Since the agenda is dependent on the refined features it might be on short notoce.note -::: - The planning sessions will be driven by our [Release Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=-status%3ADone+has%3Asupported-by+label%3A%22Prep-R25.03%22+status%3ABacklog), which organizes features based on their **supported-by** field. ## Prerequisites for features to be considered in Open Planning diff --git a/blog/2024-12-05-community-days.mdx b/blog/2024-12-05-community-days.mdx index 7e2995cd378..d312cad4db0 100644 --- a/blog/2024-12-05-community-days.mdx +++ b/blog/2024-12-05-community-days.mdx @@ -36,13 +36,17 @@ about pushing the boundaries of technology and innovation. Here’s why you can - **Presentations:** Learn more about use cases, apps, KITs, releases, and more – even without programming knowledge. - **New Format:** We are introducing a refreshed format this year that enhances collaboration and innovation. Explore our interim agenda below, which will be expanded with more details soon! -![community days - agenda](@site/static/img/tractus-x-community-days-agenda-24-12.png) +#### Agenda day 1 -:::note +:::info +If you want to download the agenda, click [here](https://arena2036.de/files/FinaleBilder/05_Veranstaltungen/ARENA-X/Third_Eclipse_Tractus-X_Community_Days/Agenda%20Day%201%20and%202.pdf). +::: -You will get more information about the agenda and detailed information about the future workstreams. Stay tuned! We are in preperation and will update you soon. +![community days - agenda - day 1](@site/static/img/tractus-x-community-days-agenda-24-12-day1.png) -::: +#### Agenda day 2 + +![community days - agenda - day 2](@site/static/img/tractus-x-community-days-agenda-24-12-day2.png) ### What’s New? diff --git a/community/open-meetings.mdx b/community/open-meetings.mdx index 0d459b3e1ed..bf8d385b339 100644 --- a/community/open-meetings.mdx +++ b/community/open-meetings.mdx @@ -12,7 +12,6 @@ These are dedicated sync meetings for specific products, as well as open plannin description="Open house meeting to support with anything EDC related. You have questions about EDC, problems running/ configuring EDC in your environment or want to know what´s next in EDC and when to expect? This is the place to ask all these questions." contact="lars.blaumeiser@cofinity-x.com" sessionLink="https://eclipse.zoom.us/j/85945828202?pwd=YODkCen20BOQV9WNJEeNFM8zaOlxo9.1" - meetingLink="/meetings/edc-weekly-extended.ics" /> @@ -116,8 +114,8 @@ These are dedicated sync meetings for specific products, as well as open plannin contact="stephan.bauer@catena-x.net" additionalLinks={ [ - {title: "Draft Feature Freeze (Working Model)", url: "https://catenax-ev.github.io/docs/next/working-model/release-management/planning/draft-feature-freeze"}, - {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=-status%3ADone+has%3Asupported-by+label%3A%22Prep-R25.03%22"}, + {title: "Draft Feature Freeze (Working Model)", url: "https://catenax-ev.github.io/docs/working-model/release-management/planning/tx-draft-feature-freeze"}, + {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=label%3A%22Prep-R25.03%22+-status%3ADone"}, {title: "Timeline", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/35?filterQuery=label%3Ametadata+milestone%3A25.03+"} ] } @@ -131,9 +129,11 @@ These are dedicated sync meetings for specific products, as well as open plannin meetingLink="/meetings/refinement-day-2---release-2503.ics" additionalLinks={ [ - {title: "Refinement Day (Working Model)", url: "https://catenax-ev.github.io/docs/next/working-model/release-management/planning/refinement-day"}, - {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=-status%3ADone+has%3Asupported-by+label%3A%22Prep-R25.03%22"}, - {title: "Timeline", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/35?filterQuery=label%3Ametadata+milestone%3A25.03+"} + {title: "Refinement Day (Working Model)", url: "https://catenax-ev.github.io/docs/working-model/release-management/planning/tx-refinement-day"}, + {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=label%3A%22Prep-R25.03%22+-status%3ADone"}, + {title: "Timeline", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/35?filterQuery=label%3Ametadata+milestone%3A25.03+"}, + {title: "News Blog", url: "https://eclipse-tractusx.github.io/blog/refinement-day-2-R25.03"}, + {title: "Refinement Sessions", url: "https://eclipse-tractusx.github.io/blog/refinement-day-2-R25.03#committeeexpert-groups-and-teams-sessions"} ] } /> @@ -146,9 +146,11 @@ These are dedicated sync meetings for specific products, as well as open plannin meetingLink="/meetings/release-planning-days---release-2503.ics" additionalLinks={ [ - {title: "Release Planning Days (Working Model)", url: "https://catenax-ev.github.io/docs/next/working-model/release-management/planning/release-planning-days"}, - {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/28?filterQuery=-status%3ADone+has%3Asupported-by+label%3A%22Prep-R25.03%22"}, - {title: "Timeline", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/35?filterQuery=label%3Ametadata+milestone%3A25.03+"} + {title: "Release Planning Days (Working Model)", url: "https://catenax-ev.github.io/docs/working-model/release-management/planning/tx-release-planning-days"}, + {title: "Release Planning Board - Supported (GitHub)", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/39?filterQuery=label%3A%22Prep-R25.03%22++-status%3ADone+status%3ABacklog"}, + {title: "Timeline", url: "https://github.com/orgs/eclipse-tractusx/projects/26/views/35?filterQuery=label%3Ametadata+milestone%3A25.03+"}, + {title: "News Blog", url: "https://eclipse-tractusx.github.io/blog/open-planning-R25.03"}, + {title: "Detailed Agenda", url: "https://eclipse-tractusx.github.io/blog/open-planning-R25.03#agenda"}, ] } /> diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx deleted file mode 100644 index e36c4f6fe49..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-cleaning-service-dummy -title: "Business Partner Data Management Cleaning Service Dummy" -description: "Place holder for the cleaning service provider" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.1.0 - -# Business Partner Data Management Cleaning Service Dummy - - - -Place holder for the cleaning service provider - - - \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js b/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js deleted file mode 100644 index 84f6658d5b7..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy"}]; \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx deleted file mode 100644 index 6f86b6eea71..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-gate -title: "Business Partner Data Management Gate" -description: "A gate for a member to share business partner data with CatenaX" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.1.0 - -# Business Partner Data Management Gate - - - -A gate for a member to share business partner data with CatenaX - - - \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx deleted file mode 100644 index 806611a2c8b..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-address-types -title: "countAddressTypes" -description: "countAddressTypes" -sidebar_label: "countAddressTypes" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countAddressTypes","parameters":[{"name":"stage","in":"path","required":true,"schema":{"type":"string","enum":["Input","Output"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["additionalTotal","legalAndSiteTotal","legalTotal","siteTotal"],"type":"object","properties":{"legalAndSiteTotal":{"type":"integer","format":"int32"},"legalTotal":{"type":"integer","format":"int32"},"siteTotal":{"type":"integer","format":"int32"},"additionalTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countAddressTypes","method":"get","path":"/v6/stats/{stage}/address-types","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"count Address Types","description":{"type":"text/plain"},"url":{"path":["v6","stats",":stage","address-types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"stage"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countAddressTypes - - - -countAddressTypes - -
Path Parameters
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx deleted file mode 100644 index a0b45cd895c..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-partners-by-sharing-state -title: "countPartnersBySharingState" -description: "countPartnersBySharingState" -sidebar_label: "countPartnersBySharingState" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countPartnersBySharingState","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["errorTotal","initialTotal","pendingTotal","readyTotal","successTotal"],"type":"object","properties":{"initialTotal":{"type":"integer","format":"int32"},"readyTotal":{"type":"integer","format":"int32"},"pendingTotal":{"type":"integer","format":"int32"},"successTotal":{"type":"integer","format":"int32"},"errorTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countPartnersBySharingState","method":"get","path":"/v6/stats/sharing-states","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"count Partners By Sharing State","description":{"type":"text/plain"},"url":{"path":["v6","stats","sharing-states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countPartnersBySharingState - - - -countPartnersBySharingState - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx deleted file mode 100644 index 56fa5ea4888..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-partners-per-stage -title: "countPartnersPerStage" -description: "countPartnersPerStage" -sidebar_label: "countPartnersPerStage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countPartnersPerStage","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["inputTotal","outputTotal"],"type":"object","properties":{"inputTotal":{"type":"integer","format":"int32"},"outputTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countPartnersPerStage","method":"get","path":"/v6/stats/stages","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"count Partners Per Stage","description":{"type":"text/plain"},"url":{"path":["v6","stats","stages"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countPartnersPerStage - - - -countPartnersPerStage - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx deleted file mode 100644 index bc4c9c18201..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-business-partners-input -title: "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners." -description: "Get page of business partners filtered by a collection of external IDs." -sidebar_label: "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners." -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"Get page of business partners filtered by a collection of external IDs.","operationId":"getBusinessPartnersInput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of busines partners","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/input/business-partners/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.","description":{"content":"Get page of business partners filtered by a collection of external IDs.","type":"text/plain"},"url":{"path":["v6","input","business-partners","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search business partner by external ID. An empty external ID list returns a paginated list of all business partners. - - - -Get page of business partners filtered by a collection of external IDs. - -
Query Parameters
Request Body array
  • string
- -The requested page of busines partners - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx deleted file mode 100644 index ba73f0baeb7..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-business-partners-output -title: "Search business partners by an array of external IDs from the output stage" -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." -sidebar_label: "Search business partners by an array of external IDs from the output stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"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.","operationId":"getBusinessPartnersOutput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of business partners","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["address","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","roles","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["bpnL","confidenceCriteria","legalEntityBpn","states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Legal Entity properties of business partner output data"},"site":{"required":["confidenceCriteria","siteBpn","states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Site properties of business partner output data"},"address":{"required":["addressBpn","bpnA","confidenceCriteria","physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Address properties of business partner output data"},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner output with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/output/business-partners/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Search business partners by an array of external IDs from the output stage","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","output","business-partners","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search business partners by an array of external IDs from the output stage - - - -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. - -
Query Parameters
Request Body array
  • string
- -The requested page of business partners - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -Legal Entity properties of business partner output data - -
    confidenceCriteria object
    states object[]
    site object
    - -Site properties of business partner output data - -
    confidenceCriteria object
    states object[]
    address object
    - -Address properties of business partner output data - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object
    states object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx deleted file mode 100644 index 3e18595d536..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-confidence-criteria-stats -title: "getConfidenceCriteriaStats" -description: "getConfidenceCriteriaStats" -sidebar_label: "getConfidenceCriteriaStats" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"getConfidenceCriteriaStats","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["checkedByExternalDataSourceTotal","confidenceLevelAverage","numberOfBusinessPartnersAverage","sharedByOwnerTotal","uniqueTotal"],"type":"object","properties":{"numberOfBusinessPartnersAverage":{"type":"number","format":"float"},"uniqueTotal":{"type":"integer","format":"int64"},"sharedByOwnerTotal":{"type":"integer","format":"int64"},"checkedByExternalDataSourceTotal":{"type":"integer","format":"int64"},"confidenceLevelAverage":{"type":"number","format":"float"}}}}}}},"description":"getConfidenceCriteriaStats","method":"get","path":"/v6/stats/confidence-criteria","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"get Confidence Criteria Stats","description":{"type":"text/plain"},"url":{"path":["v6","stats","confidence-criteria"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getConfidenceCriteriaStats - - - -getConfidenceCriteriaStats - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx deleted file mode 100644 index 4193b879ac6..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-input-changelog -title: "Returns changelog entries for changes to the business partner input stage" -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." -sidebar_label: "Returns changelog entries for changes to the business partner input stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"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.","operationId":"getInputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"externalIds":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of external IDs. Ignored if empty.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"required":["content","contentSize","errors","invalidEntries","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["changelogType","externalId","timestamp"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the changelog entry was created."},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}},"invalidEntries":{"type":"integer","description":"Number of entries in the page that have been omitted due to being invalid (error)","format":"int32"},"errors":{"type":"array","description":"Infos about the entries with errors","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the error","enum":["ExternalIdNotFound"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key (externalId) of the entity that failed"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/input/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Returns changelog entries for changes to the business partner input stage","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","input","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries for changes to the business partner input stage - - - -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. - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    - -Collection of results in the page - -
    errors object[]
    - -Infos about the entries with errors - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx deleted file mode 100644 index 4cbc702526e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-output-changelog -title: "Returns changelog entries for changes to the business partner output stage" -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." -sidebar_label: "Returns changelog entries for changes to the business partner output stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"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.","operationId":"getOutputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"externalIds":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of external IDs. Ignored if empty.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"required":["content","contentSize","errors","invalidEntries","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["changelogType","externalId","timestamp"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the changelog entry was created."},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}},"invalidEntries":{"type":"integer","description":"Number of entries in the page that have been omitted due to being invalid (error)","format":"int32"},"errors":{"type":"array","description":"Infos about the entries with errors","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the error","enum":["ExternalIdNotFound"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key (externalId) of the entity that failed"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/output/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Returns changelog entries for changes to the business partner output stage","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","output","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries for changes to the business partner output stage - - - -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. - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    - -Collection of results in the page - -
    errors object[]
    - -Infos about the entries with errors - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-partner-csv-template.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-partner-csv-template.api.mdx deleted file mode 100644 index 25e7b8c50a3..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-partner-csv-template.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-partner-csv-template -title: "Get CSV template with headers in file" -description: "Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data." -sidebar_label: "Get CSV template with headers in file" -hide_title: true -hide_table_of_contents: true -api: {"tags":["partner-upload-controller"],"description":"Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data.","operationId":"getPartnerCsvTemplate","responses":{"200":{"description":"CSV file template generated successfully","content":{"application/json":{"schema":{"type":"string","format":"binary"}},"multipart/form-data":{"schema":{"type":"string","format":"binary"}}}}},"method":"get","path":"/v6/input/partner-upload-template","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Get CSV template with headers in file","description":{"content":"Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data.","type":"text/plain"},"url":{"path":["v6","input","partner-upload-template"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get CSV template with headers in file - - - -Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data. - -
- -CSV file template generated successfully - -
Schema
  • string binary
Schema
  • string binary
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx deleted file mode 100644 index 07f9fabee9e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-sharing-states -title: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -description: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -sidebar_label: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"operationId":"getSharingStates","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"externalIds","in":"query","description":"External IDs","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Page of sharing states","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["externalId","sharingStateType"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the sharing state entry was created."},"sharingStateType":{"type":"string","description":"One of the sharing state types of the current sharing state.","enum":["Pending","Success","Error","Initial","Ready"]},"sharingErrorCode":{"type":"string","description":"One of the sharing error codes in case the current sharing state type is \"error\".","enum":["SharingProcessError","SharingTimeout","BpnNotInPool","MissingTaskID"]},"sharingErrorMessage":{"type":"string","description":"The error message in case the current sharing state type is \"error\"."},"sharingProcessStarted":{"type":"string","description":"The date and time when the sharing process was started.","format":"date-time"},"taskId":{"type":"string","description":"The orchestrator task identifier that was created"}},"description":"A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type."}}},"description":"Paginated collection of results"}}}}},"description":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","method":"get","path":"/v6/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","description":{"type":"text/plain"},"url":{"path":["v6","sharing-state"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"External IDs","type":"text/plain"},"key":"externalIds","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs - - - -Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs - -
Query Parameters
- -Page of sharing states - -
Schema
    content object[]
    - -Collection of results in the page - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx deleted file mode 100644 index b3a5bad61ea..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: post-sharing-state-ready -title: "Sets the given business partners into ready to be shared state" -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)." -sidebar_label: "Sets the given business partners into ready to be shared state" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"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).","operationId":"postSharingStateReady","requestBody":{"content":{"application/json":{"schema":{"required":["externalIds"],"type":"object","properties":{"externalIds":{"type":"array","items":{"type":"string"}}},"description":"Request for setting business partners into ready to be shared to golden record state"}}},"required":true},"responses":{"204":{"description":"All business partners put in ready to be shared state"},"400":{"description":"Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)"}},"method":"post","path":"/v6/sharing-state/ready","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Sets the given business partners into ready to be shared state","description":{"content":"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).","type":"text/plain"},"url":{"path":["v6","sharing-state","ready"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Sets the given business partners into ready to be shared state - - - -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). - -
Request Body required
- -All business partners put in ready to be shared state - -
- -Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state) - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js deleted file mode 100644 index 2ec1b1bad95..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate"},{"type":"category","label":"business-partner-controller","link":{"type":"generated-index","title":"business-partner-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input","label":"Create or update business partner with given external ID","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output","label":"Search business partners by an array of external IDs from the output stage","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input","label":"Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.","className":"api-method post"}]},{"type":"category","label":"sharing-state-controller","link":{"type":"generated-index","title":"sharing-state-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready","label":"Sets the given business partners into ready to be shared state","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states","label":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","className":"api-method get"}]},{"type":"category","label":"changelog-controller","link":{"type":"generated-index","title":"changelog-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog","label":"Returns changelog entries for changes to the business partner output stage","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog","label":"Returns changelog entries for changes to the business partner input stage","className":"api-method post"}]},{"type":"category","label":"partner-upload-controller","link":{"type":"generated-index","title":"partner-upload-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/partner-upload-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upload-partner-csv-file","label":"Create or update business partners from uploaded CSV file","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-partner-csv-template","label":"Get CSV template with headers in file","className":"api-method get"}]},{"type":"category","label":"stats-controller","link":{"type":"generated-index","title":"stats-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/stats-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-address-types","label":"countAddressTypes","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage","label":"countPartnersPerStage","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state","label":"countPartnersBySharingState","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats","label":"getConfidenceCriteriaStats","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upload-partner-csv-file.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upload-partner-csv-file.api.mdx deleted file mode 100644 index 27c03eb5a0a..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upload-partner-csv-file.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: upload-partner-csv-file -title: "Create or update business partners from uploaded CSV file" -description: "Create or update generic business partners. 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 requested file." -sidebar_label: "Create or update business partners from uploaded CSV file" -hide_title: true -hide_table_of_contents: true -api: {"tags":["partner-upload-controller"],"description":"Create or update generic business partners. 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 requested file. ","operationId":"uploadPartnerCsvFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Business partners were successfully updated or created","content":{"application/json":{"schema":{"type":"array","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}},"multipart/form-data":{"schema":{"type":"array","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}}}},"400":{"description":"On malformed Business partner upload request","content":{"application/json":{"schema":{"required":["error","path","status","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"Timestamp of the error occurrence","format":"date-time"},"status":{"type":"string","description":"HTTP status of the error response","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"error":{"type":"array","description":"List of error messages","items":{"type":"string","description":"List of error messages"}},"path":{"type":"string","description":"Request path where the error occurred"}},"description":"Error response for invalid partner upload"}}}}},"method":"post","path":"/v6/input/partner-upload-process","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Create or update business partners from uploaded CSV file","description":{"content":"Create or update generic business partners. 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 requested file. ","type":"text/plain"},"url":{"path":["v6","input","partner-upload-process"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"formdata","formdata":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update business partners from uploaded CSV file - - - -Create or update generic business partners. 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 requested file. - -
Request Body
- -Business partners were successfully updated or created - -
Schema array
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
Schema array
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
- -On malformed Business partner upload request - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx deleted file mode 100644 index d59fa5ccb3a..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: upsert-business-partners-input -title: "Create or update business partner with given external ID" -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." -sidebar_label: "Create or update business partner with given external ID" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"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.","operationId":"upsertBusinessPartnersInput","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["address","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","roles","site","states"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "}},"description":"Generic business partner with external id"}}}},"required":true},"responses":{"200":{"description":"Business partner were successfully updated or created","content":{"application/json":{"schema":{"type":"array","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}}}},"400":{"description":"On malformed legal entity request"}},"method":"put","path":"/v6/input/business-partners","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"externalId":"string","nameParts":["string"],"identifiers":[{"type":"string","value":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"roles":["SUPPLIER"],"isOwnCompanyData":true,"legalEntity":{"legalEntityBpn":"string","legalName":"string","shortName":"string","legalForm":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}]},"site":{"siteBpn":"string","name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}]},"address":{"addressBpn":"string","name":"string","addressType":"LegalAndSiteMainAddress","physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","nameSuffix":"string","additionalNameSuffix":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}]}}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.1.0"},"postman":{"name":"Create or update business partner with given external ID","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","input","business-partners"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update business partner with given external ID - - - -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. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[] required
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object required
    - -The legal entity, on which the business partner provides a view. - -
    states object[] required
    site object required
    - -The site, on which the business partner provides a view. - -
    states object[] required
    address object required
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[] required
- -Business partner were successfully updated or created - -
Schema array
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
- -On malformed legal entity request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx deleted file mode 100644 index ab1cb60c28a..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-orchestrator -title: "Business Partner Data Management Orchestrator" -description: "Orchestrator component acts as a passive component and offers for each processing steps individual endpoints" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.1.0 - -# Business Partner Data Management Orchestrator - - - -Orchestrator component acts as a passive component and offers for each processing steps individual endpoints - - - \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx deleted file mode 100644 index 590e98c7a14..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: create-tasks -title: "Create new golden record tasks for given business partner data" -description: "Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries." -sidebar_label: "Create new golden record tasks for given business partner data" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Client"],"description":"Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries.","operationId":"createTasks","requestBody":{"content":{"application/json":{"schema":{"required":["mode","requests"],"type":"object","properties":{"mode":{"type":"string","description":"The mode affecting which processing steps the business partner goes through","enum":["UpdateFromSharingMember","UpdateFromPool"]},"requests":{"type":"array","description":"The list of tasks to create","items":{"required":["businessPartner"],"type":"object","properties":{"recordId":{"type":"string","description":"The unique identifier for this record which was previously issued by the Orchestrator"},"businessPartner":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}},"description":"The business partner data to be processed"}}}}},"description":"Request object to specify for which business partner data tasks should be created and in which mode"}}},"required":true},"responses":{"200":{"description":"The states of successfully created tasks including the task identifier for tracking purposes.","content":{"application/json":{"schema":{"required":["createdTasks"],"type":"object","properties":{"createdTasks":{"type":"array","items":{"required":["businessPartnerResult","processingState","recordId","taskId"],"type":"object","properties":{"taskId":{"type":"string"},"recordId":{"type":"string","description":"The identifier of the gate record for which this task has been created"},"businessPartnerResult":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}},"description":"The business partner data to be processed"},"processingState":{"required":["createdAt","errors","modifiedAt","resultState","step","stepState","timeout"],"type":"object","properties":{"resultState":{"type":"string","description":"The processing result of the task, can also still be pending","enum":["Pending","Success","Error"]},"step":{"type":"string","description":"The last step this task has entered","enum":["CleanAndSync","PoolSync","Clean"]},"stepState":{"type":"string","description":"Whether the task is queued or already reserved for the latest step","enum":["Queued","Reserved","Success","Error"]},"errors":{"type":"array","description":"The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}},"createdAt":{"type":"string","description":"When the task has been created","format":"date-time"},"modifiedAt":{"type":"string","description":"When the task has last been modified","format":"date-time"}},"description":"Contains detailed information about the current processing state of a golden record task"}},"description":"The golden record task's processing state together with optional business partner data in case processing is done"}}},"description":"Response object for giving a list of created tasks"}}}},"400":{"description":"On malformed task create requests or reaching upsert limit"}},"method":"post","path":"/v6/golden-record-tasks","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"mode":"UpdateFromSharingMember","requests":[{"recordId":"string","businessPartner":{"nameParts":[{"name":"string","type":"LegalName"}],"owningCompany":"string","uncategorized":{"nameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"address":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"legalEntity":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"isCatenaXMemberData":true,"hasChanged":true,"legalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"site":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"siteName":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"hasChanged":true,"siteMainAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"siteMainIsLegalAddress":true},"additionalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"type":"LegalEntity"}}]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.1.0"},"postman":{"name":"Create new golden record tasks for given business partner data","description":{"content":"Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new golden record tasks for given business partner data - - - -Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries. - -
Request Body required
    requests object[] required
    - -The list of tasks to create - -
    businessPartner object required
    - -The business partner data to be processed - -
    nameParts object[] required
    uncategorized object required
    identifiers object[] required
    states object[] required
    address object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    legalEntity object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    legalAddress object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    site object
    bpnReference object required
    states object[] required
    confidenceCriteria object required
    siteMainAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    additionalAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
- -The states of successfully created tasks including the task identifier for tracking purposes. - -
Schema
    createdTasks object[]
    businessPartnerResult object
    - -The business partner data to be processed - -
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    processingState object
    - -Contains detailed information about the current processing state of a golden record task - -
    errors object[]
    - -The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step. - -
- -On malformed task create requests or reaching upsert limit - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx deleted file mode 100644 index b871323962e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: reserve-tasks-for-step -title: "Reserve the next golden record tasks waiting in the given step queue" -description: "Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100." -sidebar_label: "Reserve the next golden record tasks waiting in the given step queue" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Worker"],"description":"Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.","operationId":"reserveTasksForStep","requestBody":{"content":{"application/json":{"schema":{"required":["amount","step"],"type":"object","properties":{"amount":{"type":"integer","description":"The maximum number of tasks to reserve. Can be fewer if queue is not full enough.","format":"int32"},"step":{"type":"string","description":"The step queue to reserve from","enum":["CleanAndSync","PoolSync","Clean"]}},"description":"Request object for reserving a number of tasks waiting in a step queue."}}},"required":true},"responses":{"200":{"description":"The reserved tasks with their business partner data to process.","content":{"application/json":{"schema":{"required":["reservedTasks","timeout"],"type":"object","properties":{"reservedTasks":{"type":"array","description":"The reserved tasks with their business partner data to process","items":{"required":["businessPartner","recordId","requestKey","taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"The identifier of the reserved task"},"recordId":{"type":"string","description":"The identifier of the gate record for which this task has been created"},"businessPartner":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}},"description":"The business partner data to be processed"},"requestKey":{"type":"string"}},"description":"Task reservation entry"}},"timeout":{"type":"string","description":"The timestamp until the reservation is valid and results are accepted","format":"date-time","deprecated":true}},"description":"Response object for giving a list of reserved tasks"}}}},"400":{"description":"On malformed task create requests or reaching upsert limit"}},"method":"post","path":"/v6/golden-record-tasks/step-reservations","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"amount":0,"step":"CleanAndSync"},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.1.0"},"postman":{"name":"Reserve the next golden record tasks waiting in the given step queue","description":{"content":"Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","step-reservations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Reserve the next golden record tasks waiting in the given step queue - - - -Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100. - -
Request Body required
- -The reserved tasks with their business partner data to process. - -
Schema
    reservedTasks object[]
    - -The reserved tasks with their business partner data to process - -
    businessPartner object
    - -The business partner data to be processed - -
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
- -On malformed task create requests or reaching upsert limit - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx deleted file mode 100644 index 4e7ba9fd149..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: resolve-step-results -title: "Post step results for reserved golden record tasks in the given step queue" -description: "Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100." -sidebar_label: "Post step results for reserved golden record tasks in the given step queue" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Worker"],"description":"Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100.","operationId":"resolveStepResults","requestBody":{"content":{"application/json":{"schema":{"required":["results","step"],"type":"object","properties":{"step":{"type":"string","description":"The step queue containing the tasks for which results are posted","enum":["CleanAndSync","PoolSync","Clean"]},"results":{"type":"array","items":{"required":["businessPartner","errors","taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"The identifier of the task for which this is a result"},"businessPartner":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}},"description":"The business partner data to be processed"},"errors":{"type":"array","description":"Errors that occurred during processing of this task","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}}},"description":"A step result for a golden record task"}}},"description":"Request object for posting step results of previously reserved tasks"}}},"required":true},"responses":{"204":{"description":"If the results could be processed"},"400":{"description":"On malformed requests, reaching upsert limit or posting results for tasks which are missing or in the wrong step queue"}},"method":"post","path":"/v6/golden-record-tasks/step-results","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"step":"CleanAndSync","results":[{"taskId":"string","businessPartner":{"nameParts":[{"name":"string","type":"LegalName"}],"owningCompany":"string","uncategorized":{"nameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"address":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"legalEntity":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"isCatenaXMemberData":true,"hasChanged":true,"legalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"site":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"siteName":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"hasChanged":true,"siteMainAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"siteMainIsLegalAddress":true},"additionalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"type":"LegalEntity"},"errors":[{"type":"Timeout","description":"string"}]}]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.1.0"},"postman":{"name":"Post step results for reserved golden record tasks in the given step queue","description":{"content":"Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","step-results"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Post step results for reserved golden record tasks in the given step queue - - - -Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100. - -
Request Body required
    results object[] required
    businessPartner object required
    - -The business partner data to be processed - -
    nameParts object[] required
    uncategorized object required
    identifiers object[] required
    states object[] required
    address object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    legalEntity object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    legalAddress object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    site object
    bpnReference object required
    states object[] required
    confidenceCriteria object required
    siteMainAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    additionalAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    errors object[] required
    - -Errors that occurred during processing of this task - -
- -If the results could be processed - -
- -On malformed requests, reaching upsert limit or posting results for tasks which are missing or in the wrong step queue - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx deleted file mode 100644 index ce2af969cef..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: search-task-states -title: "Search for the state of golden record tasks by task identifiers" -description: "Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored." -sidebar_label: "Search for the state of golden record tasks by task identifiers" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Client"],"description":"Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.","operationId":"searchTaskStates","requestBody":{"content":{"application/json":{"schema":{"required":["taskIds"],"type":"object","properties":{"taskIds":{"type":"array","items":{"type":"string"}}},"description":"Request object for giving a list of task identifiers to search for the state of tasks"}}},"required":true},"responses":{"200":{"description":"The state of the tasks for the provided task identifiers.","content":{"application/json":{"schema":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"required":["businessPartnerResult","processingState","recordId","taskId"],"type":"object","properties":{"taskId":{"type":"string"},"recordId":{"type":"string","description":"The identifier of the gate record for which this task has been created"},"businessPartnerResult":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"},"taxJurisdictionCode":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}},"description":"The business partner data to be processed"},"processingState":{"required":["createdAt","errors","modifiedAt","resultState","step","stepState","timeout"],"type":"object","properties":{"resultState":{"type":"string","description":"The processing result of the task, can also still be pending","enum":["Pending","Success","Error"]},"step":{"type":"string","description":"The last step this task has entered","enum":["CleanAndSync","PoolSync","Clean"]},"stepState":{"type":"string","description":"Whether the task is queued or already reserved for the latest step","enum":["Queued","Reserved","Success","Error"]},"errors":{"type":"array","description":"The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}},"createdAt":{"type":"string","description":"When the task has been created","format":"date-time"},"modifiedAt":{"type":"string","description":"When the task has last been modified","format":"date-time"}},"description":"Contains detailed information about the current processing state of a golden record task"}},"description":"The golden record task's processing state together with optional business partner data in case processing is done"}}},"description":"Response object for giving a list of task states"}}}},"400":{"description":"On malformed task search requests"}},"method":"post","path":"/v6/golden-record-tasks/state/search","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"taskIds":["string"]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.1.0"},"postman":{"name":"Search for the state of golden record tasks by task identifiers","description":{"content":"Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","state","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search for the state of golden record tasks by task identifiers - - - -Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored. - -
Request Body required
- -The state of the tasks for the provided task identifiers. - -
Schema
    tasks object[]
    businessPartnerResult object
    - -The business partner data to be processed - -
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    processingState object
    - -Contains detailed information about the current processing state of a golden record task - -
    errors object[]
    - -The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step. - -
- -On malformed task search requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js b/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js deleted file mode 100644 index 433446ffc5e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator"},{"type":"category","label":"Task Client","link":{"type":"generated-index","title":"Task Client","slug":"/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-client"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks","label":"Create new golden record tasks for given business partner data","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states","label":"Search for the state of golden record tasks by task identifiers","className":"api-method post"}]},{"type":"category","label":"Task Worker","link":{"type":"generated-index","title":"Task Worker","slug":"/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-worker"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results","label":"Post step results for reserved golden record tasks in the given step queue","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step","label":"Reserve the next golden record tasks waiting in the given step queue","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx deleted file mode 100644 index 0e12042f96e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-pool -title: "Business Partner Data Management Pool" -description: "Service that manages and shares business partner data with other CatenaX services" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.1.0 - -# Business Partner Data Management Pool - - - -Service that manages and shares business partner data with other CatenaX services - - - \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx deleted file mode 100644 index 349d5e78323..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: create-addresses -title: "Creates a new address" -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." -sidebar_label: "Creates a new address" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"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.","operationId":"createAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnParent","confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"bpnParent":{"type":"string","description":"BPNL of the legal entity or BPNS of the site this address belongs to."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created business partner of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"AddressCreateError","enum":["BpnNotValid","SiteNotFound","LegalEntityNotFound","RegionNotFound","IdentifierNotFound","AddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"bpnParent":"string","index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Creates a new address","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new address - - - -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. - -
Request Body array required
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -New business partner record successfully created, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx deleted file mode 100644 index f33a5d79aa5..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: create-business-partners -title: "Creates a new legal entity" -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." -sidebar_label: "Creates a new legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"createBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["confidenceCriteria","identifiers","isCatenaXMemberData","legalAddress","legalName","states"],"type":"object","properties":{"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"type":"string","description":"The legal form of the legal entity."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"type":"string","description":"The type of the identifier."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"legalAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"required":true},"responses":{"200":{"description":"New legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityCreateError","enum":["LegalEntityDuplicateIdentifier","LegalFormNotFound","LegalEntityIdentifierNotFound","LegalAddressRegionNotFound","LegalAddressIdentifierNotFound","LegalAddressDuplicateIdentifier","LegalEntityErrorMapping"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"isCatenaXMemberData":true,"legalAddress":{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0}},"index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Creates a new legal entity","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new legal entity - - - -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. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the legal entity. - -
    states object[] required
    - -The list of (temporary) states of the legal entity. - -
    confidenceCriteria object required
    legalAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -New legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx deleted file mode 100644 index c8e58147859..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: create-identifier-type -title: "Creates a new identifier type" -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." -sidebar_label: "Creates a new identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"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.","operationId":"createIdentifierType","requestBody":{"content":{"application/json":{"schema":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}},"required":true},"responses":{"200":{"description":"New identifier type successfully created","content":{"application/json":{"schema":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Identifier type with specified technical key already exists"}},"method":"post","path":"/v6/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","businessPartnerType":"LEGAL_ENTITY","name":"string","details":[{"country":"UNDEFINED","mandatory":true}]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Creates a new identifier type","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","identifier-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new identifier type - - - -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. - -
Request Body required
    details object[] required
    - -Validity details. - -
- -New identifier type successfully created - -
Schema
    details object[]
    - -Validity details. - -
- -On malformed request parameters - -
- -Identifier type with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx deleted file mode 100644 index af8d3864e6d..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-legal-form -title: "Creates a new legal form" -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." -sidebar_label: "Creates a new legal form" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"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.","operationId":"createLegalForm","requestBody":{"content":{"application/json":{"schema":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"New legal form record to be referenced by business partners"}}},"required":true},"responses":{"200":{"description":"New legal form successfully created","content":{"application/json":{"schema":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Legal form with specified technical key already exists"}},"method":"post","path":"/v6/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","abbreviation":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Creates a new legal form","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","legal-forms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new legal form - - - -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. - -
Request Body required
- -New legal form successfully created - -
Schema
- -On malformed request parameters - -
- -Legal form with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx deleted file mode 100644 index e7058fee799..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: create-site -title: "Creates a new site" -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." -sidebar_label: "Creates a new site" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"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.","operationId":"createSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnlParent","confidenceCriteria","mainAddress","name","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"mainAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"bpnlParent":{"type":"string","description":"The BPNL of the legal entity owning the site."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"required":true},"responses":{"200":{"description":"New sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"SiteCreateError","enum":["LegalEntityNotFound","MainAddressIdentifierNotFound","MainAddressRegionNotFound","MainAddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0}},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"bpnlParent":"string","index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Creates a new site","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new site - - - -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. - -
Request Body array required
    states object[] required
    - -The list of the (temporary) states of the site. - -
    mainAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
    confidenceCriteria object required
- -New sites request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx deleted file mode 100644 index 1b12fabac13..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find-bpns-by-identifiers -title: "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values" -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." -sidebar_label: "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Bpn Controller"],"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.","operationId":"findBpnsByIdentifiers","requestBody":{"content":{"application/json":{"schema":{"required":["businessPartnerType","idType","idValues"],"type":"object","properties":{"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"idType":{"type":"string","description":"Technical key of the type to which the identifiers belongs to"},"idValues":{"type":"array","description":"Values of the identifiers","items":{"type":"string","description":"Values of the identifiers"}}},"description":"Contains identifiers to search legal entities by"}}},"required":true},"responses":{"200":{"description":"Found bpn to identifier value mappings","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"required":["bpn","idValue"],"type":"object","properties":{"idValue":{"type":"string","description":"Value of the identifier"},"bpn":{"type":"string","description":"Business Partner Number"}},"description":"Mapping of Business Partner Number to identifier value"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"},"404":{"description":"Specified identifier type not found"}},"method":"post","path":"/v6/bpn/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"businessPartnerType":"LEGAL_ENTITY","idType":"string","idValues":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","bpn","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values - - - -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. - -
Request Body required
- -Found bpn to identifier value mappings - -
Schema array
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- -Specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx deleted file mode 100644 index bd46f376b69..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-address -title: "Returns an address by its BPNA" -description: "Get business partners of type address by BPNA ignoring case." -sidebar_label: "Returns an address by its BPNA" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Get business partners of type address by BPNA ignoring case.","operationId":"getAddress","parameters":[{"name":"bpna","in":"path","description":"BPNA value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with specified BPNA","content":{"application/json":{"schema":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No address found under specified BPNA"}},"method":"get","path":"/v6/addresses/{bpna}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns an address by its BPNA","description":{"content":"Get business partners of type address by BPNA ignoring case.","type":"text/plain"},"url":{"path":["v6","addresses",":bpna"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) BPNA value","type":"text/plain"},"type":"any","value":"","key":"bpna"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns an address by its BPNA - - - -Get business partners of type address by BPNA ignoring case. - -
Path Parameters
- -Found address with specified BPNA - -
Schema
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No address found under specified BPNA - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx deleted file mode 100644 index 6c431e2c015..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-addresses-1 -title: "Returns addresses by different search parameters" -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." -sidebar_label: "Returns addresses by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"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. ","operationId":"getAddresses_1","parameters":[{"name":"addressBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalEntityBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"siteBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of addresses matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns addresses by different search parameters","description":{"content":"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. ","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"addressBpns","value":""},{"disabled":false,"key":"legalEntityBpns","value":""},{"disabled":false,"key":"siteBpns","value":""},{"disabled":false,"key":"name","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns addresses by different search parameters - - - -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. - -
Query Parameters
- -Page of addresses matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx deleted file mode 100644 index b0f982fe759..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: get-addresses -title: "Returns all addresses of a legal entity with a specific BPNL" -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." -sidebar_label: "Returns all addresses of a legal entity with a specific BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"getAddresses","parameters":[{"name":"bpnl","in":"path","description":"BPNL value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The addresses for the specified BPNL","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified BPNL"}},"method":"get","path":"/v6/legal-entities/{bpnl}/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns all addresses of a legal entity with a specific BPNL","description":{"content":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case.","type":"text/plain"},"url":{"path":["v6","legal-entities",":bpnl","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) BPNL value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all addresses of a legal entity with a specific BPNL - - - -Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case. - -
Path Parameters
Query Parameters
- -The addresses for the specified BPNL - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- -No business partner found for specified BPNL - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx deleted file mode 100644 index 82c84f087c6..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-admin-areas-level-1 -title: "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property" -description: "Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result" -sidebar_label: "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result","operationId":"getAdminAreasLevel1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing country subdivisions, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["code","countryCode","name"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"code":{"type":"string","description":"The country subdivision code according to ISO 3166-2"},"name":{"type":"string","description":"The name of the country subdivision according to ISO 3166-2"}},"description":"Country subdivision"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/administrative-areas-level1","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Get page of country subdivisions suitable for the administrativeAreaLevel1 address property","description":{"content":"Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result","type":"text/plain"},"url":{"path":["v6","administrative-areas-level1"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of country subdivisions suitable for the administrativeAreaLevel1 address property - - - -Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result - -
Query Parameters
- -Page of existing country subdivisions, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx deleted file mode 100644 index 18ced532f16..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-changelog-entries -title: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -description: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -sidebar_label: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Changelog Controller"],"operationId":"getChangelogEntries","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"bpns":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of BPNL/S/A. Ignored if empty.","items":{"type":"string"}},"businessPartnerTypes":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of business partner types. Ignored if empty.","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]}}},"description":"Request for searching and filtering the business partner changelog"}}},"required":true},"responses":{"200":{"description":"The specified changelog entries","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpn","businessPartnerType","changelogType","timestamp"],"type":"object","properties":{"bpn":{"type":"string","description":"The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA."},"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the changelog entry was created: legal entity, site, address.","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"description":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","method":"post","path":"/v6/business-partners/changelog/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","bpns":["string"],"businessPartnerTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","description":{"type":"text/plain"},"url":{"path":["v6","business-partners","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types - - - -Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types - -
Query Parameters
Request Body required
- -The specified changelog entries - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx deleted file mode 100644 index ef68b6240fe..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-field-quality-rules -title: "Get all field quality rules filtered by country (specified by its 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." -sidebar_label: "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","operationId":"getFieldQualityRules","parameters":[{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 country code","required":true,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"List of the existing rules for the given country","content":{"application/json":{"schema":{"type":"array","items":{"required":["country","fieldPath","qualityLevel"],"type":"object","properties":{"fieldPath":{"type":"string","description":"Path to the field"},"schemaName":{"type":"string","description":"Schema name of the entity the field belongs to"},"country":{"type":"string","description":"Country for wich the rule is valid","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"qualityLevel":{"type":"string","description":"Defines the quality of an entity field.","enum":["MANDATORY","OPTIONAL","FORBIDDEN"]}},"description":"Rule for the quality level of an entity field "}}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/field-quality-rules/","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","description":{"content":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","type":"text/plain"},"url":{"path":["v6","field-quality-rules",""],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ISO 3166-1 alpha-2 country code","type":"text/plain"},"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code) - - - -List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden. - -
Query Parameters
- -List of the existing rules for the given country - -
Schema array
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx deleted file mode 100644 index 4834a2a8d0f..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-identifier-types -title: "Returns all identifier types filtered by business partner type and country." -description: "Lists all matching identifier types including validity details in a paginated result" -sidebar_label: "Returns all identifier types filtered by business partner type and country." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all matching identifier types including validity details in a paginated result","operationId":"getIdentifierTypes","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"businessPartnerType","in":"query","required":true,"schema":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]}},{"name":"country","in":"query","required":false,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"Page of existing identifier types, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns all identifier types filtered by business partner type and country.","description":{"content":"Lists all matching identifier types including validity details in a paginated result","type":"text/plain"},"url":{"path":["v6","identifier-types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"businessPartnerType","value":""},{"disabled":false,"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all identifier types filtered by business partner type and country. - - - -Lists all matching identifier types including validity details in a paginated result - -
Query Parameters
- -Page of existing identifier types, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    details object[]
    - -Validity details. - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx deleted file mode 100644 index 63761a540c6..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: get-legal-entities -title: "Returns legal entities by different search parameters" -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." -sidebar_label: "Returns legal entities by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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. ","operationId":"getLegalEntities","parameters":[{"name":"bpnLs","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalName","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns legal entities by different search parameters","description":{"content":"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. ","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"bpnLs","value":""},{"disabled":false,"key":"legalName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns legal entities by different search parameters - - - -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. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx deleted file mode 100644 index 0a8f438d1e9..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: get-legal-entity -title: "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type" -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." -sidebar_label: "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"getLegalEntity","parameters":[{"name":"idValue","in":"path","description":"Identifier value","required":true,"schema":{"type":"string"}},{"name":"idType","in":"query","description":"Type of identifier to use, defaults to BPN when omitted","required":false,"schema":{"type":"string","default":"BPN"}}],"responses":{"200":{"description":"Found business partner with specified identifier","content":{"application/json":{"schema":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found under specified identifier or specified identifier type not found"}},"method":"get","path":"/v6/legal-entities/{idValue}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","legal-entities",":idValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of identifier to use, defaults to BPN when omitted","type":"text/plain"},"key":"idType","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Identifier value","type":"text/plain"},"type":"any","value":"","key":"idValue"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type - - - -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. - -
Path Parameters
Query Parameters
- -Found business partner with specified identifier - -
Schema
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No business partner found under specified identifier or specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx deleted file mode 100644 index cf3813c8d0f..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-legal-forms -title: "Returns all legal forms" -description: "Lists all currently known legal forms in a paginated result" -sidebar_label: "Returns all legal forms" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all currently known legal forms in a paginated result","operationId":"getLegalForms","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing legal forms, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns all legal forms","description":{"content":"Lists all currently known legal forms in a paginated result","type":"text/plain"},"url":{"path":["v6","legal-forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all legal forms - - - -Lists all currently known legal forms in a paginated result - -
Query Parameters
- -Page of existing legal forms, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx deleted file mode 100644 index 2f40075e106..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: get-site -title: "Returns a site by its BPNS" -description: "Get business partners of type site by BPNS ignoring case." -sidebar_label: "Returns a site by its BPNS" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Get business partners of type site by BPNS ignoring case.","operationId":"getSite","parameters":[{"name":"bpns","in":"path","description":"BPNS value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with specified BPNS","content":{"application/json":{"schema":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No site found under specified BPNS"}},"method":"get","path":"/v6/sites/{bpns}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns a site by its BPNS","description":{"content":"Get business partners of type site by BPNS ignoring case.","type":"text/plain"},"url":{"path":["v6","sites",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) BPNS value","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a site by its BPNS - - - -Get business partners of type site by BPNS ignoring case. - -
Path Parameters
- -Found site with specified BPNS - -
Schema
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No site found under specified BPNS - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx deleted file mode 100644 index 2c22dd76eba..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-sites-1 -title: "Returns all sites of a legal entity with a specific BPNL" -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." -sidebar_label: "Returns all sites of a legal entity with a specific BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"getSites_1","parameters":[{"name":"bpnl","in":"path","description":"BPNL value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The sites for the specified bpnl","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpnl"}},"method":"get","path":"/v6/legal-entities/{bpnl}/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns all sites of a legal entity with a specific BPNL","description":{"content":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case.","type":"text/plain"},"url":{"path":["v6","legal-entities",":bpnl","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) BPNL value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all sites of a legal entity with a specific BPNL - - - -Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case. - -
Path Parameters
Query Parameters
- -The sites for the specified bpnl - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
- -On malformed pagination request - -
- -No business partner found for specified bpnl - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx deleted file mode 100644 index c28ac9025b9..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: get-sites -title: "Get page of sites matching the pagination search criteria" -description: "This endpoint retrieves all existing business partners of type sites." -sidebar_label: "Get page of sites matching the pagination search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"This endpoint retrieves all existing business partners of type sites.","operationId":"getSites","parameters":[{"name":"siteBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalEntityBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Get page of sites matching the pagination search criteria","description":{"content":"This endpoint retrieves all existing business partners of type sites.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"siteBpns","value":""},{"disabled":false,"key":"legalEntityBpns","value":""},{"disabled":false,"key":"name","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites matching the pagination search criteria - - - -This endpoint retrieves all existing business partners of type sites. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx deleted file mode 100644 index 58eae0e05bc..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: post-legal-entity-search -title: "Returns legal entities by different search parameters" -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." -sidebar_label: "Returns legal entities by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"postLegalEntitySearch","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["bpnLs"],"type":"object","properties":{"bpnLs":{"type":"array","items":{"type":"string"}},"legalName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found legal entites","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"}},"method":"post","path":"/v6/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"bpnLs":["string"],"legalName":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns legal entities by different search parameters","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns legal entities by different search parameters - - - -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. - -
Query Parameters
Request Body required
- -Found legal entites - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx deleted file mode 100644 index 284a299cdd4..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: post-site-search-1 -title: "postSiteSearch_1" -description: "postSiteSearch_1" -sidebar_label: "postSiteSearch_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"operationId":"postSiteSearch_1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["legalEntityBpns","siteBpns"],"type":"object","properties":{"siteBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}}},"description":"postSiteSearch_1","method":"post","path":"/v6/members/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"siteBpns":["string"],"legalEntityBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"post Site Search 1","description":{"type":"text/plain"},"url":{"path":["v6","members","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## postSiteSearch_1 - - - -postSiteSearch_1 - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx deleted file mode 100644 index 337b9d9171c..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: post-site-search -title: "Returns sites by an array of BPNS and/or an array of corresponding BPNL" -description: "Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities" -sidebar_label: "Returns sites by an array of BPNS and/or an array of corresponding BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","operationId":"postSiteSearch","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["legalEntityBpns","siteBpns"],"type":"object","properties":{"siteBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found sites that belong to specified legal entites","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/v6/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"siteBpns":["string"],"legalEntityBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns sites by an array of BPNS and/or an array of corresponding BPNL","description":{"content":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","type":"text/plain"},"url":{"path":["v6","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns sites by an array of BPNS and/or an array of corresponding BPNL - - - -Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - -
Query Parameters
Request Body required
- -Found sites that belong to specified legal entites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx deleted file mode 100644 index 1e3d158e146..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: search-addresses-1 -title: "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL." -description: "Search business partners of type address by their BPNA or their parents' BPNL or BPNS." -sidebar_label: "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Search business partners of type address by their BPNA or their parents' BPNL or BPNS.","operationId":"searchAddresses_1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["addressBpns","legalEntityBpns","siteBpns"],"type":"object","properties":{"addressBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"siteBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found sites for the specified sites and legal entities","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"addressBpns":["string"],"legalEntityBpns":["string"],"siteBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.","description":{"content":"Search business partners of type address by their BPNA or their parents' BPNL or BPNS.","type":"text/plain"},"url":{"path":["v6","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL. - - - -Search business partners of type address by their BPNA or their parents' BPNL or BPNS. - -
Query Parameters
Request Body required
- -Found sites for the specified sites and legal entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx deleted file mode 100644 index cdc37f2b8b8..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: search-addresses -title: "searchAddresses" -description: "searchAddresses" -sidebar_label: "searchAddresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"operationId":"searchAddresses","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["addressBpns","legalEntityBpns","siteBpns"],"type":"object","properties":{"addressBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"siteBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}}},"description":"searchAddresses","method":"post","path":"/v6/members/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"addressBpns":["string"],"legalEntityBpns":["string"],"siteBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"search Addresses","description":{"type":"text/plain"},"url":{"path":["v6","members","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchAddresses - - - -searchAddresses - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx deleted file mode 100644 index bf14ee6481d..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: search-changelog-entries -title: "searchChangelogEntries" -description: "searchChangelogEntries" -sidebar_label: "searchChangelogEntries" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Changelog Controller"],"operationId":"searchChangelogEntries","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"bpns":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of BPNL/S/A. Ignored if empty.","items":{"type":"string"}},"businessPartnerTypes":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of business partner types. Ignored if empty.","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]}}},"description":"Request for searching and filtering the business partner changelog"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpn","businessPartnerType","changelogType","timestamp"],"type":"object","properties":{"bpn":{"type":"string","description":"The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA."},"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the changelog entry was created: legal entity, site, address.","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}}},"description":"Paginated collection of results"}}}}},"description":"searchChangelogEntries","method":"post","path":"/v6/members/changelog/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","bpns":["string"],"businessPartnerTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"search Changelog Entries","description":{"type":"text/plain"},"url":{"path":["v6","members","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchChangelogEntries - - - -searchChangelogEntries - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx deleted file mode 100644 index 13c01b75143..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -id: search-legal-entities -title: "searchLegalEntities" -description: "searchLegalEntities" -sidebar_label: "searchLegalEntities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"operationId":"searchLegalEntities","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["bpnLs"],"type":"object","properties":{"bpnLs":{"type":"array","items":{"type":"string"}},"legalName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}}},"description":"searchLegalEntities","method":"post","path":"/v6/members/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"bpnLs":["string"],"legalName":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"search Legal Entities","description":{"type":"text/plain"},"url":{"path":["v6","members","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchLegalEntities - - - -searchLegalEntities - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js deleted file mode 100644 index 9fdefa5596e..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool"},{"type":"category","label":"Changelog Controller","link":{"type":"generated-index","title":"Changelog Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries","label":"searchChangelogEntries","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries","label":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","className":"api-method post"}]},{"type":"category","label":"Legal Entity Controller","link":{"type":"generated-index","title":"Legal Entity Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities","label":"Returns legal entities by different search parameters","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners","label":"Updates an existing legal entity","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners","label":"Creates a new legal entity","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities","label":"searchLegalEntities","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search","label":"Returns legal entities by different search parameters","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity","label":"Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1","label":"Returns all sites of a legal entity with a specific BPNL","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses","label":"Returns all addresses of a legal entity with a specific BPNL","className":"api-method get"}]},{"type":"category","label":"Metadata Controller","link":{"type":"generated-index","title":"Metadata Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms","label":"Returns all legal forms","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form","label":"Creates a new legal form","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types","label":"Returns all identifier types filtered by business partner type and country.","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type","label":"Creates a new identifier type","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules","label":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1","label":"Get page of country subdivisions suitable for the administrativeAreaLevel1 address property","className":"api-method get"}]},{"type":"category","label":"Site Controller","link":{"type":"generated-index","title":"Site Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites","label":"Get page of sites matching the pagination search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-site","label":"Updates an existing site","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-site","label":"Creates a new site","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-site-search","label":"Returns sites by an array of BPNS and/or an array of corresponding BPNL","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1","label":"postSiteSearch_1","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-site","label":"Returns a site by its BPNS","className":"api-method get"}]},{"type":"category","label":"Bpn Controller","link":{"type":"generated-index","title":"Bpn Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers","label":"Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values","className":"api-method post"}]},{"type":"category","label":"Address Controller","link":{"type":"generated-index","title":"Address Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1","label":"Returns addresses by different search parameters","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-addresses","label":"Updates an existing address","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-addresses","label":"Creates a new address","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses","label":"searchAddresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1","label":"Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-address","label":"Returns an address by its BPNA","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx deleted file mode 100644 index 0141107d180..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: update-addresses -title: "Updates an existing address" -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." -sidebar_label: "Updates an existing address" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"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.","operationId":"updateAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpna","confidenceCriteria","identifiers","physicalPostalAddress","requestKey","states"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"required":true},"responses":{"200":{"description":"The successfully updated records, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"AddressUpdateError","enum":["AddressNotFound","RegionNotFound","IdentifierNotFound","AddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpna":"string","name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Updates an existing address","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing address - - - -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. - -
Request Body array required
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -The successfully updated records, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx deleted file mode 100644 index bfaafa9a24d..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: update-business-partners -title: "Updates an existing legal entity" -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." -sidebar_label: "Updates an existing legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"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.","operationId":"updateBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnl","confidenceCriteria","identifiers","isCatenaXMemberData","legalAddress","legalName","requestKey","states"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"type":"string","description":"The legal form of the legal entity."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"type":"string","description":"The type of the identifier."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"legalAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"required":true},"responses":{"200":{"description":"Update legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityUpdateError","enum":["LegalEntityNotFound","LegalEntityDuplicateIdentifier","LegalFormNotFound","LegalEntityIdentifierNotFound","LegalAddressRegionNotFound","LegalAddressIdentifierNotFound","LegalAddressDuplicateIdentifier","LegalEntityErrorMapping"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpnl":"string","legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"isCatenaXMemberData":true,"legalAddress":{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0}},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Updates an existing legal entity","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing legal entity - - - -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. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the legal entity. - -
    states object[] required
    - -The list of (temporary) states of the legal entity. - -
    confidenceCriteria object required
    legalAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -Update legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx b/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx deleted file mode 100644 index 63a74eb995c..00000000000 --- a/docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: update-site -title: "Updates an existing site" -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." -sidebar_label: "Updates an existing site" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"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.","operationId":"updateSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpns","confidenceCriteria","mainAddress","name","requestKey","states"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"mainAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"required":true},"responses":{"200":{"description":"Update sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."},"taxJurisdictionCode":{"type":"string","description":"Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"SiteUpdateError","enum":["SiteNotFound","MainAddressIdentifierNotFound","MainAddressRegionNotFound","MainAddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"errorCount":{"type":"integer","format":"int32"},"entityCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpns":"string","name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"validFrom":"2024-07-15","validTo":"2024-07-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string","taxJurisdictionCode":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0}},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-07-15","nextConfidenceCheckAt":"2024-07-15","confidenceLevel":0},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.1.0"},"postman":{"name":"Updates an existing site","description":{"content":"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.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing site - - - -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. - -
Request Body array required
    states object[] required
    - -The list of the (temporary) states of the site. - -
    mainAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
    confidenceCriteria object required
- -Update sites request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits/kits/Business Partner Kit/page_changelog.md b/docs-kits/kits/Business Partner Kit/page_changelog.md index e719dc3086c..aaac21fba3b 100644 --- a/docs-kits/kits/Business Partner Kit/page_changelog.md +++ b/docs-kits/kits/Business Partner Kit/page_changelog.md @@ -11,6 +11,20 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. +## [7.0.0] - Unreleased + +### Added + +- Added api hub hyperlink for swagger documentation for all services from business partner data management in development view of business partner kit. + +### Changed + +- ./. + +### Removed + +- Removed open api plug in usage from business partner kit. + ## [6.0.0] - 2024-07-16 ### Added diff --git a/docs-kits/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md b/docs-kits/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md index c3c277154f3..eb82d70e03c 100644 --- a/docs-kits/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md +++ b/docs-kits/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md @@ -84,6 +84,7 @@ sequenceDiagram participant Con as Data Consumer participant CEDC as Consumer EDC
Control Plane participant PEDC as Provider EDC
Control Plane + participant PEDCDP as Provider EDC
Data Plane participant DTR as Digital Twin Registry participant SM as Submodel Server participant EDCD as EDC Discovery @@ -109,8 +110,10 @@ autonumber CEDC-->>Con: Dataset for submodel(-bundle) Con->>PEDC: negotiate for Dataset and retrieve token PEDC-->>Con: access token - Con->>SM: GET {{submodel-descriptor/href}}/$value - SM-->>Con: data + Con->>PEDCDP: GET {{submodel-descriptor/href}}/$value + PEDCDP-->>SM: consume + SM-->>PEDCDP: return + PEDCDP-->>Con: data ``` If the `data` is a Bill of diff --git a/docs-kits/kits/Digital Twin Kit/Software Development View/page_software-development-view.md b/docs-kits/kits/Digital Twin Kit/Software Development View/page_software-development-view.md index c0329a33ba3..8d2d9225edd 100644 --- a/docs-kits/kits/Digital Twin Kit/Software Development View/page_software-development-view.md +++ b/docs-kits/kits/Digital Twin Kit/Software Development View/page_software-development-view.md @@ -162,9 +162,8 @@ A full example on the default case is shown in the next section. #### Registering a new Twin Registration of a new twin is (at least in Catena-X) equivalent to the creation of a new twin. Thus, a Data Provider -should always ensure that there is no AAS-descriptor created for the respective assetIds yet. If there already is one, -the submodel-descriptor should -be [added to the existing shell-descriptor](#registering-a-new-submodel-at-an-existing-twin). +should always ensure that an AAS-descriptor for the respective assetIds does not exist yet. If one exists, the +submodel-descriptor should be [added to the existing shell-descriptor](#registering-a-new-submodel-at-an-existing-twin). `POST /shell-descriptors` diff --git a/docs-kits/kits/Digital Twin Kit/page_software-operation-view.md b/docs-kits/kits/Digital Twin Kit/page_software-operation-view.md index 0976695305b..354ef61063d 100644 --- a/docs-kits/kits/Digital Twin Kit/page_software-operation-view.md +++ b/docs-kits/kits/Digital Twin Kit/page_software-operation-view.md @@ -23,13 +23,13 @@ CX-0002. ## Deployment -| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) | -|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| -| Discovery Finder | A microservice resolving a type of specific asset identifiers, e.g. `manufacturerPartId` or `intrinsicId` against a set of BPN-, and EDC-Discovery Servers hosted at Catena-X operating companies. These identifiers are often shared across use-cases (see [Industry Core](../Industry%20Core%20Kit/Software%20Development%20View)) but are not specified by the DT Kit and standards. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 | -| BPN Discovery | A microservice resolving a particular specific asset identifier (consisting of its type - defined above - and the value for a particular asset) against the registered [Business Partner Number](../Business%20Partner%20Kit/page_adoption-view.md#business-value) of its owner. This is useful in discovery when the location of data on a particular asset is unknown. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 | -| EDC Discovery | A microservice that resolves a BPN against a list of EDC endpoints. It is populated during onboarding and is the last step of the discovery sequence preceeding the DSP-interaction starting with the catalog-request. | [Tractus-X Portal including EDC Discovery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 | -| Digital Twin Registry | A registry for digital twins. Here, a provider publicises digital representations (digital twins) of the assets the participant has data on. This data is encapsulated in submodels accessible via instructions that a consumer will find in the Digital Twin Registry (DTR). The DTR adheres to the [AssetAdministrationShellRegistryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.0_SSP-002#/) and the [DiscoveryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.0.1_SSP-001) and thus contains only meta-data. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 | -| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. It delivers the actual data that the consumer is looking for via a structured endpoint defined by the [SubmodelServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/SubmodelServiceSpecification/V3.0_SSP-003) and according to the structured data formats defined in the [Semantic Models Repository](https://github.com/eclipse-tractusx/sldt-semantic-models). | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service),
[Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk),
[AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 | +| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| Discovery Finder | A microservice resolving a type of specific asset identifiers, e.g. `manufacturerPartId` or `intrinsicId` against a set of BPN-, and EDC-Discovery Servers hosted at Catena-X operating companies. These identifiers are often shared across use-cases (see [Industry Core](../Industry%20Core%20Kit/Software%20Development%20View)) but are not specified by the DT Kit and standards. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 | +| BPN Discovery | A microservice resolving a particular specific asset identifier (consisting of its type - defined above - and the value for a particular asset) against the registered [Business Partner Number](../Business%20Partner%20Kit/page_adoption-view.md#business-value) of its owner. This is useful in discovery when the location of data on a particular asset is unknown. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 | +| EDC Discovery | A microservice that resolves a BPN against a list of EDC endpoints. It is populated during onboarding and is the last step of the discovery sequence preceeding the DSP-interaction starting with the catalog-request. | [Tractus-X Portal including EDC Discovery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 | +| Digital Twin Registry | A registry for digital twins. Here, a provider publicises digital representations (digital twins) of the assets the participant has data on. This data is encapsulated in submodels accessible via instructions that a consumer will find in the Digital Twin Registry (DTR). The DTR adheres to the [AssetAdministrationShellRegistryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.0_SSP-002#/) and the [DiscoveryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.0.1_SSP-001) and thus contains only meta-data. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 | +| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. It delivers the actual data that the consumer is looking for via a structured endpoint defined by the [SubmodelServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/SubmodelServiceSpecification/V3.0_SSP-003) and according to the structured data formats defined in the [Semantic Models Repository](https://github.com/eclipse-tractusx/sldt-semantic-models). | There are no official reference implementations for the Submodel-API. Implementations of the API exist in frameworks such as [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), [AASX Server](https://github.com/admin-shell-io/aasx-server). These implementations are not certified according to the standard nor involved in systematic end-to-end testing. | CX - 0002 | ![High Level Architecture of an App leveraging the Digital Twin Kit](assets/img/DTKIT_high_level_arch.svg) diff --git a/docs-kits/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx b/docs-kits/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx index cde92f264a8..da062ecb192 100644 --- a/docs-kits/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx +++ b/docs-kits/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx @@ -179,10 +179,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" @@ -231,10 +227,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "NO-574868639429552535768526" @@ -293,13 +285,13 @@ Aspect model in GitHub: "key": "batchId" }, { - "value": "123-0.740-3434-A", - "key": "manufacturerPartId" + "value": "BPNL7588787849VQ", + "key": "manufacturerId" }, ], "manufacturingInformation": { "date": "2022-02-04T14:48:54", - "country": "HUR", + "country": "DEU", "sites": [ { "catenaXsiteId": "BPNS1234567890ZZ", @@ -355,14 +347,6 @@ Aspect model in GitHub: "key": "parentOrderNumber", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" }, - { - "key": "manufacturerPartId", - "value": "84816168424" - }, - { - "key": "nameAtManufacturer", - "value": "Black Leather Front Row Seat for Vehicle Model B" - }, { "key": "jisCallDate", "value": "2022-01-24T09:13:34" diff --git a/docs-kits/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx b/docs-kits/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx index bf195f382a9..8c0799906d0 100644 --- a/docs-kits/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx +++ b/docs-kits/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx @@ -209,7 +209,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, @@ -253,7 +253,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, diff --git a/docs-kits/kits/Industry Core Kit/page_changelog.mdx b/docs-kits/kits/Industry Core Kit/page_changelog.mdx index 5bf5e91ad59..d48f47e1cf4 100644 --- a/docs-kits/kits/Industry Core Kit/page_changelog.mdx +++ b/docs-kits/kits/Industry Core Kit/page_changelog.mdx @@ -48,6 +48,17 @@ Compatible for **release 24.08**. - **Digital Twins | Unique ID Push:** - Added a new illustration to describe the unique id push notifications in a visual way +## [1.1.1] - 2024-10-23 + +Compatible for **release 24.08**. + +### Removed + +- **Development View:** + - **Aspect Models:** + - Removed the *manufacturerPartId* in the key-value list of the localIdentifiers for the SerialPart, Batch and JustInsequencePart JSON-Example + - Replaced the faulty (production) country abbreviation in the JSON-Example of the Batch aspect model from *HUR* to *DEU* + ## [1.1.0] - 2024-07-11 Compatible for **release 24.08**. diff --git a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx index cde92f264a8..da062ecb192 100644 --- a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx +++ b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx @@ -179,10 +179,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" @@ -231,10 +227,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "NO-574868639429552535768526" @@ -293,13 +285,13 @@ Aspect model in GitHub: "key": "batchId" }, { - "value": "123-0.740-3434-A", - "key": "manufacturerPartId" + "value": "BPNL7588787849VQ", + "key": "manufacturerId" }, ], "manufacturingInformation": { "date": "2022-02-04T14:48:54", - "country": "HUR", + "country": "DEU", "sites": [ { "catenaXsiteId": "BPNS1234567890ZZ", @@ -355,14 +347,6 @@ Aspect model in GitHub: "key": "parentOrderNumber", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" }, - { - "key": "manufacturerPartId", - "value": "84816168424" - }, - { - "key": "nameAtManufacturer", - "value": "Black Leather Front Row Seat for Vehicle Model B" - }, { "key": "jisCallDate", "value": "2022-01-24T09:13:34" diff --git a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx index bf195f382a9..8c0799906d0 100644 --- a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx +++ b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx @@ -209,7 +209,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, @@ -253,7 +253,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, diff --git a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/page_changelog.mdx b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/page_changelog.mdx index 6c0ca08be54..6e5e6ff9e0c 100644 --- a/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/page_changelog.mdx +++ b/docs-kits_versioned_docs/version-24.08/kits/Industry Core Kit/page_changelog.mdx @@ -29,6 +29,17 @@ import Notice from './part_notice.mdx' All notable changes to this Kit will be documented in this file. +## [1.1.1] - 2024-10-23 + +Compatible for **release 24.08**. + +### Removed + +- **Development View:** + - **Aspect Models:** + - Removed the *manufacturerPartId* in the key-value list of the localIdentifiers for the SerialPart, Batch and JustInsequencePart JSON-Example + - Replaced the faulty (production) country abbreviation in the JSON-Example of the Batch aspect model from *HUR* to *DEU* + ## [1.1.0] - 2024-07-11 Compatible for **release 24.08**. diff --git a/docs/release/trg-7/trg-7-09.md b/docs/release/trg-7/trg-7-09.md new file mode 100644 index 00000000000..f83826715a0 --- /dev/null +++ b/docs/release/trg-7/trg-7-09.md @@ -0,0 +1,149 @@ +--- +title: TRG 7.09 - Deprecation of Unmaintained Repositories +--- + +| Status | Created | Post-History | +|---------|-------------|---------------------------------------| +| Active | 12-Nov-2024 | Initial draft | + +## Why + +Eclipse Tractus-X is an open source project governed by the Eclipse Foundation and its Committers. Besides the role participating in maintaining the code base, committers are responsible for its security and adherence to the [Eclipse Tractus-X Releases Guidelines](https://eclipse-tractusx.github.io/docs/release) (TRG's) as well as the guidelines set by the Eclipse Foundation. As this group of committers is responsible for the whole project and has limited resources, repositories that are not maintained for a given time period will be deprecated. + +## Description + +Deprecation of a repository means that **the repository is being archived**, i.e. set to status "Public Archive" on Github. It's still accessible from within the project, so that it could be revived. Please refer to [this list for examples of archived repositories within Eclipse Tractus-X](https://github.com/eclipse-tractusx/?q=&type=archived&language=&sort=). + +Additionally the helm charts and container images are still available and no information about the deprecation is passed to the user. + +### Criteria for Deprecation + +Committers consider the following criteria to propose deprecation of a repository: + +1. The repository does not comply with the Eclipse Tractus-X Releases Guidelines (TRG's) and/or the guidelines set by the Eclipse Foundation (i.e. Security, Intellectual Property, etc.) + +In case of repositories belonging to a [Product](https://eclipse-tractusx.github.io/community/products): + + +2. The product of the repository has not been released within the _past year's major release cycle_**\***. +3. The standards used by the product have been changed in a major version within the _past year's major release cycle_**\***. + + +**\*** The _past year's major release cycle_ is the time span between the breaking change releases YY.06 e.g., 24.05 till 24.05. + +### Deprecation Process + +To ensure the communities awareness the following process is used at least per major release planning: + +```mermaid +graph TD + A[1: Prepare list of unmaintained repositories] --> B[2-1: Draft critical issue for committer meeting] + B --> C[2-2: Inform Eclipse Tractus-X community] + C --> D[3: 2 week period: Comment on issue for criteria discussion] + D --> E[4-1: Committer meeting: Discuss list] + E --> F[4-2: Send email to mailing list] + F --> G{5: Action taken within 4 weeks?} + G -->|No| H[End of Release: Deprecate repository] + G -->|Yes| I[Plan Update of repository] + H --> J[Create issue in .eclipsefdn] +``` + +1. The committers prepare a list of unmaintained repositories. +2. The committers inform the Eclipse Tractus-X community via the [dev mailing list](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute/#dev-mailinglist). This is done by an issue with checkboxes listing all these repositories (find the issue template [below](#issue-template-for-deprecation-list)). Additionally a critical issue is drafted on the [board for the committer meeting](https://github.com/orgs/eclipse-tractusx/projects/61/views/6) in at least 2 full weeks. +3. 2 weeks period: The committers comment the issue regarding which repositories are confronted with the [deprecation criteria](#criteria-for-deprecation). +4. Committer meeting: The committers discuss the list and check the boxes in the issue. As a result, a mail is sent out to the Eclipse Tractus-X mailing list. This list is split into network service products (e.g. Eclipse Tractus-X EDC), use case products (e.g. PURIS) and supporting repositories (e.g. API Hub). See a template below. +5. If no action is taken within additional **4 weeks** the project leads will proceed with the deprecation of the given repositories and communicate accordingly on the dev mailing list. +6. In case the repository got deprecated, and there is again maintenance or develop capacity, the following procedure **MUST** be followed [Repository Reactivation Process](#repository-reactivation-process) by a committer. + +### Issue Template for Deprecation List + +``` markdown +# Deprecation List + +The following repositories fulfill at least **criteria 1** so that deprecation has been proposed with this issue following [TRG 7.09](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-09). + +Dear @eclipse-tractusx/automotive-tractusx-committers please check the following list and comment which of the repositories shall be marked for deprecation. The list will be discussed as a critical topic in the committer meeting in two weeks. + +- [ ] sample repo link 1 +- [ ] sample repo link 2 +``` + +### Mail Template for Deprecation + +``` markdown +Dear Eclipse Tractus-X Community, + +Following repositories are proposed to be subject to deprecation with the upcoming release following [TRG 7.09](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-09). + +**Network Service Products (CRITICAL)**: +- link to repository 1 + +**Use Case Products**: +- link to repository 2 + + +**Supporting repository**: +- link to repository 3 + +**Call to Action**: Please discuss within your company e.g., with your Catena-X responsibles, whether you run into an issue. We highly encourage the companies to at least find resources for the **Network Service Products** to maintain an open source data space. +``` + +## Reactivation Guidelines + +Your repository got deprecated? No worries, follow the following steps to get it back on its feet: + +### Repository Reactivation Criteria + +In case a repository you are maintaining or want to maintain got deprecated after all the [Criteria for Deprecation](#criteria-for-deprecation) are fulfilled, and the [Deprecation Process](#deprecation-process) finalized, the following criteria **MUST** be fulfilled to reactivate your repository: + +1. The committer and requestor has capacity to resolve the security vulnerabilities and assure that the repository will comply and keep up to date with the TRGs. +2. Capacity to maintain the repository is available. +3. A solid reason is provided to reactivate the repository. + +### Repository Reactivation Process + +```mermaid +flowchart TD + A[1: Requestor creates an issue in the sig-infra repository following a template] --> B[2: Requestors send an email to the tractusx-dev mailing list informing of responsible committer, issue id and reason for reactivation] + B --> C[3: Requestor informs the community in the office hour] + C --> D{Reactivation Criteria Fulfilled?} + D --> |NO| E[4: Project Lead closes the issue in Github] + D --> |YES| F[4: Project Lead opens issue in .eclipsefdn] + F --> G[5:Once reactivated, the Project Lead announces it in the mailing list] + G --> H[6: The Issue in sig-infra is closed] +``` + +1. The requestor **MUST** create an issue in the [sig-infra](https://github.com/eclipse-tractusx/sig-infra) repository following the template [below](#issue-template-for-reactivation). +2. The requestor **MUST** announce the repository reactivation proposal on the [tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list mentioning the `issue id`, the `reason/motivation`. A `responsible committer` **MUST** be announced. +3. The requestor **MUST** inform the community within the Office Hour about the petition. +4. A project lead will open a issue at the [.eclipsefdn](https://github.com/eclipse-tractusx/.eclipsefdn) requesting the reactivation of the repository. +5. Once the repository is reactivated, the project lead sends a mail to the [tractusx-dev](https://accounts.eclipse.org/mailing-list/tractusx-dev) mailing list announcing the reactivation. +6. The project lead closes the issue in [sig-infra](https://github.com/eclipse-tractusx/sig-infra). + +### Issue Template for Reactivation + +```markdown +Title: Request for repository [] reactivation +Content: +## Context + +**Requester**: @a-contributor-or-committer-github-user +**Responsible Committer**: @a-committer-github-user + +**Respository to reactivate**: + +### Reason + + + +## Acknowledgments + +- [ ] I have checked and verified that the repository fulfills the [Reactivation Guidelines](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-09) + +- [ ] I have emailed the mailing list announcing the committer assigned to the repository, providing a reasonable motivation for the repository reactivation. + +- [ ] I have the consent of the committer, which will be responsible for making sure the latest [TRGs](https://eclipse-tractusx.github.io/docs/release) are followed. + +- [ ] The committer will monitor and take care that the open security issues of the reactivated repository. Following the [Security TRGs](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-01) + +``` diff --git a/docs/website-guidelines/kit-structure.md b/docs/website-guidelines/kit-structure.md index 41024a124dd..0fb8602d38a 100644 --- a/docs/website-guidelines/kit-structure.md +++ b/docs/website-guidelines/kit-structure.md @@ -25,49 +25,49 @@ Each folder/KIT's content is structured in at least four pages/subfolders: root └── docs-kits └── kits - └── NewKIT + └── new-kit ``` -2. Inside the `NewKIT` folder, add a `page_adoption-view.md` file with the content that suits your use case +2. Inside the `new-kit` folder, add a `page_adoption-view.md` file with the content that suits your use case ```md root └── docs-kits └── kits - └── NewKIT + └── new-kit └── page_adoption-view.md ``` -3. Inside the `NewKIT` folder, add a `page_software-operation-view.md` file with the content that suits your use case +3. Inside the `new-kit` folder, add a `page_software-operation-view.md` file with the content that suits your use case ```md root └── docs-kits └── kits - └── NewKIT + └── new-kit ├── page_adoption-view.md └── page_software-operation-view.md ``` -4. Inside the `NewKIT` folder, add a `page_documentation.md` file with the content that suits your use case +4. Inside the `new-kit` folder, add a `page_documentation.md` file with the content that suits your use case ```md root └── docs-kits └── kits - └── NewKIT + └── new-kit ├── page_adoption-view.md ├── page_software-operation-view.md └── page_documentation.md ``` -5. Inside the `NewKIT` folder, add a `SoftwareDevelopmentView` folder that contains a `page_software-development-view.md` file with the content that suits your use case +5. Inside the `new-kit` folder, add a `SoftwareDevelopmentView` folder that contains a `page_software-development-view.md` file with the content that suits your use case ```md root └── docs-kits └── kits - └── NewKIT + └── new-kit ├── page_adoption-view.md ├── page_software-operation-view.md ├── page_documentation.md @@ -115,7 +115,7 @@ If you have any questions, please use our [“Tractus-X community call”](https items: [ { type: "autogenerated", - dirName: "kits/New KIT folder name given", //change here according your KIT + dirName: "kits/new-kit folder name given", //change here according your KIT }, ], }, diff --git a/docusaurus.config.js b/docusaurus.config.js index 7635deaf83f..9e5aecda44f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -202,34 +202,6 @@ const config = { id: "docs-kits", docsPluginId: "docs-kits", config: { - bpdm_gate: { - specPath: "./openApi/bpdm/gate.yaml", - outputDir: "./docs-kits/kits/Business Partner Kit/Software Development View/Gate Api", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, - bpdm_pool: { - specPath: "./openApi/bpdm/pool.yaml", - outputDir: "./docs-kits/kits/Business Partner Kit/Software Development View/Pool Api", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, - bpdm_cleaning: { - specPath: "./openApi/bpdm/cleaning-dummy.yaml", - outputDir: "./docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, - bpdm_orchestrator: { - specPath: "./openApi/bpdm/orchestrator.yaml", - outputDir: "./docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api", - sidebarOptions: { - groupPathsBy: "tag", - }, - }, irs: { specPath: "./openApi/irs/irs-api.yaml", outputDir: "./docs-kits/kits/Data Chain Kit/Software Development View/Job Api", diff --git a/openApi/bpdm/cleaning-dummy.yaml b/openApi/bpdm/kit_business-partner-kit-cleaning-dummy_openAPI.yaml similarity index 100% rename from openApi/bpdm/cleaning-dummy.yaml rename to openApi/bpdm/kit_business-partner-kit-cleaning-dummy_openAPI.yaml diff --git a/openApi/bpdm/gate.yaml b/openApi/bpdm/kit_business-partner-kit-gate_openAPI.yaml similarity index 100% rename from openApi/bpdm/gate.yaml rename to openApi/bpdm/kit_business-partner-kit-gate_openAPI.yaml diff --git a/openApi/bpdm/orchestrator.yaml b/openApi/bpdm/kit_business-partner-kit-orchestrator_openAPI.yaml similarity index 100% rename from openApi/bpdm/orchestrator.yaml rename to openApi/bpdm/kit_business-partner-kit-orchestrator_openAPI.yaml diff --git a/openApi/bpdm/pool.yaml b/openApi/bpdm/kit_business-partner-kit-pool_openAPI.yaml similarity index 100% rename from openApi/bpdm/pool.yaml rename to openApi/bpdm/kit_business-partner-kit-pool_openAPI.yaml diff --git a/sidebarsDocsKits.js b/sidebarsDocsKits.js index cee3e27352f..cf5931636eb 100644 --- a/sidebarsDocsKits.js +++ b/sidebarsDocsKits.js @@ -239,36 +239,24 @@ const sidebars = { items: [ 'kits/Business Partner Kit/Software Development View/Specification', { - type: "category", + type: "link", label: "Gate API", - link: { - type: "generated-index", - }, - items: require('./docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js'), + href: 'https://eclipse-tractusx.github.io/api-hub/eclipse-tractusx.github.io/kit_business-partner-kit-gate-V6.1.0/swagger-ui/' }, { - type: "category", + type: "link", label: "Pool API", - link: { - type: "generated-index", - }, - items: require('./docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js'), + href: 'https://eclipse-tractusx.github.io/api-hub/eclipse-tractusx.github.io/kit_business-partner-kit-pool-V6.1.0/swagger-ui/' }, { - type: "category", + type: "link", label: "Cleaning Dummy API", - link: { - type: "generated-index", - }, - items: require('./docs-kits/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js'), + href: 'https://eclipse-tractusx.github.io/api-hub/eclipse-tractusx.github.io/kit_business-partner-kit-cleaning-dummy-V6.1.0/swagger-ui/' }, { - type: "category", + type: "link", label: "Orchestrator API", - link: { - type: "generated-index", - }, - items: require('./docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js'), + href: 'https://eclipse-tractusx.github.io/api-hub/eclipse-tractusx.github.io/kit_business-partner-kit-orchestrator-V6.1.0/swagger-ui/' }, 'kits/Business Partner Kit/Software Development View/Use Cases' ] diff --git a/src/pages/release-information.md b/src/pages/release-information.md index 9ae5f9286c8..0eeb649ad5e 100644 --- a/src/pages/release-information.md +++ b/src/pages/release-information.md @@ -8,3 +8,8 @@ In addition you may want to check the recent releases for content which was publ Go to the [sig-release/README.md](https://github.com/eclipse-tractusx/sig-release/blob/main/README.md) for a consolidated package on release-relevant information. Visit [tractus-x-release/CHANGELOG.md](https://github.com/eclipse-tractusx/tractus-x-release/blob/main/CHANGELOG.md) for our periodic release info. + +:::tip +The timelines for the current and next releases, can be found on the [Release Planning Board](https://github.com/orgs/eclipse-tractusx/projects/26/views/35). The milestone filter can be used, +to select a dedicated release and check the progress of the release. +::: diff --git a/static/img/tractus-x-community-days-agenda-24-12-day1.png b/static/img/tractus-x-community-days-agenda-24-12-day1.png new file mode 100644 index 00000000000..48f38c2f8e0 Binary files /dev/null and b/static/img/tractus-x-community-days-agenda-24-12-day1.png differ diff --git a/static/img/tractus-x-community-days-agenda-24-12-day2.png b/static/img/tractus-x-community-days-agenda-24-12-day2.png new file mode 100644 index 00000000000..6f5ce7bb19f Binary files /dev/null and b/static/img/tractus-x-community-days-agenda-24-12-day2.png differ diff --git a/static/img/tractus-x-community-days-agenda-24-12.png b/static/img/tractus-x-community-days-agenda-24-12.png deleted file mode 100644 index d01dd0463f0..00000000000 Binary files a/static/img/tractus-x-community-days-agenda-24-12.png and /dev/null differ diff --git a/static/meetings/alignment-and-planning-trace-x.ics b/static/meetings/alignment-and-planning-trace-x.ics deleted file mode 100644 index 295b063483a..00000000000 --- a/static/meetings/alignment-and-planning-trace-x.ics +++ /dev/null @@ -1,64 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Martin Kanal:mailto:martin.kanal@doubleslash.de -DESCRIPTION:Microsoft Teams-Besprechung\nNehmen Sie auf dem Computer\, in d - er mobilen App oder im Raumgerät teil\nHier klicken\, um an der Besprechu - ng teilzunehmen\nBesprechungs-ID: 398 755 550 092\n - Passcode: q9b7H4\nTeams herunterladen | Im Web beitreten\n -UID:040000008200E00074C5B7101A82E00800000000AE27B76AE649DA01000000000000000 - 010000000C3CE29B53C3E8648A87B7C828F916A2C -SUMMARY:[C-X] Alignment & Open Planning Trace-X (Follow-up) -DTSTART:20240122T143000Z -DTEND:20240122T150000Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240118T081455Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:Microsoft Teams Meeting -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:0 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_NTA2NTRhNjAtYzMyYi00OTBkLWIxYTUtM2FhNjgzOGU2ZjBk%40thread.v2/ - 0?context=%7b%22Tid%22%3a%2226f86412-f875-4281-b566-fe6fe385e17c%22%2c%22O - id%22%3a%22db3ba521-7335-4e4f-b672-fc9f7c3f5536%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_NTA2NTRhNjAtYzMyYi00OTB - kLWIxYTUtM2FhNjgzOGU2ZjBk@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva - te":true\,"type":0} -X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/committer-office-hour.ics b/static/meetings/committer-office-hour.ics deleted file mode 100644 index c085798cccc..00000000000 --- a/static/meetings/committer-office-hour.ics +++ /dev/null @@ -1,55 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net -RRULE:FREQ=WEEKLY;UNTIL=20241229T230000Z;INTERVAL=2;BYDAY=FR;WKST=MO -UID:040000008200E00074C5B7101A82E00800000000BEC23346A689DA01000000000000000 - 0100000005B5619B57D8ABD45AA6CC43444A08EF3 -SUMMARY:Committer Meeting -DTSTART:20240412T120500Z -DTEND:20240412T130000Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240408T111709Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:Microsoft Teams Meeting -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:1 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_ZjlmNTc5MjMtN2Y2YS00YjliLTg3NTItNWE1MmMzMWUzNmYw%40thread.v2/ - 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O - id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_ZjlmNTc5MjMtN2Y2YS00Yjl - iLTg3NTItNWE1MmMzMWUzNmYw@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva - te":true\,"type":0\,"ct":null\,"btid":null} -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/coordination-feature-development-trace-x.ics b/static/meetings/coordination-feature-development-trace-x.ics deleted file mode 100644 index 443f5194bad..00000000000 --- a/static/meetings/coordination-feature-development-trace-x.ics +++ /dev/null @@ -1,79 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Martin Kanal:mailto:Martin.Kanal@doubleslash.de -DESCRIPTION:Trace-X Open Meeting\n\nVisibility: Public (Tractus-X)\nTitle: - Trace-X Open Meeting\nScope: Coordination of feature development & concept - s\nParticipants: Core Team & Contributors\nDuration: 40 min\nFrequency: We - ekly\nGithub Project:\nhttps://github.com/orgs/eclipse-tractusx/projects/4 - 5/views/5\n\nLink to repository:\nhttps://github.com/eclipse-tractusx/trac - eability-foss\n\nAgenda of the weeklies will be managed in the Projects Di - scussions:\nhttps://github.com/eclipse-tractusx/traceability-foss/discussi - ons\n\n___________________________________________________________________ - ____________\nMicrosoft Teams-Besprechung\nNehmen Sie auf dem Computer\, i - n der mobilen App oder im Raumgerät teil\nHier klicken\, um an der Bespre - chung teilzunehmen\nBesprechungs-ID: 326 272 032 68 - \nPasscode: 6LjF9m\nTeams herunterladen | Im Web beitreten\n[https://www.doubleslash.de/fileadmin/doub - leslash/Bilder/Logo_doubleSlash/logo_doubleSlash_Sonderform_black_p_V1.jpg - ]\nWeitere Infos | Besprechungsoptionen\n__________________________________________________ - ______________________________\n\n -RRULE:FREQ=WEEKLY;COUNT=20;INTERVAL=1;BYDAY=TH;WKST=MO -UID:040000008200E00074C5B7101A82E0080000000060E55CB66353DA01000000000000000 - 01000000022D74E86EAB7A9458533696031E195CD -SUMMARY:[TRACE-X] Trace-X Open Meeting -DTSTART:20240208T130500Z -DTEND:20240208T134500Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240130T095443Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:Microsoft Teams-Besprechung -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:1 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_MTEyNTAyNTYtY2VkOC00ZDdjLTk0NTItNWViYTJmNmJmOTlh%40thread.v2/ - 0?context=%7b%22Tid%22%3a%2226f86412-f875-4281-b566-fe6fe385e17c%22%2c%22O - id%22%3a%22db3ba521-7335-4e4f-b672-fc9f7c3f5536%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_MTEyNTAyNTYtY2VkOC00ZDd - jLTk0NTItNWViYTJmNmJmOTlh@thread.v2"\,"private":true\,"type":0\,"mid":0\," - rid":0\,"uid":null} -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams-Besprechung -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/edc-weekly-extended.ics b/static/meetings/edc-weekly-extended.ics deleted file mode 100644 index 6acf5f69161..00000000000 --- a/static/meetings/edc-weekly-extended.ics +++ /dev/null @@ -1,95 +0,0 @@ -BEGIN:VCALENDAR -PRODID:-//Microsoft Corporation//Outlook 16.0 MIMEDIR//EN -VERSION:2.0 -METHOD:REQUEST -X-MS-OLK-FORCEINSPECTOROPEN:TRUE -BEGIN:VTIMEZONE -TZID:W. Europe Standard Time -BEGIN:STANDARD -DTSTART:16011028T030000 -RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 -TZOFFSETFROM:+0200 -TZOFFSETTO:+0100 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010325T020000 -RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=3 -TZOFFSETFROM:+0100 -TZOFFSETTO:+0200 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -CLASS:PUBLIC -CREATED:20240619T122822Z -DESCRIPTION:Hello all\,\n\n \n\nThis meeting is s - et up for the greater Catena-X community to get in touch with the EDC deve - lopment team in order to ask questions or discuss issues around the Tractu - s-X EDC.\n\n \n\nTo raise questions in advance of the meeting\, please go - to the EDC repo: https://github.com/eclipse-tractusx/tractusx-edc/discuss - ions \n\n \ - n\nAnd create a question:\n\n1. Create a new discussion on the repo’s di - scussion tab\n2. Select the Q&A category for the issue\n3. Start the title - with the prefix [Extended Sync]…your title goes here\n\n \n\nPoint 3 en - sures we are able to filter accordingly and find your questions fast and e - asy.\n\n \n\nIf you have any questions\, please get back to me or contact - the team via the matrix channel and we will try to help as fast as possibl - e.\n\n \n\nThanks and have a nice day\,\n\nLars\n\n\nJoin Zoom Meeting\nht - tps://eclipse.zoom.us/j/85945828202?pwd=YODkCen20BOQV9WNJEeNFM8zaOlxo9.1 < - https://eclipse.zoom.us/j/85945828202?pwd=YODkCen20BOQV9WNJEeNFM8zaOlxo9.1 - > \n\nMeeting ID: 859 4582 8202\nPasscode: 186934\n\n---\n\nOne tap mobile - \n+17193594580\,\,85945828202# US\n+12532050468\,\,85945828202# US\n\n---\ - n\nDial by your location\n• +1 719 359 4580 US\n• +1 253 205 0468 US\n - • +1 253 215 8782 US (Tacoma)\n• +1 301 715 8592 US (Washington DC)\n - • +1 305 224 1968 US\n• +1 309 205 3325 US\n• +1 312 626 6799 US (Ch - icago)\n• +1 346 248 7799 US (Houston)\n• +1 360 209 5623 US\n• +1 3 - 86 347 5053 US\n• +1 507 473 4847 US\n• +1 564 217 2000 US\n• +1 646 - 876 9923 US (New York)\n• +1 646 931 3860 US\n• +1 669 444 9171 US\n - • +1 669 900 6833 US (San Jose)\n• +1 689 278 1000 US\n• +1 647 558 - 0588 Canada\n• +1 778 907 2071 Canada\n• +1 780 666 0144 Canada\n• + - 1 204 272 7920 Canada\n• +1 438 809 7799 Canada\n• +1 587 328 1099 Can - ada\n• +1 647 374 4685 Canada\n• +33 1 7095 0350 France\n• +33 1 869 - 9 5831 France\n• +33 1 7037 2246 France\n• +33 1 7037 9729 France\n• - +33 1 7095 0103 France\n• +49 695 050 2596 Germany\n• +49 69 7104 992 - 2 Germany\n• +49 69 3807 9883 Germany\n• +49 69 3807 9884 Germany\n• - +49 69 5050 0951 Germany\n• +49 69 5050 0952 Germany\n• +44 208 080 6 - 591 United Kingdom\n• +44 208 080 6592 United Kingdom\n• +44 330 088 5 - 830 United Kingdom\n• +44 131 460 1196 United Kingdom\n• +44 203 481 5 - 237 United Kingdom\n• +44 203 481 5240 United Kingdom\n• +44 203 901 7 - 895 United Kingdom\n• +41 43 210 71 08 Switzerland\n• +41 44 529 92 72 - Switzerland\n• +41 22 591 00 05 Switzerland\n• +41 22 591 01 56 Switz - erland\n• +41 31 528 09 88 Switzerland\n• +41 43 210 70 42 Switzerland - \n• +46 8 5052 0017 Sweden\n• +46 850 539 728 Sweden\n• +46 8 4468 2 - 488 Sweden\n• +46 8 5016 3827 Sweden\n• +46 8 5050 0828 Sweden\n• +4 - 6 8 5050 0829 Sweden\n• +45 47 37 25 75 Denmark\n• +45 89 88 37 88 Den - mark\n• +45 32 70 12 06 Denmark\n• +45 32 71 31 57 Denmark\n• +45 32 - 72 80 10 Denmark\n• +45 32 72 80 11 Denmark\n• +31 20 794 7345 Nether - lands\n• +31 707 006 526 Netherlands\n• +31 20 241 0288 Netherlands\n - • +31 20 794 0854 Netherlands\n• +31 20 794 6519 Netherlands\n• +31 - 20 794 6520 Netherlands\n\nMeeting ID: 859 4582 8202\n\nFind your local nu - mber: https://eclipse.zoom.us/u/kitPLq9X0 \n\n -DTEND;TZID="W. Europe Standard Time":20240625T110000 -DTSTAMP:20240619T095755Z -DTSTART;TZID="W. Europe Standard Time":20240625T103000 -LAST-MODIFIED:20240619T122822Z -LOCATION:https://eclipse.zoom.us/j/85945828202?pwd=YODkCen20BOQV9WNJEeNFM8z - aOlxo9.1 -ORGANIZER;CN="Lars Geyer-Blaumeiser":mailto:lars.blaumeiser@cofinity-x.com -PRIORITY:5 -RRULE:FREQ=WEEKLY;COUNT=53;BYDAY=TU -SEQUENCE:2 -SUMMARY:EDC Weekly | Extended -TRANSP:OPAQUE -UID:ZOOM85945828202 -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MS-OLK-APPTLASTSEQUENCE:2 -BEGIN:VALARM -TRIGGER:-PT10M -ACTION:DISPLAY -DESCRIPTION:Reminder -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/office-hour.ics b/static/meetings/office-hour.ics deleted file mode 100644 index 0ddc622e77f..00000000000 --- a/static/meetings/office-hour.ics +++ /dev/null @@ -1,55 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net -RRULE:FREQ=WEEKLY;UNTIL=20241229T230000Z;INTERVAL=1;BYDAY=FR;WKST=MO -UID:040000008200E00074C5B7101A82E00800000000AA5570E7A589DA01000000000000000 - 0100000008A72A38523A5574690821DB20381A598 -SUMMARY:Office Hour -DTSTART:20240412T110500Z -DTEND:20240412T120000Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240408T111427Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:Microsoft Teams Meeting -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:1 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_MDFiNDJjMmQtNjFkYi00ODdjLTk2NDgtZGMwNTRmYzg3NzM0%40thread.v2/ - 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O - id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_MDFiNDJjMmQtNjFkYi00ODd - jLTk2NDgtZGMwNTRmYzg3NzM0@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva - te":true\,"type":0\,"ct":null\,"btid":null} -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/portal-open-meeting.ics b/static/meetings/portal-open-meeting.ics deleted file mode 100644 index 60a7e900ab7..00000000000 --- a/static/meetings/portal-open-meeting.ics +++ /dev/null @@ -1,78 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net -DESCRIPTION:https://teams.microsoft.com/l/meetup-join/19%3ameeting_YmIyYjgw - OTQtZjI1Ny00YmM0LTlmOWQtODRjZWFmZWM1Y2E3%40thread.v2/0?context=%7b%22Tid%2 - 2%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22Oid%22%3a%22a8b7a5ee-6 - 6ff-4695-afa2-08f893d8aaf6%22%7d\n________________________________________ - ________________________________________\nMicrosoft Teams Benötigen Sie H - ilfe?\nJetzt an der Besprechun - g teilnehmen\nBesprechungs-ID: 323 046 266 737\nKen - nung: 5rX5Vy\n________________________________\nFür Organisatoren: Bespre - chungsoptionen\n__________________________________ - ______________________________________________\n -RRULE:FREQ=WEEKLY;UNTIL=20241230T230000Z;INTERVAL=1;BYDAY=TH;WKST=MO -UID:040000008200E00074C5B7101A82E0080000000027A164AF93CBDA01000000000000000 - 010000000FB448A362B62AC4F8BCA460CB8DE3866 -SUMMARY:Portal - Open Meeting -DTSTART:20240704T113500Z -DTEND:20240704T120000Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240701T114651Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:https://teams.microsoft.com/l/meetup-join/19%3ameeting_YmIyYjgwOTQ - tZjI1Ny00YmM0LTlmOWQtODRjZWFmZWM1Y2E3%40thread.v2/0?context=%7b%22Tid%22%3 - a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22Oid%22%3a%22a8b7a5ee-66ff - -4695-afa2-08f893d8aaf6%22%7d -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:1 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_YmIyYjgwOTQtZjI1Ny00YmM0LTlmOWQtODRjZWFmZWM1Y2E3%40thread.v2/ - 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O - id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_YmIyYjgwOTQtZjI1Ny00YmM - 0LTlmOWQtODRjZWFmZWM1Y2E3@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva - te":true\,"type":0} -X-MICROSOFT-ONLINEMEETINGEXTERNALLINK: -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:https://teams.microsoft.com/l/meetup-join/1 - 9%3ameeting_YmIyYjgwOTQtZjI1Ny00YmM0LTlmOWQtODRjZWFmZWM1Y2E3%40thread.v2/0 - ?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22Oi - d%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR diff --git a/static/meetings/security-office-hour.ics b/static/meetings/security-office-hour.ics deleted file mode 100644 index 7b1fd6212ae..00000000000 --- a/static/meetings/security-office-hour.ics +++ /dev/null @@ -1,55 +0,0 @@ -BEGIN:VCALENDAR -METHOD:PUBLISH -PRODID:Microsoft Exchange Server 2010 -VERSION:2.0 -BEGIN:VTIMEZONE -TZID:tzone://Microsoft/Utc -BEGIN:STANDARD -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:STANDARD -BEGIN:DAYLIGHT -DTSTART:16010101T000000 -TZOFFSETFROM:+0000 -TZOFFSETTO:+0000 -END:DAYLIGHT -END:VTIMEZONE -BEGIN:VEVENT -ORGANIZER;CN=Stephan Bauer:mailto:stephan.bauer@catena-x.net -RRULE:FREQ=WEEKLY;UNTIL=20241229T230000Z;INTERVAL=2;BYDAY=TH;WKST=MO -UID:040000008200E00074C5B7101A82E008000000001FCA7B6BA689DA01000000000000000 - 01000000091B106F143A50941B72CBC0BABE2F653 -SUMMARY:Security - Office Hour -DTSTART:20240411T063500Z -DTEND:20240411T073000Z -CLASS:PUBLIC -PRIORITY:5 -DTSTAMP:20240408T111808Z -TRANSP:OPAQUE -STATUS:CONFIRMED -LOCATION:Microsoft Teams Meeting -X-MICROSOFT-CDO-BUSYSTATUS:BUSY -X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY -X-MICROSOFT-CDO-ALLDAYEVENT:FALSE -X-MICROSOFT-CDO-IMPORTANCE:1 -X-MICROSOFT-CDO-INSTTYPE:1 -X-MICROSOFT-SKYPETEAMSMEETINGURL:https://teams.microsoft.com/l/meetup-join/ - 19%3ameeting_MzYzMzVhODMtYWQyOC00NWVlLWEyMjMtNjVlZmY2NTlkNTdk%40thread.v2/ - 0?context=%7b%22Tid%22%3a%221ad22c6d-2f08-4f05-a0ba-e17f6ce88380%22%2c%22O - id%22%3a%22a8b7a5ee-66ff-4695-afa2-08f893d8aaf6%22%7d -X-MICROSOFT-SKYPETEAMSPROPERTIES:{"cid":"19:meeting_MzYzMzVhODMtYWQyOC00NWV - lLWEyMjMtNjVlZmY2NTlkNTdk@thread.v2"\,"rid":0\,"mid":0\,"uid":null\,"priva - te":true\,"type":0\,"ct":null\,"btid":null} -X-MICROSOFT-ONLINEMEETINGINFORMATION:{"OnlineMeetingChannelId":null\,"Onlin - eMeetingProvider":3} -X-MICROSOFT-DONOTFORWARDMEETING:FALSE -X-MICROSOFT-DISALLOW-COUNTER:FALSE -X-MICROSOFT-LOCATIONDISPLAYNAME:Microsoft Teams Meeting -BEGIN:VALARM -DESCRIPTION:REMINDER -TRIGGER;RELATED=START:-PT15M -ACTION:DISPLAY -END:VALARM -END:VEVENT -END:VCALENDAR