La entidad ExternalIdentifier permite que los creadores de feeds asocien conjuntos arbitrarios de pares fuente-valor con ciertos objetos. ExternalIdentifier es el código de una jurisdicción en un sistema externo que se usa para asociar una jurisdicción con objetos como candidatos, cargos o unidades geopolíticas.
El campo Type de una entidad ExternalIdentifier se usa para describir la fuente del identificador, no el objeto que se identifica. Por ejemplo, dos de los tipos integrados son fips, una abreviatura del código de "Estándar Federal de Procesamiento de Información", y state. Si bien los códigos FIPS de dos dígitos se pueden usar para describir estados, el valor Type previsto para esta situación es fips y no state. Esto se debe a que fips describe la fuente del identificador.
Los identificadores externos se usan en todo el feed para los siguientes fines:
- Proporciona un identificador estable.
- Proporciona un identificador canónico de un recurso externo, como los identificadores de Open Civic Data o el código FIPS.
- Proporciona atributos adicionales que no son nativos del esquema CDF del NIST.
Cuando se usan para proporcionar datos o contexto adicionales para un objeto, los identificadores externos deben usar un Type de other. También incluyen un OtherType y un Value que dependen del tipo de datos que se proporcionan. Para ver un ejemplo de cómo se pueden proporcionar los datos de esta manera, consulta Office.
Atributos
En la siguiente tabla, se describen los atributos de ExternalIdentifier:
| Atributo | ¿Es obligatorio? | Tipo | Descripción |
|---|---|---|---|
label |
Opcional | string |
Es una etiqueta informativa. Para usar según sea necesario. |
Elementos
En la siguiente tabla, se muestran los elementos de ExternalIdentifier:
| Elemento | Multiplicidad | Tipo | Descripción |
|---|---|---|---|
Type |
1 | IdentifierType |
Proporciona un tipo de identificador. |
OtherType |
0 o 1 | string |
Se usa cuando el valor de IdentifierType es other. |
Value |
1 | string |
Es el identificador que usa la jurisdicción. |
Ejemplos
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" } ] }