Dokumentasi API : User – Group

Pada halaman ini, akan dijelaskan penggunaaan API untuk menipulasi data relasi antara user dengan user group yang meliputi: Mengambil data, menambahkan data relasi baru, serta menghapus data relasi.


API List

Method ini digunakan untuk mendapatkan data relasi user dengan user group.

Request

METHODURL
GEThttp://apiv2.mitrabunso.com/public/user/group/list/{id_user}/{offsite}/{limit}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GEToffsiteYAintoffsite data
GETlimitYAintlimit data
HEADAuthorizationYABearer TokenBearer Token Login
GETqTIDAKSTRINGParameter untuk pencarian
GETorderByTIDAKSTRINGParameter untuk pengurutan berdasarkan data

Response

{
                "message": "Data retrieved successfully",
                "show": "1",
                "total": 2,
                "data": [
                    {
                        "deleted_at": null,
                        "id": "c32a6c58-8167-4b13-96e8-2c2688d07112",
                        "group": "e4d6e1a4-1d9e-4ae5-a21a-5ad42131b67c",
                        "user": "dc7f9c3b-7e46-4b9a-9a39-f9854867d2ff",
                        "groupName": "Testing Group",
                        "email": "andikatama19982@gmail.com",
                        "firstName": "Andika",
                        "lastName": "Pratama Test Nama Panjang 2",
                        "created": {
                            "date": "2023-05-02 05:20:16.000000",
                            "timezone_type": 3,
                            "timezone": "Asia/Bangkok"
                        },
                        "updated": {
                            "date": "2023-05-02 05:20:16.000000",
                            "timezone_type": 3,
                            "timezone": "Asia/Bangkok"
                        }
                    }
                ]
            }

API Create

Method ini digunakan untuk memasukan data relasi baru antara user dengan user group.

Request

METHODURL
POSThttp://apiv2.mitrabunso.com/public/user/group/create/{id_user}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
HEADAuthorizationYABearer TokenBearer Token Login
POSTgroup YASTRING36 character id user group
POSTuserYASTRING36 character id user

Response

{
                "message": "Data added successfully",
                "data": {
                    "deleted_at": null,
                    "id": "f5a376d8-e878-46d7-9ce3-761b822d8131",
                    "group": "e4d6e1a4-1d9e-4ae5-a21a-5ad42131b67c",
                    "user": "dc7f9c3b-7e46-4b9a-9a39-f9854867d2ff",
                    "groupName": null,
                    "email": null,
                    "firstName": null,
                    "lastName": null,
                    "created": {
                        "date": "2023-05-29 14:22:56.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    },
                    "updated": {
                        "date": "2023-05-29 14:22:56.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    }
                }
            }

API Delete

Method ini digunakan untuk menghapus data relasi user dengan user group.

Request

METHODURL
DELETEhttp://apiv2.mitrabunso.com/public/user/group/delete/{id_user}/{id_group}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHODParameterWajibTipeKeterangan
GETid_userYASTRING36 character id user
GETid_groupYASTRING36 character id group
HEADAuthorizationYABearer TokenBearer Token Login

Response

{
    "message": "data deleted successfully"
}

Leave a Reply