Identyfikator zewnętrzny

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

Pole Type elementu ExternalIdentifier służy do opisywania źródła identyfikatora, a nie identyfikowanego obiektu. Na przykład 2 wbudowane typy to fips, skrót od „Federal Information Processing Standard” (federalny standard przetwarzania informacji), oraz state. Chociaż do opisywania stanów można używać dwucyfrowych kodów FIPS, w tym przypadku oczekiwana wartość to Type, a nie fips.state Dzieje się tak, ponieważ fips opisuje źródło identyfikatora.

Identyfikatory zewnętrzne są używane w pliku danych w tych celach:

  • Podaj stały identyfikator.
  • Podaj kanoniczny identyfikator z zewnętrznego zasobu, np. identyfikatory Open Civic Data lub kod FIPS.
  • Podaj dodatkowe atrybuty, które nie są natywne dla schematu NIST CDF.

Jeśli identyfikatory zewnętrzne są używane do podawania dodatkowych danych lub kontekstu dla obiektu, muszą mieć wartość Type równą other. Zawierają one też OtherTypeValue, które zależą od typu dostarczonych danych. Przykład tego, jak można przekazywać dane, znajdziesz w sekcji Office.

Atrybuty

W tabeli poniżej opisano atrybuty ExternalIdentifier:

Atrybut Wymagany? Typ Opis
label Opcjonalny string etykietę informacyjną, Do wykorzystania w razie potrzeby.

Elementy

W tabeli poniżej znajdziesz elementy ExternalIdentifier:

Element Mnogość Typ Opis
Type 1 IdentifierType Określa typ identyfikatora.
OtherType 0 lub 1 string Używany, gdy wartość IdentifierType jest 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"
        }
      ]
    }