Skip to content
jocoonopa edited this page May 5, 2018 · 1 revision

會員相關的查詢

Members profile

url

/member/query

input

data = {
    "displayFields": "firstName",
    "keywords": "samuel|kevin",
    "queryFields": "firstName",
    "fieldsRelation": 1,
    "currentPage": 1,
    "pageSize": 10,
    "sortFields": "firstName",
    "sortOrders": "DESC"
}

output

{
    "message": "处理成功",

    "data": {
        "shoppers":
            [
                {
                    "loginID": null,
                    "title": null,
                    "firstName": "kevin",
                    "lastName": null,
                    "officeTel": null,
                    "phoneNum": null,
                    "mobileNum": null,
                    "emailAddr": null,
                    "addr1": null,
                    "addr2": null,
                    "addr3": null,
                    "districtID": null
                },

                // ...
            ]
        },

        "error_code": "2000",
        "is_success": true,
    },
}

Artisan CLI

$ php artisan mpos-ws:member:query

Member count

url

/member/count

input

data = {
    "keywords": "samuel|kevin",
    "queryFields": "firstName",
    "fieldsRelation": 1
}

output

{
    "message":"处理成功",
    "data": {
        noOfShoppers: 22
    },
    "error_code":"2000",
    "is_success":true
}

Artisan CLI

$ php artisan mpos-ws:member:count

Member Available Fileds

url

/member/fields

output

{
    "message": "处理成功",
    "data": {
        "queryFields": "loginID|title|firstName|lastName|officeTel|phoneNum|mobileNum|emailAddr|addr1|addr2|addr3|districtID"
    },
    "error_code": "2000",
    "is_success": true
}

Artisan CLI

$ php artisan mpos-ws:member:fields

Member district detail

/member/district/query

output

{
    "message":"处理成功",
    "data": {
        "districts": [
            {
                "districtID": "2025",
                "districtNameEnu": "Tsim Sha Tsui",
                "districtNameZht": "尖沙咀",
                "districtNameZhs": "尖沙咀"
            },

            // ...
        ]
    },
    "error_code": "2000",
    "is_success": true
}

Artisan CLI

$ php artisan mpos-ws:member:districts

Member Addressbook

和 service 的差別是, 這個是查詢該客戶所有的地址

url

/member/addressbook/query

input

data = {
    "keywords": "1"
}

output

{
    "message":"处理成功",
    "data": {
        "addressbooks": [
            {
                "id": 3841,
                "defaults": false,
                "loginID": 1,
                "title": "Mr",
                "firstName": "Jason",
                "lastName": "Tam",
                "officeTel": "11111111",
                "phoneNum": "11111111",
                "mobileNum": "33333333",
                "emailAddr": null,
                "addr1": "New Street address",
                "addr2": null,
                "addr3": null,
                "districtID": "132"
            },

            //...
        ]
    },
    "error_code": "2000",
    "is_success": true
}

Artisan CLI

$ php artisan mpos-ws:member:addressbook
Clone this wiki locally