Skip to content

API Category 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_category_group

Short nameDescription
group_nameThe group nameRequired
exclude_group0=none, 1=Channel Assignment, 3=File AssignmentOptional
field_html_formattingnone, safe or allOptional
can_edit_categoriesa membergroup IDOptional
can_delete_categoriesa membergroup IDOptional

Request

Array
(
    [group_name] => Test group
    [exclude_group] => 0
    [field_html_formatting] => all
    [can_edit_categories] => 6
    [can_delete_categories] => 6
)

read_category_group

Short nameDescription
group_idThe group idRequired
show_childrenGet also all category childrenOptional

Request

Array
(
    [group_id] => 2
    [show_children] => yes
)

update_category_group

Short nameDescription
group_idThe id of the groupRequired
group_nameThe group nameOptional
exclude_group0=none, 1=Channel Assignment, 3=File AssignmentOptional
field_html_formattingnone, safe or allOptional
can_edit_categoriesa membergroup IDOptional
can_delete_categoriesa membergroup IDOptional

Request

Array
(
  [group_id] => 14  
  [group_name] => Test group
  [exclude_group] => 0
  [field_html_formatting] => all
  [can_edit_categories] => 6
  [can_delete_categories] => 6
)

delete_category_group

Short nameDescription
group_idThe id of the groupRequired

Request

Array
(
  [group_id] => 14  
)

Hooks

webservice_create_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_create_category_group_end', $category_group_id);

webservice_read_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_read_category_group_end', $category_group_data);

webservice_update_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_update_category_group_end', $category_group_data);

webservice_delete_category_group_end

(added in v2.2)

ee()->extensions->call('webservice_delete_category_group_end', '');