Skip to content

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 nameDescription
site_idThe site IDRequired
group_titleRequired
group_descriptionOptional
search_flood_controlOptional
prv_msg_send_limitOptional
prv_msg_storage_limitOptional
channelsAssigned channels (pipeline seperated)Optional
modulesAssigned modules (pipeline seperated)Optional
template_groupsAssigned template_groups (pipeline seperated)Optional
is_lockedOptional
can_view_offline_systemOptional
can_view_offline_systemOptional
can_access_cpOptional
can_access_contentOptional
can_access_publishOptional
can_access_editOptional
can_access_filesOptional
can_access_fieldtypesOptional
can_access_designOptional
can_access_addonsOptional
can_access_modulesOptional
can_access_extensionsOptional
can_access_accessoriesOptional
can_access_pluginsOptional
can_access_membersOptional
can_access_adminOptional
can_access_sys_prefsOptional
can_access_content_prefsOptional
can_access_toolsOptional
can_access_commOptional
can_access_utilitiesOptional
can_access_dataOptional
can_access_logsOptional
can_admin_channelsOptional
can_admin_upload_prefsOptional
can_admin_designOptional
can_admin_membersOptional
can_delete_membersOptional
can_admin_mbr_groupsOptional
can_admin_mbr_templatesOptional
can_ban_usersOptional
can_admin_modulesOptional
can_admin_templatesOptional
can_edit_categoriesOptional
can_delete_categoriesOptional
can_view_other_entriesOptional
can_edit_other_entriesOptional
can_assign_post_authorsOptional
can_delete_self_entriesOptional
can_delete_all_entriesOptional
can_view_other_commentsOptional
can_edit_own_commentsOptional
can_delete_own_commentsOptional
can_edit_all_commentsOptional
can_delete_all_commentsOptional
can_moderate_commentsOptional
can_send_emailOptional
can_send_cached_emailOptional
can_email_member_groupsOptional
can_email_mailinglistOptional
can_email_from_profileOptional
can_view_profilesOptional
can_edit_html_buttonsOptional
can_delete_selfOptional
mbr_delete_notify_emailsOptional
can_post_commentsOptional
exclude_from_moderationOptional
can_searchOptional
can_send_private_messagesOptional
can_attach_in_private_messagesOptional
can_send_bulletinsOptional
include_in_authorlistOptional
include_in_memberlistOptional
include_in_mailinglistsOptional
search_flood_controlOptional
search_flood_controlOptional

Request

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

read_member_group

Short nameDescription
group_idThe group IDRequired

Request

Array
(
    [group_id] => 2
)

update_member_group

Short nameDescription
site_idThe site IDRequired
group_idThe membergroup IDRequired
group_titleRequired
group_descriptionOptional
search_flood_controlOptional
prv_msg_send_limitOptional
prv_msg_storage_limitOptional
channelsAssigned channels (pipeline seperated)Optional
modulesAssigned modules (pipeline seperated)Optional
template_groupsAssigned template_groups (pipeline seperated)Optional
is_lockedOptional
can_view_offline_systemOptional
can_view_offline_systemOptional
can_access_cpOptional
can_access_contentOptional
can_access_publishOptional
can_access_editOptional
can_access_filesOptional
can_access_fieldtypesOptional
can_access_designOptional
can_access_addonsOptional
can_access_modulesOptional
can_access_extensionsOptional
can_access_accessoriesOptional
can_access_pluginsOptional
can_access_membersOptional
can_access_adminOptional
can_access_sys_prefsOptional
can_access_content_prefsOptional
can_access_toolsOptional
can_access_commOptional
can_access_utilitiesOptional
can_access_dataOptional
can_access_logsOptional
can_admin_channelsOptional
can_admin_upload_prefsOptional
can_admin_designOptional
can_admin_membersOptional
can_delete_membersOptional
can_admin_mbr_groupsOptional
can_admin_mbr_templatesOptional
can_ban_usersOptional
can_admin_modulesOptional
can_admin_templatesOptional
can_edit_categoriesOptional
can_delete_categoriesOptional
can_view_other_entriesOptional
can_edit_other_entriesOptional
can_assign_post_authorsOptional
can_delete_self_entriesOptional
can_delete_all_entriesOptional
can_view_other_commentsOptional
can_edit_own_commentsOptional
can_delete_own_commentsOptional
can_edit_all_commentsOptional
can_delete_all_commentsOptional
can_moderate_commentsOptional
can_send_emailOptional
can_send_cached_emailOptional
can_email_member_groupsOptional
can_email_mailinglistOptional
can_email_from_profileOptional
can_view_profilesOptional
can_edit_html_buttonsOptional
can_delete_selfOptional
mbr_delete_notify_emailsOptional
can_post_commentsOptional
exclude_from_moderationOptional
can_searchOptional
can_send_private_messagesOptional
can_attach_in_private_messagesOptional
can_send_bulletinsOptional
include_in_authorlistOptional
include_in_memberlistOptional
include_in_mailinglistsOptional
search_flood_controlOptional
search_flood_controlOptional

Request

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

delete_member_group

Short nameDescription
group_idThe group IDRequired

Request

Array
(
    [group_id] => 2
)

Hooks

the default EE hooks are being used.