Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceMember ManagementModify Member

Modify Member

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

According to the member ID, update the basic information, permission, and role of a specified member.

API address

PUT: /v1.0/iot-02/community/member/{block_id}/{member_id}

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	uri	true	The ID of the community.
member_id	String	uri	true	The ID of a specified member.

Description of body

Parameter name	Type	Required	Description
member_id	String	true	The list of member IDs, separated with commas (,).
block_ids	String	true	The community IDs, separated with commas (,).
structure_id	String	true	The ID of a specified organization.
education	String	true	The education background.
role_ids	String	true	The list of role IDs, separated with commas (,).
admin	Integer	false	Indicates whether it is an administrator. Valid values: `1`: yes. `2`: no.
data_permission	Integer	false	The permission to view data privacy. Valid values: `1`: open. `2`: confidential.
country_code	String	false	The country/region code. `86`: China.
admin_name	String	true	The name.
sex	Integer	true	Gender. Valid values: `1`: male. `2`: female.
mobile	String	true	The mobile phone number.
card_type	Integer	false	The type of certificate. `1`: identity card.
card_no	String	false	The certificate number.
birthday	Long	false	The birthday.
position	String	false	The job position.

Return parameter

Parameter name	Type	Description
result	Boolean	Indicates whether the operation is successful.

Request example

PUT: /v1.0/iot-02/community/member/136767399153950xxxx/139215249742181xxxx

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

Return example

true

Error code

For more information, see error code.

Prev DocAdd Member

Next DocMember List