Identyfikator zewnętrzny

Element ExternalIdentifier umożliwia twórcom plików danych powiązywanie dowolnych zestawów par źródło-wartość z określonymi obiektami. ExternalIdentifier to często kod jurysdykcji w systemie zewnętrznym, który służy do łączenia jurysdykcji z obiektami takimi jak kandydaci, urzędy czy jednostki geopolityczne.

Pole Type elementu ExternalIdentifier służy do opisania źródła identyfikatora, a nie identyfikowanego obiektu. Na przykład 2 typy wbudowanych to fips (skrót od „Federal Information Processing Standard”) i state. Mimo że do opisania stanów można używać dwucyfrowych kodów FIPS, zamierzona wartość Type w tej sytuacji to fips, a nie state. Dzieje się tak, ponieważ pole fips opisuje źródło identyfikatora.

Zewnętrzne identyfikatory są używane w całym pliku danych w następujących celach:

  • Podaj stabilny identyfikator.
  • Podaj identyfikator kanoniczny z zasobu zewnętrznego, takiego jak Open Civic Data Identifiers lub kod FIPS.
  • Podaj dodatkowe atrybuty, które nie są natywne dla schematu NIST CDF.

Jeśli identyfikatory zewnętrzne zapewniają dodatkowe dane lub kontekst dla obiektu, muszą korzystać z atrybutu Type o wartości other. Zawierają też atrybuty OtherType i Value, które zależą od typu dostarczanych danych. Przykład tego, jak można przekazywać dane, znajdziesz w sekcji Office.

Atrybuty

Poniższa tabela zawiera opis atrybutów ExternalIdentifier:

Atrybut Wymagana? Typ Opis
label Opcjonalnie string Etykieta informacyjna. Do użytku w razie potrzeby.

Elementy

Poniższa tabela przedstawia elementy ExternalIdentifier:

Element Mnogość Typ Opis
Type 1 IdentifierType Podaje typ identyfikatora.
OtherType 0 lub 1 string Używana, gdy wartość IdentifierType wynosi other.
Value 1 string Identyfikator używany przez jurysdykcję.

Przykłady

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