PDDIKTI

Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Halaman | i
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Daftar Isi
Daftar Isi ............................................................................................................................... ii
1
Skema Interoperabilitas dengan Web Service ................................................................. 1
2
Daftar Method Web Service ........................................................................................... 2
3
2.1
GetToken ........................................................................................................................... 2
2.2
ListTable ............................................................................................................................ 4
2.3
GetDictionary ..................................................................................................................... 6
2.4
GetRecord .......................................................................................................................... 7
2.5
GetRecordset ..................................................................................................................... 9
2.6
Get Deleted Recordset ..................................................................................................... 12
2.7
GetCountRecordset .......................................................................................................... 13
2.8
Get Count Deleted Recordset............................................................................................ 15
2.9
InsertRecord .................................................................................................................... 16
2.10
InsertRecordset ................................................................................................................ 18
2.11
UpdateRecord .................................................................................................................. 20
2.12
UpdateRecordset ............................................................................................................. 22
2.13
DeleteRecord ................................................................................................................... 24
2.14
DeleteRecordset............................................................................................................... 25
2.15
Restore Record................................................................................................................. 26
2.16
Restore Recordset ............................................................................................................ 28
2.17
CheckDeveloperMode ...................................................................................................... 29
2.18
GetVersion ....................................................................................................................... 30
2.19
Get Expired ...................................................................................................................... 31
2.20
Get Change Log ................................................................................................................ 32
Setting Sandbox pada Aplikasi Feeder .......................................................................... 33
Halaman | ii
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
1 Skema Interoperabilitas dengan Web Service
Pada gambar diatas PDDIKTI Feeder menyediakan service yang dapat dimanfaatkan
oleh Perguruan Tinggi agar dapat melakukan interoperabilitas system informasi
yang sudah berjalan dilingkungan perguruan tinggi masing-masing. Sumber data
yang digunakan untuk memenuhi kebutuhan PDDIKTI bisa berasal dari sebuah
system informasi atau multi-sistem informasi, dimana data yang berasal dari
system-sistem tersebut perlu dilakukan mapping terlebih dahulu untuk disesuaikan
dengan standar yang ditentukan PDDIKTI.
Pada skema alur pemanfaatan data PDDIKTI memungkinkan system inforamasi data
perguruan tinggi menerima update terbaru dari PDDIKTI pusat
Halaman | 1
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2 Daftar Method Web Service
Berikut ini merupakan daftar method-method yang dapat digunakan pada aplikasi
web service PDDIKTI:
2.1 GetToken
Method ini digunakan untuk mendapatkan token.
Halaman | 2
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service GetToken mengirim 2 parameter yaitu: username dan password yang
digunakan juga pada aplikasi feeder dan forlap.
Response akan dikembalikan dalam bentuk array hasil GET.
Contoh syntax dalam PHP
require ‘nusoap/nusoap.php’;
require ‘nusoap/class.wsdlcache.php’;
$wsdl = ‘http://localhost:8082/ws/live.php?wsdl’;
$client = new nusoap_client($wsdl, true);
$proxy = $client->getProxy();
$username = ‘ypur-username’;
$password = ‘your-secret-password’;
$result = $proxy->GetToken($username, $password);
$token = $result[‘result’];
print $token; // token digunakan untuk request berikutnya
Halaman | 3
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Tampilan pada klien:
2.2 ListTable
Method ini digunakan untuk menampilkan daftar table yang digunakan pada
aplikasi web service.
Halaman | 4
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service ListTable mengirim 1 parameter yaitu: token yang telah didapatkan
dari GetToken.
Response akan dikembalikan daftar table dan jenisnya dalam bentuk array.
Contoh syntax dalam PHP
$result = $proxy->ListTable($token);
var_dump($result);
Tampilan pada client:
Halaman | 5
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.3 GetDictionary
Method ini digunakan untuk menampilkan keterangan dari table-table yang
digunakan pada aplikasi web service.
Web Service GetDictionary mengirim 2 parameter yaitu: token yang telah
didapatkan dari GetToken dan table yang akan diquery.
Halaman | 6
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Response akan dikembalikan informasi table dalam bentuk array.
Contoh syntax dalam PHP:
$table = ‘mahasiswa’;
$result = $proxy->GetDictionary($token, $table);
var_dump($result);
Tampilan pada klien:
2.4 GetRecord
Method ini digunakan untuk mendapatkan hasil satu buah record data dari satu
tabel saja.
Halaman | 7
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service GetRecord mengirim 3 parameter yaitu: token yang telah didapatkan
dari GetToken, table yang akan diquery, dan filter untuk memfilter query GET.
Response akan dikembalikan dalam bentuk array hasil GET.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$filter = ‘’;
$result = $proxy->GetRecord($token, $table, $filter);
var_dump($result);
Tampilan pada klien:
Halaman | 8
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.5 GetRecordset
Method ini digunakan untuk mendapatkan hasil lebih dari satu record data.
Halaman | 9
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service GetRecordSet mengirim 6 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan di-query, order untuk menampilkan data
sesuai order by yang dimasukkan, filter untuk memfilter query GET, limit untuk
membatasi jumlah record yang dihasilkan, dan offset bila data yang dikembalikan
melebihi limitnya .
Response akan dikembalikan dalam bentuk array hasil GET.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$filter = ‘’;
$limit = ‘10’;
$order = ‘’;
$offset = ‘’;
$result = $proxy->GetRecordset($token, $table, $filter, $order, $limit, $offset);
var_dump($result);
Halaman | 10
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Tampilan pada klien:
Catatan :
Jika nama field yang difilter tidak berhasil, tambahkan alias tabel p. sebelum nama
field yang difilter.
Tabel mahasiswa terdapat join tabel dengan tabel lain yang dibutuhkan untuk
menampilkan data. Untuk menampilkan record data asli yang ada pada tabel
mahasiswa beri tambahan .raw. Contohnya mahasiswa.raw
Halaman | 11
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.6 Get Deleted Recordset
Method ini digunakan untuk mendapatkan record set yang dihapus dari sebuah
table.
Web Service GetDeletedRecordset mengirim 6 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, order untuk menampilkan data
sesuai order by yang dimasukkan, filter untuk memfilter query GET, limit untuk
membatasi jumlah record yang dihasilkan, dan offset bila data yang dikembalikan
melebihi limitnya.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$filter = ‘’;
$limit = ‘10’;
$order = ‘’;
$offset = ‘’;
$result = $proxy->GetDeletedRecordset($token, $table, $filter, $order, $limit, $offset);
var_dump($result);
Halaman | 12
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Tampilan pada klien:
2.7 GetCountRecordset
Method ini digunakan untuk mendapatkan jumlah recordset dari sebuah table.
Halaman | 13
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service GetCountRecordSet mengirim 2 parameter yaitu: token yang telah
didapatkan dari GetToken, dan table yang akan diquery.
Response akan dikembalikan dalam bentuk array hasil GET.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$result = $proxy->GetCountRecordset ($token, $table);
var_dump($result);
Tampilan pada klien:
Halaman | 14
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.8 Get Count Deleted Recordset
Method ini digunakan untuk mendapatkan jumlah recordset yang dihapus dari
sebuah table.
Web Service GetCountDeletedRecordset mengirim 2 parameter yaitu: token yang
telah didapatkan dari GetToken, dan table yang akan diquery
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$result = $proxy->GetCountDeletedRecordset($token, $table);
var_dump($result);
Tampilan pada klien:
Halaman | 15
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.9 InsertRecord
Method ini digunakan untuk memasukkan satu record data ke dalam table.
Web Service InsertRecord mengirim 3 parameter yaitu: token yang telah didapatkan
dari GetToken, table yang akan diquery, dan data record berbentuk array yang akan
ditambahkan ke dalam table.
Response akan dikembalikan ID dari table yang dituju.
Halaman | 16
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
// data yang akan di insert, lihat dictionary masing-masing table untuk
// mengetahui field apa saja yang diperlukan
$record = array();
$record[‘nm_pd’] = ‘Agus Sucipto’;
$record[‘regpd_nipd’]= ‘12345678’;
$record[‘tgl_lahir’] =‘1990-11-10’;
$record[‘tmp_lahir’]= ‘Surabaya’;
$record[‘jln’]= ‘Jl. Pahlawan’;
$record[‘jk’]= ‘L’;
$record[‘kode_pos’]= ‘10201’;
$record[‘telepon_rumah’]= ‘021798787’;
$record[‘telepon_seluler’]= ‘08561234567’;
$record[‘nm_ibu_kandung’]= ‘Ibu Sucipto’;
$record[‘stat_pd’]= ‘A’;
$record[‘id_kk’]= 0;
$record[‘id_sp’]= ‘6fc36677-3f45-2134-b0d0-a123a2300990’; // GUID
……
// insert data
$result = $proxy->InsertRecord($token, $table, json_encode($record));
Halaman | 17
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.10 InsertRecordset
Method ini digunakan untuk memasukkan lebih dari satu record data ke dalam
table.
Web Service InsertRecord mengirim 3 parameter yaitu: token yang telah didapatkan
dari GetToken, table yang akan diquery, dan data record berbentuk array yang akan
ditambahkan ke dalam table.
Halaman | 18
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Response akan dikembalikan ID d.ari tble yang dituju.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
// data yang akan di insert, lihat dictionary masing-masing table untuk
// mengetahui field apa saja yang diperlukan
$records = array();
$record = array();
$record[‘nm_pd’] = ‘Agus Sucipto’;
$record[‘regpd_nipd’]= ‘12345678’;
$record[‘tgl_lahir’] =‘1990-11-10’;
$record[‘tmp_lahir’]= ‘Surabaya’;
$record[‘jln’]= ‘Jl. Pahlawan’;
$record[‘jk’]= ‘L’;
$record[‘kode_pos’]= ‘10201’;
$record[‘telepon_rumah’]= ‘021798787’;
$record[‘telepon_seluler’]= ‘08561234567’;
$record[‘nm_ibu_kandung’]= ‘Ibu Sucipto’;
$record[‘stat_pd’]= ‘A’;
$record[‘id_kk’]= 0;
$record[‘id_sp’]= ‘6fc36677-3f45-2134-b0d0-a123a2300990’; // GUID
……
// menambahkan record kedalam kumpulan record yang akan di push
$records[] = $record;
// insert data
$result = $proxy->InsertRecordset($token, $table, json_encode($records));
Halaman | 19
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.11 UpdateRecord
Method ini digunakan untuk mengubah satu record data yang ada pada satu table.
Web Service UpdateRecord mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record berbentuk
array yang akan diubah.
Halaman | 20
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Response akan dikembalikan key dari table yang telah diupdate.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
// data yang akan di update, lihat dictionary masing-masing table untuk
// mengetahui field apa saja yang diperlukan
$record = array(
‘key’ => array(
‘nm_pd’ => ‘Agus Sucipto’,
‘tgl_lahir’ => ‘1990-11-10’
),
‘data’ => array(
‘jln’ => ‘Jalan Pahlawan II’,
‘kode_pos’ => ‘10211’
)
);
// update data
$result = $proxy->UpdateRecord($token, $table, json_encode($record));
Halaman | 21
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.12 UpdateRecordset
Method ini digunakan untuk mengubah lebih dari satu record data yang ada pada
suatu table.
Halaman | 22
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service UpdateRecordset mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record berbentuk
array yang akan diubah.
Response akan dikembalikan key dari table yang telah diupdate.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$records = array(
[0] = array(
‘key’ => array(
‘nm_pd’ => ‘Agus Sucipto’,
‘tgl_lahir’ => ‘1990-11-10’
),
‘data’ => array(
‘jln’ => ‘Jalan Pahlawan II’,
‘kode_pos’ => ‘10211’
)
),
[1] = array(
‘key’ => array(
‘nm_pd’ => ‘Agustina Regina’,
‘tgl_lahir’ => ‘1992-11-10’
),
‘data’ => array(
‘jln’ => ‘Jalan Pendidikan Blok M-2’,
)
)
);
// update data
$result = $proxy->UpdateRecordset($token, $table, json_encode($records));
Halaman | 23
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.13 DeleteRecord
Method ini digunakan untuk menghapus satu record data yang ada pada suatu table.
Web Service DeleteRecord mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record berbentuk
array yang akan dihapus dari dalam table.
Response akan dikembalikan key dari table yang dihapus.
Mekanisme penghapusan adalah melakukan update field soft_delete=1.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$record = array();
$record[‘nm_pd’] = ‘Agus Sucipto’;
$record[‘regpd_nipd’]= ‘12345678’;
// delete data
$result = $proxy->DeleteRecord($token, $table, json_encode($record));
Halaman | 24
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.14 DeleteRecordset
Method ini digunakan untuk menghapus lebih dari satu record data yang ada pada
suatu table.
Halaman | 25
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service DeleteRecordset mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record berbentuk
array yang akan dihapus dari table.
Response akan dikembalikan key dari table yang dihapus.
Mekanisme penghapusan adalah melakukan update field soft_delete=1.
Contoh syntax dalam PHP
$table = ‘mahasiswa’;
$records = array();
$record = array();
$record[‘nm_pd’] = ‘Agus Sucipto’;
$record[‘regpd_nipd’]= ‘12345678’;
$records[] = $record;
// delete data
$result = $proxy->DeleteRecordset($token, $table, json_encode($records));
2.15 Restore Record
Method ini digunakan untuk mengembalikan satu record data yang dihapus dari
suatu table dengan syarat belum dilakukan sinkronisasi.
Halaman | 26
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Web Service RestoreRecord mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record yang akan direstore ke table. Dimana mekanisme restore tersebut adalah melakukan update field
soft_delete=0 untuk table yang dipilih.
Tampilan pada klien :
Halaman | 27
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.16 Restore Recordset
Method ini digunakan untuk mengembalikan data yang dihapus dari suatu table
lebih dari 1 record dengan syarat belum dilakukan sinkronisasi.
Web Service RestoreRecordset mengirim 3 parameter yaitu: token yang telah
didapatkan dari GetToken, table yang akan diquery, dan data record yang akan direstore ke table. Dimana mekanisme restore tersebut adalah melakukan update field
soft_delete=0 untuk table yang dipilih.
Tampilan pada klien :
Halaman | 28
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.17 CheckDeveloperMode
Method CheckDeveloperMode ini digunakan untuk menampilkan status developer
mode saat ini, yaitu 0=Live, 1=DeveloperMode.
Web Service CheckDeveloperMode mengirim 1 parameter yaitu: token yang telah
didapatkan dari GetToken.
Response akan dikembalikan berupa integer status 0=Live, 1=Developer Mode.
Halaman | 29
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Tampilan pada klien :
2.18 GetVersion
Method GetVersion ini digunakan untuk menampilkan versi webservice saat ini.
Web Service CheckDeveloperMode mengirim 1 parameter yaitu: token yang telah
didapatkan dari GetToken.
Halaman | 30
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Response akan dikembalikan 0=Live, 1=Developer Mode.
Tampilan pada klien :
2.19 Get Expired
Method ini digunakan untuk mendapatkan tanggal expired dari webservice yang
digunakan.
Web Service GetExpired mengirim 1 parameter yaitu: token yang telah didapatkan
dari GetToken.
Tampilan pada klien :
Halaman | 31
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
2.20 Get Change Log
Method ini digunakan untuk menampilkan log perubahan yang ada pada
webservice.
Web Service GetChangeLog mengirim 1 parameter yaitu: token yang telah
didapatkan dari GetToken.
Tampilan pada klien :
Halaman | 32
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
3 Setting Sandbox pada Aplikasi Feeder
Menu setting sandbox terdapat pada aplikasi feeder. Pada halaman ini memiliki
beberapa fungsi, diantaranya yaitu:
a.
b.
c.
d.
Untuk mengubah koneksi
Clone data dari database live ke sandbox
Clean data dari sandbox
Update aplikasi web service yang terbaru
Halaman | 33
Buku Petunjuk Web Service
Aplikasi Pangkalan Data Pendidikan Tinggi (PDDIKTI)
Direktorat Jenderal Pendidikan Tinggi
Halaman | 34