Mit der Entität ExternalIdentifier
können Feedersteller beliebige Gruppen von Quell/Wert-Paaren mit bestimmten Objekten verknüpfen. ExternalIdentifier
ist häufig der Code einer Gerichtsbarkeit in einem externen System. Er wird verwendet, um eine Rechtsprechung mit Objekten wie Kandidaten, Ämtern oder geopolitischen Einheiten zu verknüpfen.
Das Feld Type
einer ExternalIdentifier
-Entität wird verwendet, um die Quelle der Kennung zu beschreiben, nicht das zu identifizierende Objekt. Zwei der integrierten Typen sind beispielsweise fips
, eine Abkürzung für „Federal Information Processing Standard“, und state
. Obwohl zweistellige FIPS-Codes zur Beschreibung von Zuständen verwendet werden können, ist der beabsichtigte Type
-Wert in diesem Fall fips
und nicht state
. Das liegt daran, dass fips
die Quelle der Kennung beschreibt.
Externe Kennungen werden im Feed zu folgenden Zwecken verwendet:
- Geben Sie eine stabile Kennung an.
- Geben Sie eine kanonische Kennung von einer externen Ressource an, z. B. Open Civic Data Identifiers oder einen FIPS-Code.
- Geben Sie zusätzliche Attribute an, die im NIST CDF-Schema nicht nativ sind.
Wenn externe Kennungen verwendet werden, um zusätzliche Daten oder Kontext für ein Objekt bereitzustellen, müssen sie eine Type
von other
verwenden. Sie enthalten auch ein OtherType
und ein Value
, die beide vom bereitgestellten Datentyp abhängen. Ein Beispiel für die Bereitstellung von Daten auf diese Weise finden Sie unter Office
.
Attribute
In der folgenden Tabelle werden die Attribute für ExternalIdentifier
beschrieben:
Attribut | Erforderlich/Optional? | Typ | Beschreibung |
---|---|---|---|
label |
Optional | string |
Ein Informationslabel. Wird bei Bedarf verwendet. |
Elemente
In der folgenden Tabelle sehen Sie die Elemente für ExternalIdentifier
:
Element | Multiplizität | Typ | Beschreibung |
---|---|---|---|
Type |
1 | IdentifierType |
Stellt einen Kennungstyp bereit. |
OtherType |
0 oder 1 | string |
Wird verwendet, wenn der Wert von IdentifierType other ist. |
Value |
1 | string |
Die von der Gerichtsbarkeit verwendete Kennung. |
Beispiele
XML
<ExternalIdentifiers> <ExternalIdentifier> <Type>other</Type> <OtherType>stable</OtherType> <Value>stable-gu-0081</Value> </ExternalIdentifier> <ExternalIdentifier> <Type>ocd-id</Type> <Value>ocd-division/country:ke/county:narok</Value> </ExternalIdentifier> <ExternalIdentifier> <Type>national-level</Type> <Value>33</Value> </ExternalIdentifier> </ExternalIdentifiers>
JSON
"ExternalIdentifiers": { "ExternalIdentifier" : [ { "Type": "other", "OtherType": "stable", "Value": "stable-gu-0081" }, { "Type": "ocd-id", "Value": "ocd-division/country:ke/county:narok" }, { "Type": "national-level", "Value": "33" } ] }