外部識別子

ExternalIdentifier エンティティを使用すると、フィード作成者は任意のソース値ペアのセットを特定のオブジェクトに関連付けることができます。ExternalIdentifier は、候補者、オフィス、地政学単位などのオブジェクトと管轄区域を関連付けるために使用される外部システムの管轄区域コードであることがよくあります。

ExternalIdentifier エンティティの Type フィールドは、識別されるオブジェクトではなく、識別子のソースを記述するために使用されます。たとえば、組み込み型には、連邦情報処理規格（Federal Information Processing Standard）コードの略称である fips と state の 2 つがあります。FIPS の 2 桁のコードを使用して州を記述できますが、この状況で想定される Type の値は state ではなく fips です。これは、fips が ID のソースを記述するためです。

外部 ID は、フィード全体で次の目的で使用されます。

  • 安定した識別子を指定します。
  • Open Civic Data Identifiers や FIPS コードなどの外部リソースから正規の識別子を指定します。
  • NIST CDF スキーマにネイティブではない追加の属性を指定します。

オブジェクトの追加データやコンテキストを提供するために使用される場合、外部 ID は 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"
        }
      ]
    }