Externer Bezeichner

Mit der ExternalIdentifier-Entität können Feed-Ersteller beliebige Gruppen von Quellwertpaaren bestimmten Objekten zuordnen. ExternalIdentifier ist häufig der Code einer Gerichtsbarkeit in einem externen System, der verwendet wird, um eine Gerichtsbarkeit 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 identifizierte Objekt. Zwei der integrierten Typen sind beispielsweise fips (Abkürzung für „Federal Information Processing Standard“-Code) und state. Auch wenn zweistellige FIPS-Codes zur Beschreibung von Bundesstaaten verwendet werden können, ist der vorgesehene Type-Wert für diese Situation fips und nicht state. Das liegt daran, dass fips die Quelle der ID beschreibt.

Externe Kennungen werden im gesamten Feed für die folgenden Zwecke verwendet:

  • Geben Sie eine stabile Kennung an.
  • Geben Sie eine kanonische Kennung aus einer externen Ressource an, z. B. Open Civic Data-Kennungen oder FIPS-Code.
  • Geben Sie zusätzliche Attribute an, die nicht zum NIST CDF-Schema gehören.

Wenn externe Kennungen verwendet werden, um zusätzliche Daten oder Kontext für ein Objekt bereitzustellen, muss für Type der Wert other verwendet werden. Sie enthalten auch ein OtherType und ein Value, die beide vom Typ der bereitgestellten Daten abhängen. Ein Beispiel dafür, wie Daten auf diese Weise bereitgestellt werden können, finden Sie unter Office.

Attribute

In der folgenden Tabelle werden die Attribute für ExternalIdentifier beschrieben:

Attribut Erforderlich? Typ Beschreibung
label Optional string Ein informatives Label. Bei Bedarf verwenden.

Elemente

In der folgenden Tabelle sind die Elemente für ExternalIdentifier aufgeführt:

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"
        }
      ]
    }