Pada halaman ini, akan dijelaskan penggunaaan API untuk menipulasi data user group yang meliputi: Mengambil data user group, menambahkan data baru, mengubah data yang sudah ada, serta menghapus data user group.
API List
Method ini digunakan untuk mendapatkan data user group yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/user/usergroup/list/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
Response
{
"message": "Data retrieved successfully",
"show": "1",
"total": 9,
"data": [
{
"deleted_at": null,
"id": "13f67620-ae09-4186-99e9-479039a6ac37",
"groupName": "Inventory and Transaction Supervisor",
"created": {
"date": "2023-04-18 09:16:38.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": null
}
]
}
API Create
Method ini digunakan untuk memasukan data user group baru.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/user/usergroup/create/{id_user} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 charakter id user |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | groupName | YA | STRING | Nama untuk user group baru |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "848e5045-3e2f-4720-890c-577a7127b40c",
"groupName": "Group Test 2",
"created": {
"date": "2023-05-29 13:47:58.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2023-05-29 13:47:58.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
}
}
}
API Update
Method ini digunakan untuk mengubah data user group.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/user/usergroup/update/{id_user}/{id_usergroup} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_usergroup | YA | STRING | 36 character id user group |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | groupName | TIDAK | STRING | Nama untuk user group |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "848e5045-3e2f-4720-890c-577a7127b40c",
"groupName": "Test Group 2 edited",
"created": {
"date": "2023-05-29 13:47:58.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2023-05-29 13:48:25.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
}
}
}
API Details
Method ini digunakan untuk mendapatkan data details user group.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/user/usergroup/details/{id_user}/{id_usergroup} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_usergroup | YA | STRING | 36 character id user group |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data retrieved successfully",
"data": {
"deleted_at": null,
"id": "848e5045-3e2f-4720-890c-577a7127b40c",
"groupName": "Test Group 2 edited",
"created": {
"date": "2023-05-29 13:47:58.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2023-05-29 13:48:25.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
}
}
}
API Delete
Method ini digunakan untuk menghapus data user group.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/user/usergroup/delete/{id_user}/{id_usergroup} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_usergroup | YA | STRING | 36 character id user group |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}