Response Format - Malaysia's Official Open API

Kod Respons

Selepas menghantar permintaan API, anda akan menerima respons dengan kod dan elemen-elemen berikut, yang menunjukkan status permintaan anda:

Kod	Status	Penerangan
200	OK	Permintaan Berjaya.
400	Permintaan Buruk	Permintaan tidak sah. Semak mesej ralat untuk maklumat lanjut.
404	Tidak Ditemui	Sumber yang diminta tidak wujud.
429	Terlalu Banyak Permintaan	Kadar penggunaan anda telah dihadkan. Mohon token API di Pengesahan untuk meningkatkan had penggunaan.
500	Ralat Pelayan	Ada sesuatu yang tidak kena dengan OpenAPI! Sila hantarkan e-mel kepada kami jika anda menghadapi ralat ini.

Respons Sah

Anda akan menerima respons 200 OK jika permintaan anda berjaya. API akan mengembalikan senarai rekod secara lalai. Anda juga boleh menggunakan parameter meta untuk lebih mendapatkan lebih banyak butiran:

?meta=true

Dengan meta=true, respons akan kelihatan seperti ini:

{
    "meta": {...},
    "data": [...]
}

meta: Menyediakan maklumat asas tentang sumber yang diminta, termasuk sebarang penapisan yang dikenakan.
data: Mengandungi koleksi rekod yang diminta.

Respons Ralat

Jika terdapat ralat, API akan mengembalikan respons ralat dalam format JSON. Respons ralat mengandungi elemen-elemen berikut:

{
    status: <int>,
    errors: [...],
}

status: Menunjukkan kod respons yang berkaitan dengan ralat tersebut.
errors: Mengandungi mesej-mesej ralat atau keterangan untuk membantu mengenal pasti masalah dengan permintaan API.

*Sila ambil perhatian bahawa untuk API tertentu pada masa akan datang, mungkin terdapat format yang unik berbeza daripada format umum di atas, yang akan dijelaskan dengan jelas dalam dokumentasi API berkenaan.