Slot
Detail Data
Fungsi dari ReST API ini adalah untuk mendapatkan data terkait resource Slot yang tersedia di ekosistem platform. Untuk mendapatkan data yang dimaksud, nilai ID dari resource Slot tersebut PERLU diketahui dan disediakan sebagai parameternya.
Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB, harus ada, atau pasti selalu ada, contoh: *variabel.
Request
URL
example:idHTTP Verb/Method
GETParameter Path URI
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*:id | uuid | ID referensi dari resource Slot yang akan dilihat detailnya. |
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*Authorization | string | Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi. |
*Content-Type | string | Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan application/json. |
Response
Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.
2xx Success
Bila resource Slot dengan ID terkait berhasil ditemukan atau tersedia, maka akan mengembalikan data dari resource Slot yang tersimpan di ekosistem platform.
Contoh Data
{ "resourceType": "Slot", "id": "e2fdfc6f-28ff-46be-b68b-b73d982cdcf8", //resource}4xx Client Error
Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau meminta data dengan format, parameter, atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.
Contoh Data
{ "resourceType": "OperationOutcome", //resourceionOutcome}5xx Server Error (Content-Type: text/plain)
Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.
Contoh Data
Gateway TimeoutContoh Penggunaan/Kode
Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
cURL (Windows)
curl --insecure --location ^ --header "Authorization: Bearer <access-token>" ^ --request GET ^ "example"cURL (Linux)
curl --insecure --location \ --header 'Authorization: Bearer <access-token>' \ --request GET \ 'example'Postman
- Buat request baru menggunakan , atau klik tombol + untuk buat tab request baru.
- Masukkan request URL
example:id - Lalu pilih request method
GET. - Pada tab Auth:
- pada pilihan Type, pilih
Bearer Token, - lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
- pada pilihan Type, pilih
- Pada tab Params, di bagian Path Variables:
- Isi nilai parameter
iddengan ID dari resource Slot yang ingin didapatkan datanya.
- Isi nilai parameter
- Klik tombol Send.
- Hasil response akan ditampilkan di bagian Response.
Penambahan Data
Fungsi dari ReST API ini adalah untuk melakukan penambahan data terkait resource Slot ke dalam ekosistem platform.
Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB, harus ada, atau pasti selalu ada, contoh: *variabel.
Request
URL
exampleHTTP Verb/Method
POST| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*Authorization | string | Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi. |
*Content-Type | string | Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan application/json. |
Body (application/json)
Terkait cara pengisian Body (application/json) dari format FHIR tersebut, silakan lihat contoh di Postman dan dokumentasi Panduan Interoperabilitas sesuai dengan modul pelayanan dan/atau penerapan (use case) masing-masing.
Bentuk umum dari payload untuk penambahan data sebagai berikut:
{ "resourceType": "Slot", //resource}Response
Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.
2xx Success
Dari hasil response ini, PERLU disimpan nilai UUID yang didapat dari properti id, di mana nilai tersebut kemungkinan akan digunakan dalam proses lainnya yang terkait resource Slot ini.
Contoh Data
{ "resourceType": "Slot", "id": "e2fdfc6f-28ff-46be-b68b-b73d982cdcf8", //resource}4xx Client Error
Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.
Contoh Data
{ "resourceType": "OperationOutcome", //resourceionOutcome}5xx Server Error (Content-Type: text/plain)
Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.
Contoh Data
Gateway TimeoutContoh Penggunaan/Kode
Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
cURL (Windows)
curl --insecure --location ^ --header "Authorization: Bearer <access-token>" ^ --header "Content-Type: application/json" ^ --data-raw "{ \"resourceType\": \"Slot\", ... }" ^ --request POST ^ "example"cURL (Linux)
curl --insecure --location \ --header 'Authorization: Bearer <access-token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "resourceType": "Slot", ... }' \ --request POST \ 'example'Postman
- Buat request baru menggunakan , atau klik tombol + untuk buat tab request baru.
- Masukkan request URL
example - Lalu pilih request method
POST. - Pada tab Auth:
- pada pilihan Type, pilih
Bearer Token, - lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
- pada pilihan Type, pilih
- Pada tab Body:
- pilih raw,
- kemudian di samping nilai tadi pilih JSON,
- terakhir masukkan resource JSON dari Slot yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
{ "resourceType": "Slot", //resource}
- Klik tombol Send.
- Hasil response akan ditampilkan di bagian Response.
Pembaruan Data
Fungsi dari ReST API ini adalah untuk melakukan perubahan data terkait resource Slot ke dalam ekosistem platform, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem platform. Untuk melakukan perubahan (update) data, PERLU ID dari resource Slot yang akan diubah.
Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB, harus ada, atau pasti selalu ada, contoh: *variabel.
Request
URL
example:idHTTP Verb/Method
PUTParameter Path URI
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*:id | uuid | ID referensi dari resource Slot yang akan dilakukan proses pembaruan data (update). |
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*Authorization | string | Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi. |
*Content-Type | string | Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan application/json. |
Body (application/json)
Di bagian body ini payload JSON dari resource Slot sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan lihat dokumentasi terkait FHIR atau Panduan Interoperabilitas yang telah disediakan.
Bentuk umum dari payload untuk penambahan data sebagai berikut:
{ "resourceType": "Slot", //resource}Response
Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.
2xx Success
Bila proses pembaruan data berhasil maka akan mengembalikan payload dari resource Slot yang sebelumnya telah dikirim.
Contoh Data
{ "resourceType": "Slot", "id": "e2fdfc6f-28ff-46be-b68b-b73d982cdcf8", //resource}4xx Client Error
Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format, parameter, atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.
Contoh Data
{ "resourceType": "OperationOutcome", //resourceionOutcome}5xx Server Error (Content-Type: text/plain)
Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.
Contoh Data
Gateway TimeoutContoh Penggunaan/Kode
Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
cURL (Windows)
curl --insecure --location ^ --header "Authorization: Bearer <access-token>" ^ --header "Content-Type: application/json" ^ --data-raw "{ \"resourceType\": \"Slot\", ... }" ^ --request PUT ^ "example"cURL (Linux)
curl --insecure --location \ --header 'Authorization: Bearer <access-token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "resourceType": "Slot", ... }' \ --request PUT \ 'example'Postman
- Buat request baru menggunakan , atau klik tombol + untuk buat tab request baru.
- Masukkan request URL
example:id - Lalu pilih request method
PUT. - Pada tab Auth:
- pada pilihan Type, pilih
Bearer Token, - lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
- pada pilihan Type, pilih
- Pada tab Params, di bagian Path Variables:
- Isi nilai parameter
iddengan ID dari resource Slot yang akan diperbarui (update).
- Isi nilai parameter
- Pada tab Body:
- pilih raw,
- kemudian di samping nilai tadi pilih JSON,
- terakhir masukkan resource JSON dari Slot yang akan diproses ke kotak masukkan di bawah pilihan tadi. Contoh:
{ "resourceType": "Slot", //resource}
- Klik tombol Send.
- Hasil response akan ditampilkan di bagian Response.
Pembaruan Sebagian Data
Fungsi dari ReST API ini adalah untuk melakukan perubahan sebagian dari data terkait resource Slot ke dalam ekosistem platform, yang sebelumnya sudah ditambahkan dan tersedia di dalam ekosistem platform. Untuk melakukan perubahan sebagian (patching) data, PERLU ID dari resource Slot yang akan diubah dan juga nama/ID elemen dari Slot yang akan dilakukan perubahan.
Setiap terdapat simbol asterik * sebelum nama variabel atau parameter yang disebutkan, maka variabel atau parameter tersebut bersifat WAJIB, harus ada, atau pasti selalu ada, contoh: *variabel.
Request
URL
example:idHTTP Verb/Method
PATCHParameter Path URI
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*:id | uuid | ID referensi dari resource Slot yang akan dilakukan proses pembaruan data (update). |
| Nama Parameter | Tipe Data | Keterangan |
|---|---|---|
*Authorization | string | Header ini WAJIB diisi dengan nilai sesuai format: Bearer <access_token>. Nilai dari variabel <access_token> didapatkan dari properti access_token pada object dari hasil response JSON setelah proses autentikasi. |
*Content-Type | string | Mime type dari payload data yang akan dikirimkan di dalam body dalam format JSON, WAJIB diisi dengan application/json. |
Body (application/json)
Di bagian body ini payload JSON dari resource Slot sesuai standar FHIR dimasukkan. Terkait cara pengisian dari format FHIR tersebut di luar cakupan dari dokumentasi ini, silakan lihat dokumentasi terkait FHIR atau Panduan Interoperabilitas yang telah disediakan.
Bentuk umum dari payload untuk patching sebagai berikut:
[ { "op": "<operasi>", "path": "<element-path>", "value": "<nilai-baru>" }]Dari bentuk umum tersebut, nilai:
<operasi>, saat ini hanya tersedia operasireplacesaja, yaitu untuk menganti nilai properti/elemen dari resource Slot dengan ID terkait.<element-path>, nama properti/element dari resource Slot dengan ID terkait yang akan diganti nilainya, dengan format/<path>/<to>/<element>. Simbol/sebagai pemisah dari nama properti/element yang dimaksud. Contoh, misalkan pada resource Slot ini ada properti/element dengan namalanguage, yang dalam bentuk path FHIRSlotge, maka penulisan nilai<element-path>ini adalah/language.<nilai-baru>, diisi dengan nilai pengantinya.
Sehingga contoh payload-nya sebagai berikut:
[ { "op": "replace", "path": "/language", "value": "id" }]Response
Hasil response, dengan HTTP Status Code berpola 2xx atau 4xx, yang dikembalikan dari server mempunyai parameter Content-Type dengan nilai application/json di salah satu parameter header-nya.
2xx Success
Bila proses pembaruan data berhasil maka akan mengembalikan payload dari resource Slot yang sebelumnya telah dikirim.
Contoh Data
{ "resourceType": "Slot", "id": "e2fdfc6f-28ff-46be-b68b-b73d982cdcf8", //resource}4xx Client Error
Sistem akan mengembalikan pesan error bila client belum melakukan autentikasi, tidak memiliki akses, menggunakan HTTP method yang tidak tepat, atau mengirimkan data dengan format, parameter, atau ketentuan lainnya yang tidak sesuai atau tidak dimengerti oleh sistem.
Contoh Data
{ "resourceType": "OperationOutcome", //resourceionOutcome}5xx Server Error (Content-Type: text/plain)
Sistem akan mengembalikan pesan error bila terjadi kesalahan pada sisi server saat memproses data yang telah dikirimkan.
Contoh Data
Gateway TimeoutContoh Penggunaan/Kode
Setiap nilai yang dicontohkan atau ditampilkan di dokumentasi ini adalah nilai yang tidak sebenarnya dan tidak dapat dipakai. Nilai-nilai tersebut hanya untuk keperluan contoh saja, tidak untuk dipakai.
cURL (Windows)
curl --insecure --location ^ --header "Authorization: Bearer <access-token>" ^ --header "Content-Type: application/json" ^ --data-raw "[ { \"op\" : \"<operasi>\", \"path\" : \"<element-path>\", \"value\" : \"<nilai-baru>\" } ]" ^ --request PATCH ^ "example"cURL (Linux)
curl --insecure --location \ --header 'Authorization: Bearer <access-token>' \ --header 'Content-Type: application/json' \ --data-raw '[ { "op": "<operasi>", "path": "<element-path>", "value": "<nilai-baru>" } ]' \ --request PATCH \ 'example'Postman
- Buat request baru menggunakan , atau klik tombol + untuk buat tab request baru.
- Masukkan request URL
example:id - Lalu pilih request method
PATCH. - Pada tab Auth:
- pada pilihan Type, pilih
Bearer Token, - lalu masukkan nilai akses token yang sudah didapatkan pada saat autentikasi pada kotak inputan Token.
- pada pilihan Type, pilih
- Pada tab Params, di bagian Path Variables:
- Isi nilai parameter
iddengan ID dari resource Slot yang akan diperbarui (update).
- Isi nilai parameter
- Pada tab Body:
- pilih raw,
- kemudian di samping nilai tadi pilih JSON,
- terakhir masukkan payload JSON untuk melakukan perubahan ke kotak masukkan di bawah pilihan tadi. Contoh:
[ { "op": "replace", "path": "/language", "value": "id" }]
- Klik tombol Send.
- Hasil response akan ditampilkan di bagian Response.