API Member Group

Compatibility

• EE2
• EE3
• EE4
• EE5
• EE6
• EE7

Installation

1. Copy the files to the system/user dir
2. Enable the API from within the Webservice Module

Methods

create_member_group

Short name	Description
site_id	The site ID	Required
group_title		Required
group_description		Optional
search_flood_control		Optional
prv_msg_send_limit		Optional
prv_msg_storage_limit		Optional
channels	Assigned channels (pipeline seperated)	Optional
modules	Assigned modules (pipeline seperated)	Optional
template_groups	Assigned template_groups (pipeline seperated)	Optional
is_locked		Optional
can_view_offline_system		Optional
can_view_offline_system		Optional
can_access_cp		Optional
can_access_content		Optional
can_access_publish		Optional
can_access_edit		Optional
can_access_files		Optional
can_access_fieldtypes		Optional
can_access_design		Optional
can_access_addons		Optional
can_access_modules		Optional
can_access_extensions		Optional
can_access_accessories		Optional
can_access_plugins		Optional
can_access_members		Optional
can_access_admin		Optional
can_access_sys_prefs		Optional
can_access_content_prefs		Optional
can_access_tools		Optional
can_access_comm		Optional
can_access_utilities		Optional
can_access_data		Optional
can_access_logs		Optional
can_admin_channels		Optional
can_admin_upload_prefs		Optional
can_admin_design		Optional
can_admin_members		Optional
can_delete_members		Optional
can_admin_mbr_groups		Optional
can_admin_mbr_templates		Optional
can_ban_users		Optional
can_admin_modules		Optional
can_admin_templates		Optional
can_edit_categories		Optional
can_delete_categories		Optional
can_view_other_entries		Optional
can_edit_other_entries		Optional
can_assign_post_authors		Optional
can_delete_self_entries		Optional
can_delete_all_entries		Optional
can_view_other_comments		Optional
can_edit_own_comments		Optional
can_delete_own_comments		Optional
can_edit_all_comments		Optional
can_delete_all_comments		Optional
can_moderate_comments		Optional
can_send_email		Optional
can_send_cached_email		Optional
can_email_member_groups		Optional
can_email_mailinglist		Optional
can_email_from_profile		Optional
can_view_profiles		Optional
can_edit_html_buttons		Optional
can_delete_self		Optional
mbr_delete_notify_emails		Optional
can_post_comments		Optional
exclude_from_moderation		Optional
can_search		Optional
can_send_private_messages		Optional
can_attach_in_private_messages		Optional
can_send_bulletins		Optional
include_in_authorlist		Optional
include_in_memberlist		Optional
include_in_mailinglists		Optional
search_flood_control		Optional
search_flood_control		Optional

Request

Array
(
    [site_id] => 1
    [group_title] => Test group
    [can_view_offline_system] => y
    [can_search] => n
)

read_member_group

Short name	Description
group_id	The group ID	Required

Request

Array
(
    [group_id] => 2
)

update_member_group

Short name	Description
site_id	The site ID	Required
group_id	The membergroup ID	Required
group_title		Required
group_description		Optional
search_flood_control		Optional
prv_msg_send_limit		Optional
prv_msg_storage_limit		Optional
channels	Assigned channels (pipeline seperated)	Optional
modules	Assigned modules (pipeline seperated)	Optional
template_groups	Assigned template_groups (pipeline seperated)	Optional
is_locked		Optional
can_view_offline_system		Optional
can_view_offline_system		Optional
can_access_cp		Optional
can_access_content		Optional
can_access_publish		Optional
can_access_edit		Optional
can_access_files		Optional
can_access_fieldtypes		Optional
can_access_design		Optional
can_access_addons		Optional
can_access_modules		Optional
can_access_extensions		Optional
can_access_accessories		Optional
can_access_plugins		Optional
can_access_members		Optional
can_access_admin		Optional
can_access_sys_prefs		Optional
can_access_content_prefs		Optional
can_access_tools		Optional
can_access_comm		Optional
can_access_utilities		Optional
can_access_data		Optional
can_access_logs		Optional
can_admin_channels		Optional
can_admin_upload_prefs		Optional
can_admin_design		Optional
can_admin_members		Optional
can_delete_members		Optional
can_admin_mbr_groups		Optional
can_admin_mbr_templates		Optional
can_ban_users		Optional
can_admin_modules		Optional
can_admin_templates		Optional
can_edit_categories		Optional
can_delete_categories		Optional
can_view_other_entries		Optional
can_edit_other_entries		Optional
can_assign_post_authors		Optional
can_delete_self_entries		Optional
can_delete_all_entries		Optional
can_view_other_comments		Optional
can_edit_own_comments		Optional
can_delete_own_comments		Optional
can_edit_all_comments		Optional
can_delete_all_comments		Optional
can_moderate_comments		Optional
can_send_email		Optional
can_send_cached_email		Optional
can_email_member_groups		Optional
can_email_mailinglist		Optional
can_email_from_profile		Optional
can_view_profiles		Optional
can_edit_html_buttons		Optional
can_delete_self		Optional
mbr_delete_notify_emails		Optional
can_post_comments		Optional
exclude_from_moderation		Optional
can_search		Optional
can_send_private_messages		Optional
can_attach_in_private_messages		Optional
can_send_bulletins		Optional
include_in_authorlist		Optional
include_in_memberlist		Optional
include_in_mailinglists		Optional
search_flood_control		Optional
search_flood_control		Optional

Request

Array
(
    [group_id] => 2
    [can_send_email] => n
)

delete_member_group

Short name	Description
group_id	The group ID	Required

Request

Array
(
    [group_id] => 2
)

Hooks

the default EE hooks are being used.