openpotato
You're using the term "Regionalschlüssel" incorrectly
You use the term "Regionalschlüssel"/"regional key" in various places (list probably incomplete):
- REST API documentation: https://www.openplzapi.org/de/germany/
- As CSV column header
RegionalKey - In readme
The Regionalschlüssel is defined as having 12 digits. You not only call the different shortened variants of it also a Regionalschlüssel, but also the 8-digit Gemeindeschlüssel, which can be derived from the Regionalschlüssel by removing 4 digits in the middle.
In my code, I used the following English and German terms for the different variants. I used "ID" instead of the literal translation "key" because the title of this Wikipedia article suggests that and it fits quite well:
- state ID (2 digits)
- goverment district ID (3 digits)
- The term "Regierungsbezirksschlüssel" was used by Destatis until around 2005 according to Google search. It still fits.
- Baden-Württemberg region ID (4 digits)
- county ID (5 digits)
- municipal-association ID (9 digits)
- "Gemeindeverbandsschlüssel" is used by Destatis to refer to the 4-digit part, not the shortened 12-digit municipality ID, so shouldn't be used.
- 12-digit municipality ID
- "Amtlicher Regionalschlüssel (ARS)". See "Regionale Standards, Ausgabe 2019", section 4.2, "Abbildung 4.2-02".
- 8-digit municipality ID
- "Amtlicher Gemeindeschlüssel (AGS)". See "Regionale Standards, Ausgabe 2019", section 4.2, "Abbildung 4.2-01".
You could always talk about a "shortened 12-digit municipality ID" or "gekürzter Amtlicher Regionalschlüssel"/"Amtlicher Regionalschlüssel, gekürzt bis zum/zur ...".
I know that Datensatzbeschreibung_GV100AD.pdf and Datensatzbeschreibung_GV100NAD.pdf from the GV100 .zip files also say "Amtlicher Regionalschlüssel", but that's obviously also wrong and should be "Amtlicher Gemeindeschlüssel". This would fit as a group description, in which role the term would be used there, with missing parts clearly indicated. Without such context, I don't think you should just call every shortened variant "Regionalschlüssel" or "Gemeindeschlüssel".
On https://www.openplzapi.org/de/germany/, there are two occurrences of:
Kombination aus Regionalschlüssel des Kreises und Schlüssel des Gemeindenverbandes (8-stellig)
"8-stellig" is incorrect, it has 9 digits. See here.
Thanks a lot for your feedback.
"8-stellig" is incorrect, it has 9 digits.
Fixed.
About regional key/Regionalschlüssel: You are probably right, I will revise the documentation as you recommend, but I cannot change the API interface, as this would lead to breaking changes.
