Identificatore esterno

L'entità ExternalIdentifier consente ai creatori di feed di associare insiemi arbitrari di coppie valore-origine a determinati oggetti. ExternalIdentifier è spesso il codice di una giurisdizione in un sistema esterno utilizzato per associare una giurisdizione a oggetti come candidati, uffici o unità geopolitiche.

Il campo Type di un'entità ExternalIdentifier viene utilizzato per descrivere l'origine dell'identificatore, non l'oggetto identificato. Ad esempio, due dei tipi integrati sono fips, un'abbreviazione del codice "Federal Information Processing Standard", e state. Anche se i codici FIPS a due cifre possono essere utilizzati per descrivere gli stati, il valore Type previsto per questa situazione è fips e non state. Questo perché fips descrive l'origine dell'identificatore.

Gli identificatori esterni vengono utilizzati in tutto il feed per i seguenti scopi:

  • Fornisci un identificatore stabile.
  • Fornisci un identificatore canonico di una risorsa esterna, ad esempio identificatori Open Civic Data o codice FIPS.
  • Fornisci attributi aggiuntivi non nativi dello schema NIST CDF.

Se utilizzati per fornire dati o contesto aggiuntivi per un oggetto, gli identificatori esterni devono utilizzare un Type di other. Includono anche un OtherType e un Value, entrambi dipendenti dal tipo di dati forniti. Per un esempio di come possono essere forniti i dati in questo modo, vedi Office.

Attributi

La tabella seguente descrive gli attributi per ExternalIdentifier:

Attributo Obbligatorio? Tipo Descrizione
label Facoltativo string Un'etichetta informativa. Da utilizzare in base alle necessità.

Elementi

La tabella seguente mostra gli elementi per ExternalIdentifier:

Elemento Molteplicità Tipo Descrizione
Type 1 IdentifierType Fornisce un tipo di identificatore.
OtherType 0 o 1 string Utilizzato quando il valore di IdentifierType è other.
Value 1 string L'identificatore utilizzato dalla giurisdizione.

Esempi

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