Внешний идентификатор

Сущность ExternalIdentifier позволяет создателям каналов связывать произвольные наборы пар «источник-значение» с определенными объектами. ExternalIdentifier — это часто используемый код юрисдикции во внешней системе, который используется для связи юрисдикции с такими объектами, как кандидаты, должности или геополитические единицы.

Поле Type сущности ExternalIdentifier используется для описания источника идентификатора, а не идентифицируемого объекта. Например, два встроенных типа — это fips (сокращение от «Федеральный стандарт обработки информации») и state . Несмотря на то, что для описания состояний можно использовать двухзначные коды FIPS, предполагаемым значением Type для этой ситуации является fips , а не state . Это потому, что fips описывает источник идентификатора.

Внешние идентификаторы используются в фиде для следующих целей:

  • Укажите стабильный идентификатор .
  • Укажите канонический идентификатор из внешнего ресурса, например Open Civic Data Identifiers или кода FIPS.
  • Предоставьте дополнительные атрибуты, которые не являются собственными для схемы NIST CDF.

При использовании для предоставления дополнительных данных или контекста для объекта внешние идентификаторы должны использовать Type other . Они также включают OtherType и Value , оба из которых зависят от типа предоставленных данных. Пример того, как данные могут быть предоставлены таким образом, см. в Office .

Атрибуты

В следующей таблице описаны атрибуты ExternalIdentifier :

Атрибут Необходимый? Тип Описание
label Необязательный string Информационная этикетка. Для использования по мере необходимости.

Элементы

В следующей таблице показаны элементы ExternalIdentifier :

Элемент Множественность Тип Описание
Type 1 IdentifierType Предоставляет тип идентификатора.
OtherType 0 или 1 string Используется, когда значение IdentifierType — other .
Value 1 string Идентификатор, используемый юрисдикцией.

Примеры

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