Documentation || GoTravelly

Friend or Family

Dokumentasi ini menjelaskan cara mengakses layanan API GoTravelly untuk method Friend or Family.

API berfungsi untuk mendapatkan, menambahkan, mengubah, dan menghapus data teman atau keluarga dari pengguna pada akun guide di GoTravelly.

API ini digunakan saat pengguna menambahkan data teman atau keluarga saat memesan (booking) tur paket atau jasa guide di GoTravelly.

Method & URL

Method	URL
GET, POST, PUT, DELETE	https://www.gotravelly.com/api/book_family

Request & Response

GET (Request)

Method	Parameter	Tipe	Wajib	Keterangan
GET/HEADER	key	String	Tidak	Token code / key
GET/PARAM	mode*	String	Tidak	isi dengan `temp` atau kosongkan
GET/PARAM	user_id	Integer	Ya	User ID pada akun pengguna di GoTravelly

*) mode: untuk mode temp artinya dapatkan data teman & keluarga yang bersifat temporary.

Contoh GET (Request):
https://www.gotravelly.com/api/book_family?user_id=999
https://www.gotravelly.com/api/book_family?mode=temp&user_id=999

GET (Response)

    {
        "status": "OK",
        "count": 3,
        "data": [
            {
                "id": "449",
                "title": "Mrs",
                "full_name": "BEBE",
                "user_id": "93"
            },
            {
                "id": "450",
                "title": "Mr",
                "full_name": "LEE MIN HO",
                "user_id": "93"
            },
            {
                "id": "451",
                "title": "Mrs",
                "full_name": "RAISA RAHMAWATI",
                "user_id": "93"
            }
        ]
    }

POST (Request)

Method	Parameter	Tipe	Wajib	Keterangan
POST/HEADER	key	String	Ya	Token code / key
POST/BODY	mode	String	Tidak	Kosongkan / isi dengan `multiple`/`setting`
POST/BODY	title	String	Ya	Kata sapaan misal: Mr, Mrs, Miss
POST/BODY	full_name	String	Ya	Nama lengkap teman atau keluarga
POST/BODY	temp_data*	Array	Ya	Kumpulan data keluarga atau teman yang ada di temporary

*) temp_data: jika mode = multiple maka temp_data wajib diisi data teman / keluarga di temporary yang nantinya akan di simpan ke data master teman / keluarga.

POST (Response)

    {
        "status": "OK",
        "message": "Family data saved successfully",
        "family_id": "8",
    }

PUT (Request)

Method	Parameter	Tipe	Wajib	Keterangan
PUT/HEADER	key	String	Ya	Token code / key
PUT/BODY	user_id	Integer	Ya	User ID pada akun pengguna di GoTravelly
PUT/BODY	full_name	String	Tidak	Nama lengkap keluarga / teman yang akan diubah
PUT/BODY	title	String	Tidak	Kata sapaan keluarga / teman yang akan diubah
PUT/BODY	id	Integer	Ya	ID dari data keluarga / teman yang akan diubah

PUT (Response)

    {
        "status": "OK",
        "message": "Family data updated successfully",
        "family_id": "8",
    }

DELETE (Request)

Method	Parameter	Tipe	Wajib	Keterangan
DELETE/HEADER	key	String	Ya	Token code / key
DELETE/BODY	mode*	String	Tidak	Mode data yang akan dihapus (kosongkan / isi dengan `temp`)
DELETE/BODY	id	Integer	Ya	ID dari data keluarga / teman yang akan dihapus

*) mode: jika memilih temp maka data keluarga / teman yang bersifat temporary langsung otomatis dihapus.

DELETE (Response)

    {
        "status": "OK",
        "message": "Family data deleted successfully",
        "family_id": "8",
    }