Appearance
API Channel
Compatibility
- EE2
- EE3
- EE4
- EE5
- EE6
- EE7
Installation
- Copy the files to the
system/user
dir - Enable the API from within the Webservice Module
Methods
create_channel
Short name | Description | |
---|---|---|
site_id | The site ID | Required |
channel_title | The channel title | Required |
channel_name | The channel name | Required |
url_title_prefix | The url prefix | Optional |
comment_expiration | The comment expiration date | Optional |
status_group | Status group ID | Optional |
field_group | Field group ID | Optional |
channel_url | The channel url | Optional |
channel_lang | Language of the channel | Optional |
group_order | Order position | Optional |
Request
Array
(
[site_id] => 1
[channel_title] => Test Channel
[channel_name] => test_channel
)
read_channel
Short name | Description | |
---|---|---|
channel_id | The channel ID | Required |
Request
Array
(
[channel_id] => 1
)
update_channel
Short name | Description | |
---|---|---|
channel_id | The channel ID | Required |
channel_title | The channel title | Optional |
channel_name | The channel name | Optional |
url_title_prefix | The url prefix | Optional |
comment_expiration | The comment expiration date | Optional |
status_group | Status group ID | Optional |
field_group | Field group ID | Optional |
channel_url | The channel url | Optional |
channel_lang | Language of the channel | Optional |
group_order | Order position | Optional |
Request
Array
(
[channel_id] => 1
[channel_title] => Test Channel
[channel_name] => test_channel
)
delete_channel
Short name | Description | |
---|---|---|
channel_id | The channel ID | Required |
Request
Array
(
[channel_id] => 1
)
Hooks
webservice_create_channel_end
(added in v3.0)
ee()->extensions->call('webservice_create_channel_end', $channel_id);
webservice_read_channel_end
(added in v3.0)
ee()->extensions->call('webservice_read_channel_end', $channel_read_data);
webservice_update_channel_end
(added in v3.0)
ee()->extensions->call('webservice_update_channel_end', $channel_update_data);
webservice_delete_channel_end
(added in v3.0)
ee()->extensions->call('webservice_delete_channel_end', $channel_id);