ID Eksternal

Entity ExternalIdentifier memungkinkan pembuat feed mengaitkan sembarang kumpulan pasangan nilai sumber dengan objek tertentu. ExternalIdentifier sering kali merupakan kode wilayah hukum 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 sumber ID, bukan objek yang diidentifikasi. Misalnya, dua jenis bawaan adalah fips, singkatan dari kode "Standar Pemrosesan Informasi Federal", dan state. Meskipun kode dua digit FIPS dapat digunakan untuk mendeskripsikan status, nilai Type yang dimaksudkan untuk situasi ini adalah fips, bukan state. Hal ini dikarenakan fips menjelaskan sumber ID.

ID eksternal digunakan di seluruh feed untuk tujuan berikut:

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

Jika digunakan untuk memberikan konteks atau data tambahan untuk suatu objek, ID eksternal harus menggunakan Type dari other. Parameter ini juga menyertakan OtherType dan Value yang bergantung pada jenis data yang disediakan. Untuk contoh cara data dapat diberikan dengan cara ini, lihat Office.

Atribut

Tabel berikut menjelaskan atribut untuk ExternalIdentifier:

Atribut Wajib diisi? Jenis Deskripsi
label Opsional string Label yang 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 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"
        }
      ]
    }