Skip to content

Malls API

atsanan edited this page Feb 6, 2020 · 11 revisions

1. Mall

[x] 1.1 Get malls list

GET /api/v2/mall/list

Description:

ดึงข้อมูลรายการห้างแบบเป็นกลุ่มที่มีสถานะ Active

Query parameters:

Field Description Optional Default Auth
page หน้าปัจจุบัน Yes 0 Yes
limit จำกัดจำนวนต่อหน้า Yes 10 Yes

Returns:

{
    "data": {
        "malls": [
          {
                "_id": "5bcfe5c5f9cec52a70002e32",
                "created_at": "2018-10-23T17:51:51Z",
                "filenameLogo1": "5c25dab007cad.png",
                "filenameLogo2": "5c25dab0080a1.png",
                "indoorDistanceFromInterest": 200,
                "indoorStartFloor": 0,
                "isActive": true,
                "isFixedBugFloor": false,
                "isSponser": true,
                "location": {
                    "coordinates": [
                        100.54096072912,
                        13.74595205755
                    ],
                    "type": "Point"
                },
                "mallAddress": {
                    "chi1": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
                    "chi2": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
                    "eng": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
                    "thai": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331"
                },
                "mallDetail": {
                    "chi1": "Gaysorn Village",
                    "chi2": "Gaysorn Village",
                    "eng": "",
                    "thai": "เกษรทาวเวอร์"
                },
                "mallFloors": [
                    {
                        "_id": "5bc06ba5794a206482e349a7",
                        "created_at": "2018-10-08T11:01:46Z",
                        "mallFloorDetail": {
                            "chi1": "Gaysorn tower, Floor LB",
                            "chi2": "Gaysorn tower, Floor LB",
                            "eng": "Gaysorn tower, Floor LB",
                            "thai": "Gaysorn tower, Floor LB"
                        },
                        "mallFloorName": {
                            "chi1": "Gaysorn tower, Floor LB",
                            "chi2": "Gaysorn tower, Floor LB",
                            "eng": "Gaysorn tower, Floor LB",
                            "thai": "Gaysorn tower, Floor LB"
                        },
                        "mallId": "5bcfe5c5f9cec52a70002e32",
                        "mapIndoorFloorData": "1",
                        "mapIndoorFloorKey": "Gaysorn tower, Floor LB",
                        "updated_at": "2019-08-07T06:13:04Z"
                    },
                    {
                        "_id": "5bc06ba2794a206482e349a6",
                        "created_at": "2018-10-08T11:01:46Z",
                        "mallFloorDetail": {
                            "chi1": "Gaysorn tower, Floor B",
                            "chi2": "Gaysorn tower, Floor B",
                            "eng": "Gaysorn tower, Floor G",
                            "thai": "Gaysorn tower, Floor G"
                        },
                        "mallFloorName": {
                            "chi1": "Gaysorn tower, Floor B",
                            "chi2": "Gaysorn tower, Floor B",
                            "eng": "Gaysorn tower, Floor G",
                            "thai": "Gaysorn tower, Floor B"
                        },
                        "mallId": "5bcfe5c5f9cec52a70002e32",
                        "mapIndoorFloorData": "2",
                        "mapIndoorFloorKey": "Gaysorn tower, Floor G",
                        "updated_at": "2019-02-11T08:00:12Z"
                    },
                    {
                        "_id": "5bc06ba6794a206482e349a8",
                        "created_at": "2018-10-08T11:01:46Z",
                        "mallFloorDetail": {
                            "chi1": "Gaysorn tower, Floor 1",
                            "chi2": "Gaysorn tower, Floor 1",
                            "eng": "Gaysorn tower, Floor 1",
                            "thai": "Gaysorn tower, Floor 1"
                        },
                        "mallFloorName": {
                            "chi1": "Gaysorn tower, Floor 1",
                            "chi2": "Gaysorn tower, Floor 1",
                            "eng": "Gaysorn tower, Floor 1",
                            "thai": "Gaysorn tower, Floor 1"
                        },
                        "mallId": "5bcfe5c5f9cec52a70002e32",
                        "mapIndoorFloorData": "3",
                        "mapIndoorFloorKey": "Gaysorn tower, Floor 1",
                        "updated_at": "2018-11-02T06:14:02Z"
                    },
                    {
                        "_id": "5bc06ba6794a206482e349a9",
                        "created_at": "2018-10-08T11:01:46Z",
                        "mallFloorDetail": {
                            "chi1": "Gaysorn tower, Floor 2",
                            "chi2": "Gaysorn tower, Floor 2",
                            "eng": "Gaysorn tower, Floor 2",
                            "thai": "Gaysorn tower, Floor 2"
                        },
                        "mallFloorName": {
                            "chi1": "Gaysorn tower, Floor 2",
                            "chi2": "Gaysorn tower, Floor 2",
                            "eng": "Gaysorn tower, Floor 2",
                            "thai": "Gaysorn tower, Floor 2"
                        },
                        "mallId": "5bcfe5c5f9cec52a70002e32",
                        "mapIndoorFloorData": "4",
                        "mapIndoorFloorKey": "Gaysorn tower, Floor 2",
                        "updated_at": "2018-10-08T11:03:12Z"
                    },
                    {
                        "_id": "5bc06bb0794a206482e349aa",
                        "created_at": "2018-10-08T11:01:46Z",
                        "mallFloorDetail": {
                            "chi1": "Gaysorn tower, Floor 3",
                            "chi2": "Gaysorn tower, Floor 3",
                            "eng": "Gaysorn tower, Floor 3",
                            "thai": "Gaysorn tower, Floor 3"
                        },
                        "mallFloorName": {
                            "chi1": "Gaysorn tower, Floor 3",
                            "chi2": "Gaysorn tower, Floor 3",
                            "eng": "Gaysorn tower, Floor 3",
                            "thai": "Gaysorn tower, Floor 3"
                        },
                        "mallId": "5bcfe5c5f9cec52a70002e32",
                        "mapIndoorFloorData": "5",
                        "mapIndoorFloorKey": "Gaysorn tower, Floor 3",
                        "updated_at": "2019-10-08T04:29:07Z"
                    }
                ],
                "mallName": {
                    "chi1": "Gaysorn Tower",
                    "chi2": "Gaysorn Tower",
                    "eng": "Gaysorn Tower",
                    "thai": "เกษรทาวเวอร์"
                },
                "mapIndoorId": "EIM-5d42586c-fa4a-41f2-9fee-5b8964a75462",
                "mapOutdoorId": "GaysornTower",
                "order": 0,
                "updated_at": "2019-05-29T05:15:26Z"
            },
        ],
        "pageIndex": -1,
        "pageLimit": -1,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

Data Dictionary Malls:

Field Type Description Default
_id ObjectId id ของรายการห้างนั้น Auto Create
created_at Datetime วันที่บันทึกข้อมูล Auto Create
filenameLogo1 String รูปภาพของห้างรูปที่ 1 จากการอัพโหลด path https://{domain}/media/images/{filenameLogo1} และ https://{domain}/media/thumbnail/{filenameLogo1}
indoorDistanceFromInterest Int ระยะภายในใกล้ที่สุดจากความสนใจ
indoorStartFloor Int ชั้นเริ่มต้นของห้าง 0
isActive Boolean สถานะการแสดงข้อมูล false
isFixedBugFloor Boolean สถานะการฟิกซ์บักชั้น false
isSponser Boolean สถานะการมีสปอนเซอร์ false
location Location ข้อมูลพิกัดที่ตั้งของห้าง false
mallAddress Object ที่อยู่ของห้าง แบ่งเป็น 4 ภาษา "mallAddress": {"eng":"","thai":"","chi1":"","chi2":""}
mallDetail Object รายละเอียดของห้าง แบ่งเป็น 4 ภาษา "mallDetail": {"eng":"","thai":"","chi1":"","chi2":""}
mallFloors Array Object ชั้นของห้างนั้น เรียงลำดับตาม mallFloors mapIndoorFloorData "mallFloors":[]
mallName Object ชื่อของห้าง แบ่งเป็น 4 ภาษา "mallName": {"eng":"","thai":"","chi1":"","chi2":""}
mapIndoorId String ค่า mapIndoorId
order String ลำดับการแสดงข้อมูล
updated_at Datetime วันที่แก้ไขข้อมูล Auto Update

Data Dictionary Mall Floor:

Field Type Description Default
_id ObjectId id ของรายการชั้นในห้างนั้น Auto
created_at Datetime วันที่บันทึกข้อมูล Auto
mallFloorDetail รายละเอียด แบ่งเป็น 4 ภาษา "mallFloorDetail": {"eng":"","thai":"","chi1":"","chi2":""}
mallFloorName ชื่อชั้นของห้าง แบ่งเป็น 4 ภาษา "mallFloorName": {"eng":"","thai":"","chi1":"","chi2":""}
mallId ไอดีของห้างที่ชั้นนั้นอยู่
mapIndoorFloorData ค่า mapIndoorFloorData
mapIndoorFloorKey ค่า mapIndoorFloorKey
updated_at Datetime วันที่แก้ไขข้อมูล Auto Update

Data Dictionary Location:

Field Type Description Default
coordinates ค่า coordinates ค่าแรกเป็น Longitude และค่าสุดท้ายเป็น Lattitude มี Type เป็น Point เสมอ

[x] 1.2 Get mall Detail

GET /api/v2/mall/{mallId : string}

Description:

ดึงรายละเอียดของห้างนั้นโดยใช้ malld

Url parameters:

Field Description Optional Default Auth
mallId ID of this mall No 0 Yes

Returns:

{
    "data": {
        "_id": "5bcfe5c5f9cec52a70002e32",
        "created_at": "2018-10-23T17:51:51Z",
        "filenameLogo1": "5c25dab007cad.png",
        "filenameLogo2": "5c25dab0080a1.png",
        "indoorDistanceFromInterest": 200,
        "indoorStartFloor": 0,
        "isActive": true,
        "isFixedBugFloor": false,
        "isSponser": true,
        "location": {
            "coordinates": [
                100.54096072912,
                13.74595205755
            ],
            "type": "Point"
        },
        "mallAddress": {
            "chi1": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
            "chi2": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
            "eng": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331",
            "thai": "เกษรทาวเวอร์ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10331"
        },
        "mallDetail": {
            "chi1": "Gaysorn Village",
            "chi2": "Gaysorn Village",
            "eng": "",
            "thai": "เกษรทาวเวอร์"
        },
        "mallFloors": [
            {
                "_id": "5bc06ba5794a206482e349a7",
                "created_at": "2018-10-08T11:01:46Z",
                "mallFloorDetail": {
                    "chi1": "Gaysorn tower, Floor LB",
                    "chi2": "Gaysorn tower, Floor LB",
                    "eng": "Gaysorn tower, Floor LB",
                    "thai": "Gaysorn tower, Floor LB"
                },
                "mallFloorName": {
                    "chi1": "Gaysorn tower, Floor LB",
                    "chi2": "Gaysorn tower, Floor LB",
                    "eng": "Gaysorn tower, Floor LB",
                    "thai": "Gaysorn tower, Floor LB"
                },
                "mallId": "5bcfe5c5f9cec52a70002e32",
                "mapIndoorFloorData": "1",
                "mapIndoorFloorKey": "Gaysorn tower, Floor LB",
                "updated_at": "2019-08-07T06:13:04Z"
            },
            {
                "_id": "5bc06ba2794a206482e349a6",
                "created_at": "2018-10-08T11:01:46Z",
                "mallFloorDetail": {
                    "chi1": "Gaysorn tower, Floor B",
                    "chi2": "Gaysorn tower, Floor B",
                    "eng": "Gaysorn tower, Floor G",
                    "thai": "Gaysorn tower, Floor G"
                },
                "mallFloorName": {
                    "chi1": "Gaysorn tower, Floor B",
                    "chi2": "Gaysorn tower, Floor B",
                    "eng": "Gaysorn tower, Floor G",
                    "thai": "Gaysorn tower, Floor B"
                },
                "mallId": "5bcfe5c5f9cec52a70002e32",
                "mapIndoorFloorData": "2",
                "mapIndoorFloorKey": "Gaysorn tower, Floor G",
                "updated_at": "2019-02-11T08:00:12Z"
            },
            {
                "_id": "5bc06ba6794a206482e349a8",
                "created_at": "2018-10-08T11:01:46Z",
                "mallFloorDetail": {
                    "chi1": "Gaysorn tower, Floor 1",
                    "chi2": "Gaysorn tower, Floor 1",
                    "eng": "Gaysorn tower, Floor 1",
                    "thai": "Gaysorn tower, Floor 1"
                },
                "mallFloorName": {
                    "chi1": "Gaysorn tower, Floor 1",
                    "chi2": "Gaysorn tower, Floor 1",
                    "eng": "Gaysorn tower, Floor 1",
                    "thai": "Gaysorn tower, Floor 1"
                },
                "mallId": "5bcfe5c5f9cec52a70002e32",
                "mapIndoorFloorData": "3",
                "mapIndoorFloorKey": "Gaysorn tower, Floor 1",
                "updated_at": "2018-11-02T06:14:02Z"
            },
            {
                "_id": "5bc06ba6794a206482e349a9",
                "created_at": "2018-10-08T11:01:46Z",
                "mallFloorDetail": {
                    "chi1": "Gaysorn tower, Floor 2",
                    "chi2": "Gaysorn tower, Floor 2",
                    "eng": "Gaysorn tower, Floor 2",
                    "thai": "Gaysorn tower, Floor 2"
                },
                "mallFloorName": {
                    "chi1": "Gaysorn tower, Floor 2",
                    "chi2": "Gaysorn tower, Floor 2",
                    "eng": "Gaysorn tower, Floor 2",
                    "thai": "Gaysorn tower, Floor 2"
                },
                "mallId": "5bcfe5c5f9cec52a70002e32",
                "mapIndoorFloorData": "4",
                "mapIndoorFloorKey": "Gaysorn tower, Floor 2",
                "updated_at": "2018-10-08T11:03:12Z"
            },
            {
                "_id": "5bc06bb0794a206482e349aa",
                "created_at": "2018-10-08T11:01:46Z",
                "mallFloorDetail": {
                    "chi1": "Gaysorn tower, Floor 3",
                    "chi2": "Gaysorn tower, Floor 3",
                    "eng": "Gaysorn tower, Floor 3",
                    "thai": "Gaysorn tower, Floor 3"
                },
                "mallFloorName": {
                    "chi1": "Gaysorn tower, Floor 3",
                    "chi2": "Gaysorn tower, Floor 3",
                    "eng": "Gaysorn tower, Floor 3",
                    "thai": "Gaysorn tower, Floor 3"
                },
                "mallId": "5bcfe5c5f9cec52a70002e32",
                "mapIndoorFloorData": "5",
                "mapIndoorFloorKey": "Gaysorn tower, Floor 3",
                "updated_at": "2019-10-08T04:29:07Z"
            }
        ],
        "mallName": {
            "chi1": "Gaysorn Tower",
            "chi2": "Gaysorn Tower",
            "eng": "Gaysorn Tower",
            "thai": "เกษรทาวเวอร์"
        },
        "mapIndoorId": "EIM-5d42586c-fa4a-41f2-9fee-5b8964a75462",
        "mapOutdoorId": "GaysornTower",
        "order": 0,
        "updated_at": "2019-05-29T05:15:26Z"
    },
    "isSuccess": true
}

Data Dictionary Mallsa and Mall Floor:

ข้อมูลแบบเดียวกับข้อ 1.1

[x] 1.3 Get malls floor list

 GET /api/v2/mall/floor/list/{mallId : string}

Description:

ดึงข้อมูลห้างนั้นโดยใช้ id ห้างนั้น

Query parameters:

Field Description Optional Default Auth
page หน้าปัจจุบัน Yes 0 Yes
limit จำนวนจำกัดต่อหน้า Yes 10 Yes

Returns:

{
"data": [
        {
            "_id": "5bc06b96794a206482e349a5",
            "created_at": "2018-10-08T11:01:46Z",
            "mall": {
                "_id": "5bcf5fb7fe135920500046f2",
                "created_at": "2018-10-23T17:51:51Z",
                "filenameLogo1": "5c25dad371f53.png",
                "filenameLogo2": "5c25dad37236a.png",
                "indoorDistanceFromInterest": 200,
                "indoorStartFloor": 0,
                "isActive": true,
                "isFixedBugFloor": false,
                "isSponser": true,
                "location": {
                    "coordinates": [
                        100.54075285792,
                        13.745195191261
                    ],
                    "type": "Point"
                },
                "mallAddress": {
                    "chi1": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "chi2": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "eng": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "thai": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330"
                },
                "mallDetail": {
                    "chi1": "Gaysorn Village",
                    "chi2": "Gaysorn Village",
                    "eng": "",
                    "thai": "เกษรวิลเลจ"
                },
                "mallName": {
                    "chi1": "Gaysorn Village",
                    "chi2": "Gaysorn Village",
                    "eng": "Gaysorn Village",
                    "thai": "เกษรวิลเลจ"
                },
                "mapIndoorId": "EIM-0a656478-3d18-40a3-bfda-8eaacc0d9e55",
                "mapOutdoorId": "GaysornVillage",
                "order": 9,
                "updated_at": "2019-05-29T05:15:35Z"
            },
            "mallFloorDetail": {
                "chi1": "Gaysorn Village, Floor 3",
                "chi2": "Gaysorn Village, Floor 3",
                "eng": "Gaysorn Village, Floor 3",
                "thai": "ศูนย์การค้าเกษร ชั้น 3"
            },
            "mallFloorName": {
                "chi1": "Gaysorn Village, Floor 3",
                "chi2": "Gaysorn Village, Floor 3",
                "eng": "Gaysorn Village, Floor 3",
                "thai": "ศูนย์การค้าเกษร ชั้น 3"
            },
            "mallId": "5bcf5fb7fe135920500046f2",
            "mapIndoorFloorData": "5",
            "mapIndoorFloorKey": "Gaysorn Village, Floor 3",
            "updated_at": "2018-11-15T09:32:10Z"
        }
      ], 
      "pageIndex": -1,
      "pageLimit": -1,
      "pages": 1,
      "paging": {
           "next": "",
           "previous": ""
        }
    },
    "isSuccess": true
}

Data Dictionary Mall Floor:

ข้อมูลแบบเดียวกับข้อ 1.1

1.4 Mall Floor list by location

GET /api/v2/mall/floor/byLocation?lat={lat}&long={long}

Description:

ดึงข้อมูลห้างนั้นโดยใช้พิกัดละติจูดลองจิจูด

Url parameters:

Field Description Optional Default Auth
page Current page of Malls list Yes 0 Yes
limit Maximum page of Malls list Yes 10 Yes
lat lattiude No No
long longitude No No
min minDistance yes No
max maxDistance yes No

Returns:

{
    "data": {
        "mallFloors": [
           {
            "_id": "5bc06b96794a206482e349a5",
            "created_at": "2018-10-08T11:01:46Z",
            "mall": {
                "_id": "5bcf5fb7fe135920500046f2",
                "created_at": "2018-10-23T17:51:51Z",
                "filenameLogo1": "5c25dad371f53.png",
                "filenameLogo2": "5c25dad37236a.png",
                "indoorDistanceFromInterest": 200,
                "indoorStartFloor": 0,
                "isActive": true,
                "isFixedBugFloor": false,
                "isSponser": true,
                "location": {
                    "coordinates": [
                        100.54075285792,
                        13.745195191261
                    ],
                    "type": "Point"
                },
                "mallAddress": {
                    "chi1": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "chi2": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "eng": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330",
                    "thai": "เกษรวิลเลจ แขวงลุมพินี เขตปทุมวัน กรุงเทพมหานคร 10330"
                },
                "mallDetail": {
                    "chi1": "Gaysorn Village",
                    "chi2": "Gaysorn Village",
                    "eng": "",
                    "thai": "เกษรวิลเลจ"
                },
                "mallName": {
                    "chi1": "Gaysorn Village",
                    "chi2": "Gaysorn Village",
                    "eng": "Gaysorn Village",
                    "thai": "เกษรวิลเลจ"
                },
                "mapIndoorId": "EIM-0a656478-3d18-40a3-bfda-8eaacc0d9e55",
                "mapOutdoorId": "GaysornVillage",
                "order": 9,
                "updated_at": "2019-05-29T05:15:35Z"
            },
            "mallFloorDetail": {
                "chi1": "Gaysorn Village, Floor 3",
                "chi2": "Gaysorn Village, Floor 3",
                "eng": "Gaysorn Village, Floor 3",
                "thai": "ศูนย์การค้าเกษร ชั้น 3"
            },
            "mallFloorName": {
                "chi1": "Gaysorn Village, Floor 3",
                "chi2": "Gaysorn Village, Floor 3",
                "eng": "Gaysorn Village, Floor 3",
                "thai": "ศูนย์การค้าเกษร ชั้น 3"
            },
            "mallId": "5bcf5fb7fe135920500046f2",
            "mapIndoorFloorData": "5",
            "mapIndoorFloorKey": "Gaysorn Village, Floor 3",
            "updated_at": "2018-11-15T09:32:10Z"
        }
        ],
        "pageIndex": -1,
        "pageLimit": -1,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

Data Dictionary Mall Floor:

ข้อมูลแบบเดียวกับข้อ 1.1