Identificador externo

A entidade ExternalIdentifier permite que os criadores de feeds associem conjuntos arbitrários de pares origem-valor a determinados objetos. ExternalIdentifier é um código de jurisdição em um sistema externo usado para associar uma jurisdição a objetos como candidatos, escritórios ou unidades geopolíticas.

O campo Type de uma entidade ExternalIdentifier é usado para descrever a origem do identificador, não o objeto que está sendo identificado. Por exemplo, dois dos tipos integrados são fips, uma abreviação de "Federal Information Processing Standard" (Padrão Federal de Processamento de Informações), e state. Embora os códigos de dois dígitos do FIPS possam ser usados para descrever estados, o valor Type pretendido para essa situação é fips e não state. Isso acontece porque fips descreve a origem do identificador.

Os identificadores externos são usados em todo o feed para os seguintes fins:

  • Forneça um identificador estável.
  • Forneça um identificador canônico de um recurso externo, como identificadores de dados cívicos abertos ou código FIPS.
  • Forneça outros atributos que não são nativos do esquema CDF do NIST.

Quando usados para fornecer dados ou contexto adicionais para um objeto, os identificadores externos precisam usar um Type de other. Elas também incluem um OtherType e um Value que dependem do tipo de dados fornecidos. Para um exemplo de como os dados podem ser fornecidos dessa maneira, consulte Office.

Atributos

A tabela a seguir descreve os atributos de ExternalIdentifier:

Atributo Obrigatório? Tipo Descrição
label Opcional string Um rótulo informativo. Para uso conforme necessário.

Elementos

A tabela a seguir mostra os elementos de ExternalIdentifier:

Elemento Multiplicidade Tipo Descrição
Type 1 IdentifierType Fornece um tipo de identificador.
OtherType 0 ou 1 string Usado quando o valor de IdentifierType é other.
Value 1 string O identificador usado pela jurisdição.

Exemplos

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