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

Add Member

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

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

API address

POST: /v1.0/iot-02/community/member

Request parameter

Description of body

Parameter name	Type	Required	Description
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 the member 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	The 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	String	The ID of a specified member.

Request example

POST: /v1.0/iot-02/community/member

{
  "admin_name": "Utilities Operation and Maintenance",
  "role_infos": [],
  "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",
  "role_ids": "136767399153950xxxx,136767399153950xxxx",
  "card_type": 1,
  "card_no": "31162119920918xxxx",
  "birthday": 0,
  "position": "Plumber",
  "education": "Primary School"
}

Return example

139215249742181xxxx

Error code

For more information, see error code.

Prev DocQuery Details

Next DocModify Member