外部識別子

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

ExternalIdentifier エンティティの Type フィールドは、識別されるオブジェクトではなく、識別子のソースを記述するために使用されます。たとえば、組み込みのタイプは fips と state です。これは「Federal Information Processing Standard」コードの略です。FIPS の 2 桁のコードを使用して状態を記述できますが、この状況で意図される Type 値は state ではなく fips です。これは、fips が識別子のソースを記述しているためです。

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

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

オブジェクトの追加データやコンテキストを提供するために使用する外部 ID は、other の Type を使用する必要があります。また、提供されるデータのタイプに依存する 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"
        }
      ]
    }