Query Organization Member

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

Querying the members of an organization returns a list of members.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
structure_id	String	query	true	The ID of a specified organization.
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The paging size.

Return parameter

Parameter name	Type	Description
result	HighwayStructureMembersListResponse	The list of returned results.

Description of result

Parameter name	Type	Description
data	List	The returned data.
total_count	Integer	The total items.

Description of data

Parameter name	Type	Description
structure_id	String	The ID of a specified organization.
structure_name	String	The name of a specified organization.
admin_id	String	The ID of a specified member.
admin_name	String	The name of a specified member.
role_infos	List	The list of roles.
mobile	String	The phone number.
blocks	List	The list of projects.
account_status	Integer	Account status. 1: enabled, 2: disabled.
sex	Integer	Gender. 1: male, 2: female.

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 the project.
block_name	String	The name of the project.
related_structure_name	String	The name of a specified organization.

Request example

GET: /v1.0/iot-02/community/structure/members?structure_id=137209008422933xxxx&page_no=1&page_size=20

Return example

{
    "roleInfos": [
        {
            "roleId": "139066188980085xxxx",
            "roleName": "test"
        }
    ],
    "blocks": [
        {
            "blockName": "Test Project",
            "blockId": "138439127854128xxxx"
        },
        {
            "blockName": "Test Project",
            "blockId": "138443886026776xxxx"
        }
    ],
    "myself": 2,
    "sex": 1,
    "mobile": "1368570xxxx",
    "admin": 2,
    "structureId": "138228055157827xxxx",
    "totalCount": 1,
    "accountStatus": 3,
    "adminName": "Administrator",
    "adminId": "139088092343572xxxx"
}

Error code

For more information, see error code.

Prev DocQuery Sub-Organization

Next DocModify Organization