English
English
简体中文
Contact Us
Register
Log In

Query Steward List

Last Updated on : 2023-01-29 06:59:53

Query the list of community stewards on pages, including the community ID, page number, page size, and other information.

API address

GET: /v1.0/iot-02/community/house-keeper-page

Request parameter

Parameter nameTypeINRequiredDescription
block_idStringquerytrueThe community ID.
page_noIntegerquerytrueThe page number.
page_sizeIntegerquerytrueThe number of items to be returned per page.

Return parameter

Parameter nameTypeDescription
resultPageResultThe returned result.

Description of result

Parameter nameTypeDescription
dataListThe number of records returned on each page.
total_recordLongThe total number of records.

Description of data

Parameter nameTypeDescription
block_idStringThe community ID.
hk_idStringThe ID of the specified community steward.
housekeeper_nameStringThe name of the specified community steward.
remarksStringThe remarks.
tree_idsStringThe list of house IDs, separated with commas (,).
face_img_urlStringThe URL of the specified image.
wechat_img_urlStringThe image of the specified WeChat QR code.
abilityStringThe capability.
evaluate_numberLongThe number of reviews.
favorable_ratingIntegerThe percentage of positive reviews.
house_nameStringThe management scopes, separated with semicolons (;).
service_mottoStringThe service motto.
create_timeLongThe time when it was created.
mobileStringThe mobile phone number.

Request example

GET: /v1.0/iot-02/community/house-keeper-page

Return example

{
    "result": {
        "data": [
            {
                "housekeeperName": "James",
                "evaluateNumber": 0,
                "mobile": "13750505050",
                "hkId": "1436249349305667679",
                "serviceMotto": "Serve the community",
                "blockId": "1399960265050574848",
                "houseName": "Tuya Smart (Test)",
                "createTime": 1631263503754,
                "faceImgUrl": "https://tuya-biz-data-1254153901.cos.ap-shanghai.myqcloud.com/saas/community/estate_faceImg/1631263461c4ab57ccd48.jpg?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDopcCYgw0qRoyV5qfKjvg2pPkqESnb5zI%26q-sign-time%3D1632640520%3B1632644120%26q-key-time%3D1632640520%3B1632644120%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3Db497a904f405100c7485e5e67a695a29e5a77e4b&imageMogr2/format/jpeg/quality/50/thumbnail/1024x1024/thumbnail/5000000@/auto-orient",
                "ability": "8",
                "favorableRating": 0
            }
        ],
        "totalRecord": 1
    },
    "t": 1632640520157,
    "success": true
}

Error code

For more information, see error code.