Skip to content

CX-0012: Add Script Code Metadata Entity #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nicoprow wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −1
Draft

CX-0012: Add Script Code Metadata Entity #323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ca83e4
docs(0012): add script codes metadata
nicoprow May 21, 2026
67d0ab5
docs(0012): add script codes context
nicoprow May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion ...ndards/CX-0012-BusinessPartnerDataPoolAPI/CX-0012-BusinessPartnerDataPoolAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,17 @@ An identifier mapping entry of a specific identifier (of a specific identifier t
| Identifier Value | The value of a specific identifier type for which the mapping was returned. | String |
| BPN | The business partner number for which the mapping was returned. Can be either a BPNL, BPNS or BPNA. | String |

##### 1.5.2.13 SCRIPT CODE

A script code identifies a writing system. Script codes support the script variant feature defined in CX-0074 Business Partner Data Gate API, where legal entities, sites, and addresses can carry name and address fields in multiple writing systems simultaneously. The Pool exposes the available script codes so that Gate consumers can discover which writing systems the operator supports.

Script codes are provided as a read-only reference list; the actual codes used are defined by the operator and the standard does not prescribe which specific codes must be available. ISO 15924 codes (such as `Hans` for Simplified Chinese) are a natural example of what operators may choose to use.

@Sebastian-Wurm Sebastian-Wurm Jun 18, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Script codes are provided as a read-only reference list; the actual codes used are defined by the operator and the standard does not prescribe which specific codes must be available. ISO 15924 codes (such as `Hans` for Simplified Chinese) are a natural example of what operators may choose to use.
Script codes are provided as a read-only reference list; the actual codes used are defined by the operator and the standard does not prescribe which specific codes must be available. A subset of ISO 15924 codes (such as `Hans` for Simplified Chinese) are a natural example of what operators may choose to use.

Please also reference the standard in the reference chapter.


| **Attribute** | **Description** | **(Data) Type / Code List / Enumeration** |
| -------------- | --------------------------------------------- | ----------------------------------------- |
| Technical Key | The unique identifier for the script code (e.g. `Hans` for Simplified Chinese). | String |
| Description | The human-readable name of the writing system. | String |

## 2 BUSINESS PARTNER POOL API \[NORMATIVE\]

The Business Partner Data Pool API enables the access to Golden Record business partner data and provides it to other data space services and consumers. The Pool API **MUST** be implemented based on the [OpenAPI specification (3.1.0)](https://github.com/OAI/OpenAPI-Specification/blob/7acdf61ed4e5c18068e2da18741318adde219c2d/versions/3.1.0.md).
Expand Down Expand Up @@ -520,7 +531,7 @@ The address controller **MUST** allow to create, update, or read business partne

##### 2.2.1.4 METADATA CONTROLLER (CODE LISTS)

The metadata controller **MUST** allow to create or read legal forms, identifier types, and read administrative areas on level 1. It **MUST** have the following resources:
The metadata controller **MUST** allow to create or read legal forms, identifier types, and read administrative areas on level 1 and script codes. It **MUST** have the following resources:

| **Metadata Controller Resources** | **Description** |
| --------------------------------- | --------------------------------------------------------------------------- |
Expand All @@ -529,6 +540,7 @@ The metadata controller **MUST** allow to create or read legal forms, identifier
| GET/legal-forms | Returns all legal forms. |
| GET/identifier-types | Returns all identifier types filtered by business partner type and country. |
| GET/administrative-areas-level1 | Returns all administrative areas on level 1. |
| GET/script-codes | Returns all available script codes. |

##### 2.2.1.5 BPN CONTROLLER (IDENTIFIER MAPPINGS)

Expand Down
Loading