Standar dan penamaan
Nama kolom, format tanggal, dan kode bahasa di API ini mengikuti standar yang sudah ada, bukan kebiasaan internal. Gunanya satu: aplikasi dapat menebak bentuk sebuah nilai dari nama kolomnya, tanpa lebih dulu membuka tabelnya.
Resource raw di bawah /raw adalah pengecualiannya. Nama kolomnya nama
yang dipakai sistem sumber, persis (id_prodi, tgl_create, nm_bidang_minat),
dan tipenya tipe sumber, sehingga angka dan tanggal sering berupa teks. Aturan
di bawah ini berlaku untuk resource lainnya.
Nama kolom — ISO/IEC 11179
Setiap nama kolom disusun dari tiga bagian, mengikuti ISO/IEC 11179-5 (Naming principles):
<istilah representasi>_<kelas objek>[_<pembeda>]
- Istilah representasi menyatakan jenis nilainya, dan selalu berada di depan.
- Kelas objek adalah entitas yang atribut itu miliki:
program_studi,dosen,fakultas. - Pembeda ditulis hanya bila satu baris memuat dua atribut sejenis —
kode_program_studi_homebaseada karena baris dosen juga memuat program studi lain.
Daftar istilah representasinya tertutup, jadi cukup dihafal sekali:
| Awalan | Jenis nilai |
|---|---|
id_ | identifier |
kode_ | kode bisnis pendek; tetap text meski seluruhnya angka |
nama_ | nama yang dibaca manusia |
jenis_, kategori_, kelompok_, status_ | klasifikasi dari himpunan tertutup |
tanggal_, tmt_ | tanggal; tmt_ adalah tanggal mulai berlaku |
tahun_, jumlah_, urutan_ | tahun, cacah atau jumlah, urutan |
is_ | boolean |
url_ | alamat web |
skor_ | angka pada skala yang ditetapkan model atau rubrik |
nilai_ | besaran terukur; satuannya disebut di tempat lain |
_at | instan waktu |
Nomor identitas adalah istilahnya sendiri dan tidak memakai awalan apa pun:
nip, nidn, nuptk, nim, doi.
id_ hanya pernah berada di depan. Bila _id muncul di akhir nama, itu
bukan identifier melainkan kode bahasa — lihat ISO 639-1 di bawah.
Kunci menyebut sistem asalnya
Sebuah kunci dinamai id_<entitas>_<sistem>: nama entitasnya, lalu nama
sistem asal datanya. id_program_studi_pdunsri adalah UUID program studi yang
dikirim PD Unsri, dan id_registrasi_mahasiswa_pdunsri kunci registrasi
mahasiswa dari sistem yang sama. Dua sistem tidak pernah memakai nama kolom
yang sama untuk kuncinya, juga ketika nilainya berasal dari ruang kunci yang
sama — kecocokan itu dinyatakan dalam deskripsi kolom, bukan lewat nama.
Kode dari daftar resmi yang dipakai bersama tidak menyebut sistem: id_semester
bernilai sama dari sumber mana pun ia datang.
Bahasa
Kosakata bisnisnya Indonesia, karena itulah istilah yang dipakai institusi
dan dilaporkan ke PDDIKTI. Penanda tipe pada nama — id_, is_, url_, _at —
ditulis Inggris, sebagaimana istilah standar internasional dipakai apa adanya
(doi, issn). Satu konsep hanya punya satu ejaan di seluruh API.
Tanggal dan waktu — ISO 8601
- Kolom bertipe
dateberbentukYYYY-MM-DD, dan nilai filter untuk kolom itu harus berbentuk sama. - Kolom bertipe
timestamptzadalah instan waktu, disajikan dalam UTC dengan enam angka pecahan detik dan akhiranZ, misalnya2026-09-17T03:12:45.123456Z. Nilai filternya boleh memakaiZatau offset (2026-09-17T10:12:45+07:00), tetapi offset wajib ada. - Kolom bertipe
timestampadalah waktu menurut jam sumbernya, tanpa zona waktu: disajikan dengan enam angka pecahan detik dan tanpa akhiran, misalnya2019-03-18T23:28:49.000000, dan nilai filternya pun tanpa offset. Hanya resource raw yang memilikinya. meta.as_ofadalah instan UTC berformat ISO 8601 dengan akhiranZ, misalnya2026-09-16T19:03:11.284Z.
Kode bahasa — ISO 639-1
Kolom label yang tersedia dalam lebih dari satu bahasa diakhiri kode dua huruf
ISO 639-1: _id untuk Indonesia, _en untuk Inggris. Itulah sebabnya _id
di akhir nama kolom tidak pernah berarti identifier.