ID Eksternal

Dengan entitas ExternalIdentifier, pembuat feed dapat mengaitkan kumpulan arbitrer pasangan sumber-nilai dengan objek tertentu. ExternalIdentifier sering digunakan kode yurisdiksi dalam sistem eksternal yang digunakan untuk mengaitkan wilayah hukum dengan objek seperti kandidat, kantor, atau unit geopolitik.

Kolom Type dari entity ExternalIdentifier digunakan untuk mendeskripsikan source ID, bukan objek yang diidentifikasi. Misalnya, dua dari jenis bawaan adalah fips, singkatan dari "Informasi Federal Standar Pemrosesan" kode, dan state. Meskipun kode dua digit FIPS dapat digunakan untuk mendeskripsikan status, nilai Type yang diinginkan untuk situasi ini adalah fips dan bukan state. Hal itu karena fips menjelaskan sumber ID.

ID eksternal digunakan di seluruh feed untuk tujuan berikut:

  • Berikan ID stabil.
  • Memberikan ID kanonis dari resource eksternal, seperti Open Civic Kode FIPS atau ID Data.
  • Berikan atribut tambahan yang bukan native untuk skema NIST CDF.

Saat digunakan untuk menyediakan konteks atau data tambahan untuk suatu objek, ID harus menggunakan Type dari other. Kode ini juga menyertakan OtherType dan Value yang bergantung pada jenis data yang disediakan. Untuk tentang bagaimana data dapat diberikan dengan cara ini, lihat Office

Atribut

Tabel berikut menjelaskan atribut untuk ExternalIdentifier:

Atribut Wajib? Jenis Deskripsi
label Opsional string Label informatif. Untuk digunakan sesuai kebutuhan.

Elemen

Tabel berikut menampilkan elemen untuk ExternalIdentifier:

Elemen Keanekaragaman Jenis Deskripsi
Type 1 IdentifierType Memberikan jenis ID.
OtherType 0 atau 1 string Digunakan saat nilai IdentifierType other.
Value 1 string ID yang digunakan oleh wilayah hukum.

Contoh

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