Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel lookup Category.
API List
Method ini digunakan untuk mendapatkan data category yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/product/category/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 digit 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 |
| GET | orderBy | TIDAK | STRING | Parameter untuk pengurutan berdasarkan data |
Response
{
"message": "Data retrieved successfully",
"show": "1",
"total": 3,
"data": [
{
"deleted_at": null,
"id": "4ba8b4c4-dd1d-4b82-b3c6-fc90dc207683",
"code": "CASE",
"name": "Phone Case",
"created": {
"date": "2022-05-01 10:56:50.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-01 10:56:50.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
"updatedBy": "",
"createdByName": "Albert Sebastian",
"updatedByName": null
}
]
}API Create
Method ini digunakan untuk memasukan data category.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/product/category/create/{id_user} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 digit id user |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | name | YA | STRING | Nama untuk category |
| POST | code | YA | STRING | Code untuk category |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "5e7b66ef-3f86-4098-893a-a8b90541bbd0",
"code": "CAT0001",
"name": "Category 0001",
"created": {
"date": "2022-10-08 09:34:28.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-08 09:34:28.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "eb94482d-804e-43e2-a802-b2792ebe74c7",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
}API Update
Method ini digunakan untuk mengubah data category.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/product/category/update/{id_user}/{id_category} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 digit id user |
| GET | id_category | YA | STRING | 36 digit id category |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | name | YA | STRING | Nama untuk category |
| POST | code | YA | STRING | Code untuk category |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "5e7b66ef-3f86-4098-893a-a8b90541bbd0",
"code": "cat0001",
"name": "category 0002edited",
"created": {
"date": "2022-10-08 09:34:28.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-08 09:57:35.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "eb94482d-804e-43e2-a802-b2792ebe74c7",
"updatedBy": "eb94482d-804e-43e2-a802-b2792ebe74c7",
"createdByName": null,
"updatedByName": null
}
}API Details
Method ini digunakan untuk mendapatkan data details category.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/product/category/details/{id_user}/{id_category} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 digit id user |
| GET | id_category | YA | STRING | 36 digit id category |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": {
"deleted_at": null,
"id": "5e7b66ef-3f86-4098-893a-a8b90541bbd0",
"code": "cat0001",
"name": "category 0002edited",
"created": {
"date": "2022-10-08 09:34:28.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-08 09:57:35.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "eb94482d-804e-43e2-a802-b2792ebe74c7",
"updatedBy": "eb94482d-804e-43e2-a802-b2792ebe74c7",
"createdByName": null,
"updatedByName": null
}
}API Delete
Method ini digunakan untuk menghapus data category.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/product/category/delete/{id_user}/{id_category} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 digit id user |
| GET | id_category | YA | STRING | 36 digit id category |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}