Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceProperty ServiceQuery Steward List

Query Steward List

Last Updated on : 2023-06-21 07:13:12

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 name	Type	IN	Required	Description
block_id	String	query	true	The community ID.
page_no	Integer	query	true	The page number.
page_size	Integer	query	true	The number of items to be returned per page.

Return parameter

Parameter name	Type	Description
result	PageResult	The returned result.

Description of result

Parameter name	Type	Description
data	List	The number of records returned on each page.
total_record	Long	The total number of records.

Description of data

Parameter name	Type	Description
block_id	String	The community ID.
hk_id	String	The ID of the specified community steward.
housekeeper_name	String	The name of the specified community steward.
remarks	String	The remarks.
tree_ids	String	The list of house IDs, separated with commas (,).
face_img_url	String	The URL of the specified image.
wechat_img_url	String	The image of the specified WeChat QR code.
ability	String	The capability.
evaluate_number	Long	The number of reviews.
favorable_rating	Integer	The percentage of positive reviews.
house_name	String	The management scopes, separated with semicolons (`;`).
service_motto	String	The service motto.
create_time	Long	The time when it was created.
mobile	String	The 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.

Prev DocQuery Community Housekeeper Details

Next DocUser Service