Member List

Last Updated on : 2023-06-21 07:13:11download

Query the members on pages. You can filter the members by member status.

API address

GET: /v1.0/iot-02/community/members

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	query	true	The ID of the community.
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The number of items returned on each page.
mobile_or_name	String	query	false	The member's mobile phone number or name. A mobile phone number must be four or more digits in length.
status	Integer	query	false	The account status. Valid values: `1`: enabled. `2`: disabled. `3`: not activated.

Return parameter

Parameter name	Type	Description
result	HighwayMemberListResponse

Description of result

Parameter name	Type	Description
total_record	Long	The total number of results.
data	List	Member List

Description of data

Parameter name	Type	Description
member_id	String	The list of member IDs, separated with commas (,).
admin_name	String	The name.
role_infos	List	The list of roles.
mobile	String	The mobile phone number.
blocks	List	The list of organizations.
account_status	Integer	The account status. Valid values: `1`: enabled. `2`: disabled. `3`: not activated.
structure_id	String	The ID of a specified organization.
structure_name	String	The name of a specified organization.
sex	Integer	Gender. Valid values: `1`: male. `2`: female.
myself	Integer	Indicates whether it is the current operator. Valid values: `1`: yes. `2`: no.
admin	Integer	Indicates whether it is an administrator. Valid values: `1`: yes. `2`: no.

Description of role_infos

Parameter name	Type	Description
role_id	String	The ID of a specified role.
role_name	String	The name of a specified role.

Description of blocks

Parameter name	Type	Description
block_id	String	The ID of a specified community.
block_name	String	The name of a specified community.
related_structure_name	String	The name of a specified management organization.

Request example

GET: /v1.0/iot-02/community/member?block_id=136767399153950xxxx&page_no=1&page_size=20

Return example

[
    {
        "member_id": "136767399153950xxxx",
        "birthday": 0,
        "education": "Primary School",
        "blocks": "136767399153950xxxx",
        "sex": 1,
        "myself": 2,
        "mobile": "1300000****",
        "admin": 0,
        "structure_id": "136767399153950xxxx",
        "account_status": 1,
        "card_type": 1,
        "role_infos": [
        ],
        "country_code": "86",
        "structure_infos": [
        ],
        "card_no": "31162119920918xxxx",
        "structure_name": "test",
        "structure_path_name": "test",
        "admin_name": "Utilities Operation and Maintenance",
        "position": "Plumber"
    }
]

Error code

For more information, see error code.

Prev DocModify Member

Next DocRemove Members