ID Eksternal

Entitas ExternalIdentifier memungkinkan pembuat feed mengaitkan set pasangan nilai sumber arbitrer dengan objek tertentu. ExternalIdentifier sering kali merupakan kode yurisdiksi dalam sistem eksternal yang digunakan untuk mengaitkan yurisdiksi dengan objek seperti kandidat, kantor, atau unit geopolitik.

Kolom Type dari entitas ExternalIdentifier digunakan untuk mendeskripsikan sumber ID, bukan objek yang diidentifikasi. Misalnya, dua jenis bawaan adalah fips, singkatan dari kode "Federal Information Processing Standard", dan state. Meskipun kode dua digit FIPS dapat digunakan untuk mendeskripsikan negara bagian, nilai Type yang dimaksudkan untuk situasi ini adalah fips dan bukan state. Hal ini karena fips menjelaskan sumber ID.

ID eksternal digunakan di seluruh feed untuk tujuan berikut:

  • Berikan ID yang stabil.
  • Berikan ID kanonis dari resource eksternal, seperti ID Data Open Civic atau kode FIPS.
  • Menyediakan atribut tambahan yang bukan merupakan atribut asli skema NIST CDF.

Jika digunakan untuk memberikan data atau konteks tambahan untuk suatu objek, ID eksternal harus menggunakan Type other. Objek ini juga mencakup OtherType dan Value yang keduanya bergantung pada jenis data yang diberikan. Untuk contoh cara 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 Menyediakan jenis ID.
OtherType 0 atau 1 string Digunakan saat nilai IdentifierType adalah 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"
        }
      ]
    }