POST /api/continue

continue user login auth

Documentation
Sandbox

Documentation

Continue action login

@ApiDoc( description="continue user login auth", statusCodes={ 201="New user", 200="User login", 403="Not Allowed" }, parameters={ {"name"="code", "dataType"="string", "required"=true, "description"="oauth code"}, {"name"="client_id", "dataType"="string", "required"=true, "description"="%client_id%_%public_id_code%"} } )

Parameters

Parameter	Type	Required?	Format	Description
code	string	true		oauth code
client_id	string	true		%client_id%_%public_id_code%

Status Codes

Status Code	Description
201	New user
200	User login
403	Not Allowed

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/continue_register

continue create user

Documentation
Sandbox

Documentation

Create a new user entity

@ApiDoc( description="continue create user", statusCodes={ 201="New user", 200="User login", 403="Not Allowed" }, parameters={ {"name"="code", "dataType"="string", "required"=true, "description"="oauth code"}, {"name"="client_id", "dataType"="string", "required"=true, "description"="%client_id%_%public_id_code%"}, {"name"="nick", "dataType"="string", "required"=true, "description"="user nick"}, {"name"="password", "dataType"="string", "required"=true, "description"="user password"} } )

Parameters

Parameter	Type	Required?	Description
code	string	true	oauth code
client_id	string	true	%client_id%_%public_id_code%
nick	string	true	user nick
password	string	true	user password

Status Codes

Status Code	Description
201	New user
200	User login
403	Not Allowed

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/oauth/v2/revoke

revokes the access token

Documentation
Sandbox

Documentation

Revokes the access token

Status Codes

Status Code	Description
200	token revoked with success
403	Not authenticated with grant=password

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/register

create a user

Documentation
Sandbox

Documentation

Create a new user entity

Parameters

Parameter	Type	Required?	Description
user_registration	object (RegistrationFormType)	true
user_registration[email]	string	true	form.email
user_registration[username]	string	true	form.username
user_registration[plainPassword]	object (RepeatedType)	true
user_registration[plainPassword][first]	string	true	form.password
user_registration[plainPassword][second]	string	true	form.password_confirmation
user_registration[ip]	string	true
user_registration[language]	string	false
user_registration[facebookId]	string	false
user_registration[enabled]	boolean	false
user_registration[client]	string	true
user_registration[country]	integer	true
user_registration[city]	integer	true

Return

Parameter	Type	Versions	Description
200
email	string	*
client	object (Client)	*
client[id]	integer	*
client[random_id]	string	*
client[secret]	string	*
client[redirect_uris]	array	*
client[allowed_grant_types]	array	*
client[name]	string	*
client[affiliate]	object (Affiliate)	*
client[affiliate][id]	integer	*
client[affiliate][name]	string	*
client[affiliate][email]	string	*
client[affiliate][phone]	string	*
client[affiliate][address]	string	*
client[affiliate][nif]	string	*
client[affiliate][clients][]	array of objects (Client)	*
client[affiliate][user]	object (User)	*
client[affiliate][user][id]	integer	*
client[affiliate][user][username]	string	*
client[affiliate][user][username_canonical]	string	*
client[affiliate][user][email]	string	*
client[affiliate][user][email_canonical]	string	*
client[affiliate][user][enabled]	boolean	*
client[affiliate][user][salt]	string	*	The salt to use for hashing.
client[affiliate][user][password]	string	*	Encrypted password. Must be persisted.
client[affiliate][user][last_login]	DateTime	*
client[affiliate][user][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
client[affiliate][user][password_requested_at]	DateTime	*
client[affiliate][user][roles]	array	*
client[affiliate][user][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][id]	integer	*
client[affiliate][user][channels][][name]	string	*
client[affiliate][user][channels][][slug]	string	*
client[affiliate][user][channels][][irc_channel]	string	*
client[affiliate][user][channels][][description]	string	*
client[affiliate][user][channels][][count_visits]	integer	*
client[affiliate][user][channels][][owner]	object (User)	*
client[affiliate][user][channels][][number_fans]	integer	*	TODO this column is calculated We can delete
client[affiliate][user][channels][][fans][]	array of objects (User)	*
client[affiliate][user][channels][][channel_type]	object (ChannelType)	*
client[affiliate][user][channels][][channel_type][id]	integer	*
client[affiliate][user][channels][][channel_type][name]	string	*
client[affiliate][user][channels][][channel_type][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][parent]	object (Channel)	*
client[affiliate][user][channels][][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][enabled]	boolean	*
client[affiliate][user][channels][][publicated_at]	DateTime	*
client[affiliate][user][channels][][language]	string	*
client[affiliate][user][channels][][visible]	boolean	*
client[affiliate][user][channels][][num_users]	integer	*
client[affiliate][user][client]	object (Client)	*
client[affiliate][user][channels_fan][]	array of objects (Channel)	*
client[affiliate][user][profile]	object (Profile)	*
client[affiliate][user][profile][id]	integer	*
client[affiliate][user][profile][about]	string	*
client[affiliate][user][profile][seeking]	string	*
client[affiliate][user][profile][gender]	string	*
client[affiliate][user][profile][birthday]	DateTime	*
client[affiliate][user][profile][count_visits]	integer	*
client[affiliate][user][profile][you_want]	string	*
client[affiliate][user][profile][chat_on_line]	boolean	*
client[affiliate][user][deleted]	boolean	*
client[affiliate][user][created_at]	DateTime	*
client[affiliate][user][locked]	boolean	*
client[affiliate][user][ip]	string	*
client[affiliate][user][language]	string	*
client[affiliate][user][num_bounces]	integer	*
client[affiliate][user][global_statistic]	object (GlobalStatistic)	*
client[affiliate][user][global_statistic][subject]	object (User)	*
client[confirmed_uri]	string	*
client[resetting_url]	string	*
client[brand_image_url]	string	*
client[brand_facebook_url]	string	*
client[brand_twitter_url]	string	*
client[url_boilerplate]	string	*
client[url_boilerplate_messages]	string	*
client[users][]	array of objects (User)	*
client[users][][id]	integer	*
client[users][][username]	string	*
client[users][][username_canonical]	string	*
client[users][][email]	string	*
client[users][][email_canonical]	string	*
client[users][][enabled]	boolean	*
client[users][][salt]	string	*	The salt to use for hashing.
client[users][][password]	string	*	Encrypted password. Must be persisted.
client[users][][last_login]	DateTime	*
client[users][][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
client[users][][password_requested_at]	DateTime	*
client[users][][roles]	array	*
client[users][][channels][]	array of objects (Channel)	*
client[users][][channels][][id]	integer	*
client[users][][channels][][name]	string	*
client[users][][channels][][slug]	string	*
client[users][][channels][][irc_channel]	string	*
client[users][][channels][][description]	string	*
client[users][][channels][][count_visits]	integer	*
client[users][][channels][][owner]	object (User)	*
client[users][][channels][][number_fans]	integer	*	TODO this column is calculated We can delete
client[users][][channels][][fans][]	array of objects (User)	*
client[users][][channels][][channel_type]	object (ChannelType)	*
client[users][][channels][][channel_type][id]	integer	*
client[users][][channels][][channel_type][name]	string	*
client[users][][channels][][channel_type][channels][]	array of objects (Channel)	*
client[users][][channels][][parent]	object (Channel)	*
client[users][][channels][][channels][]	array of objects (Channel)	*
client[users][][channels][][enabled]	boolean	*
client[users][][channels][][publicated_at]	DateTime	*
client[users][][channels][][language]	string	*
client[users][][channels][][visible]	boolean	*
client[users][][channels][][num_users]	integer	*
client[users][][client]	object (Client)	*
client[users][][channels_fan][]	array of objects (Channel)	*
client[users][][profile]	object (Profile)	*
client[users][][profile][id]	integer	*
client[users][][profile][about]	string	*
client[users][][profile][seeking]	string	*
client[users][][profile][gender]	string	*
client[users][][profile][birthday]	DateTime	*
client[users][][profile][count_visits]	integer	*
client[users][][profile][you_want]	string	*
client[users][][profile][chat_on_line]	boolean	*
client[users][][profile][updatedAt]		*
client[users][][profile][publicatedAt]		*
client[users][][deleted]	boolean	*
client[users][][created_at]	DateTime	*
client[users][][locked]	boolean	*
client[users][][ip]	string	*
client[users][][language]	string	*
client[users][][num_bounces]	integer	*
client[users][][global_statistic]	object (GlobalStatistic)	*
client[users][][global_statistic][subject]	object (User)	*
client[users][][plainPassword]		*
username	string	*
ip	string	*
language	string	*
plainPassword		*
id	integer	*
username_canonical	string	*
email_canonical	string	*
enabled	boolean	*
salt	string	*	The salt to use for hashing.
password	string	*	Encrypted password. Must be persisted.
last_login	DateTime	*
confirmation_token	string	*	Random string sent to the user email address in order to verify it.
password_requested_at	DateTime	*
roles	array	*
channels[]	array of objects (Channel)	*
channels[][id]	integer	*
channels[][name]	string	*
channels[][slug]	string	*
channels[][irc_channel]	string	*
channels[][description]	string	*
channels[][count_visits]	integer	*
channels[][owner]	object (User)	*
channels[][owner][id]	integer	*
channels[][owner][username]	string	*
channels[][owner][username_canonical]	string	*
channels[][owner][email]	string	*
channels[][owner][email_canonical]	string	*
channels[][owner][enabled]	boolean	*
channels[][owner][salt]	string	*	The salt to use for hashing.
channels[][owner][password]	string	*	Encrypted password. Must be persisted.
channels[][owner][last_login]	DateTime	*
channels[][owner][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
channels[][owner][password_requested_at]	DateTime	*
channels[][owner][roles]	array	*
channels[][owner][channels][]	array of objects (Channel)	*
channels[][owner][client]	object (Client)	*
channels[][owner][client][id]	integer	*
channels[][owner][client][random_id]	string	*
channels[][owner][client][secret]	string	*
channels[][owner][client][redirect_uris]	array	*
channels[][owner][client][allowed_grant_types]	array	*
channels[][owner][client][name]	string	*
channels[][owner][client][affiliate]	object (Affiliate)	*
channels[][owner][client][affiliate][id]	integer	*
channels[][owner][client][affiliate][name]	string	*
channels[][owner][client][affiliate][email]	string	*
channels[][owner][client][affiliate][phone]	string	*
channels[][owner][client][affiliate][address]	string	*
channels[][owner][client][affiliate][nif]	string	*
channels[][owner][client][affiliate][clients][]	array of objects (Client)	*
channels[][owner][client][affiliate][user]	object (User)	*
channels[][owner][client][confirmed_uri]	string	*
channels[][owner][client][resetting_url]	string	*
channels[][owner][client][brand_image_url]	string	*
channels[][owner][client][brand_facebook_url]	string	*
channels[][owner][client][brand_twitter_url]	string	*
channels[][owner][client][url_boilerplate]	string	*
channels[][owner][client][url_boilerplate_messages]	string	*
channels[][owner][client][users][]	array of objects (User)	*
channels[][owner][channels_fan][]	array of objects (Channel)	*
channels[][owner][profile]	object (Profile)	*
channels[][owner][profile][id]	integer	*
channels[][owner][profile][about]	string	*
channels[][owner][profile][seeking]	string	*
channels[][owner][profile][gender]	string	*
channels[][owner][profile][birthday]	DateTime	*
channels[][owner][profile][count_visits]	integer	*
channels[][owner][profile][you_want]	string	*
channels[][owner][profile][chat_on_line]	boolean	*
channels[][owner][deleted]	boolean	*
channels[][owner][created_at]	DateTime	*
channels[][owner][locked]	boolean	*
channels[][owner][ip]	string	*
channels[][owner][language]	string	*
channels[][owner][num_bounces]	integer	*
channels[][owner][global_statistic]	object (GlobalStatistic)	*
channels[][owner][global_statistic][subject]	object (User)	*
channels[][number_fans]	integer	*	TODO this column is calculated We can delete
channels[][fans][]	array of objects (User)	*
channels[][channel_type]	object (ChannelType)	*
channels[][channel_type][id]	integer	*
channels[][channel_type][name]	string	*
channels[][channel_type][channels][]	array of objects (Channel)	*
channels[][parent]	object (Channel)	*
channels[][channels][]	array of objects (Channel)	*
channels[][enabled]	boolean	*
channels[][publicated_at]	DateTime	*
channels[][language]	string	*
channels[][visible]	boolean	*
channels[][num_users]	integer	*
channels[][ircChannel]		*
channels[][publicatedAt]		*
channels_fan[]	array of objects (Channel)	*
profile	object (Profile)	*
profile[id]	integer	*
profile[about]	string	*
profile[seeking]	string	*
profile[gender]	string	*
profile[birthday]	DateTime	*
profile[count_visits]	integer	*
profile[you_want]	string	*
profile[chat_on_line]	boolean	*
profile[updatedAt]		*
profile[publicatedAt]		*
deleted	boolean	*
created_at	DateTime	*
locked	boolean	*
num_bounces	integer	*
global_statistic	object (GlobalStatistic)	*
global_statistic[subject]	object (User)	*
global_statistic[subject][id]	integer	*
global_statistic[subject][username]	string	*
global_statistic[subject][username_canonical]	string	*
global_statistic[subject][email]	string	*
global_statistic[subject][email_canonical]	string	*
global_statistic[subject][enabled]	boolean	*
global_statistic[subject][salt]	string	*	The salt to use for hashing.
global_statistic[subject][password]	string	*	Encrypted password. Must be persisted.
global_statistic[subject][last_login]	DateTime	*
global_statistic[subject][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
global_statistic[subject][password_requested_at]	DateTime	*
global_statistic[subject][roles]	array	*
global_statistic[subject][channels][]	array of objects (Channel)	*
global_statistic[subject][client]	object (Client)	*
global_statistic[subject][channels_fan][]	array of objects (Channel)	*
global_statistic[subject][profile]	object (Profile)	*
global_statistic[subject][deleted]	boolean	*
global_statistic[subject][created_at]	DateTime	*
global_statistic[subject][locked]	boolean	*
global_statistic[subject][ip]	string	*
global_statistic[subject][language]	string	*
global_statistic[subject][num_bounces]	integer	*
global_statistic[subject][global_statistic]	object (GlobalStatistic)	*
global_statistic[subject][plainPassword]		*

Status Codes

Status Code	Description
201	New entity created
400	Bad request

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /resetting/send-email

Request reset user password, in the request is mandatory send username or email (dont work from nelmio api)

Documentation
Sandbox

Documentation

Request reset user password: submit form and send email

Filters

Name

Information

username

Description

The username or email of user to forward password

Return

Parameter	Type	Versions	Description
200 - Returned when successful
email	string	*
client	object (Client)	*
client[id]	integer	*
client[random_id]	string	*
client[secret]	string	*
client[redirect_uris]	array	*
client[allowed_grant_types]	array	*
client[name]	string	*
client[affiliate]	object (Affiliate)	*
client[affiliate][id]	integer	*
client[affiliate][name]	string	*
client[affiliate][email]	string	*
client[affiliate][phone]	string	*
client[affiliate][address]	string	*
client[affiliate][nif]	string	*
client[affiliate][clients][]	array of objects (Client)	*
client[affiliate][user]	object (User)	*
client[affiliate][user][id]	integer	*
client[affiliate][user][username]	string	*
client[affiliate][user][username_canonical]	string	*
client[affiliate][user][email]	string	*
client[affiliate][user][email_canonical]	string	*
client[affiliate][user][enabled]	boolean	*
client[affiliate][user][salt]	string	*	The salt to use for hashing.
client[affiliate][user][password]	string	*	Encrypted password. Must be persisted.
client[affiliate][user][last_login]	DateTime	*
client[affiliate][user][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
client[affiliate][user][password_requested_at]	DateTime	*
client[affiliate][user][roles]	array	*
client[affiliate][user][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][id]	integer	*
client[affiliate][user][channels][][name]	string	*
client[affiliate][user][channels][][slug]	string	*
client[affiliate][user][channels][][irc_channel]	string	*
client[affiliate][user][channels][][description]	string	*
client[affiliate][user][channels][][count_visits]	integer	*
client[affiliate][user][channels][][owner]	object (User)	*
client[affiliate][user][channels][][number_fans]	integer	*	TODO this column is calculated We can delete
client[affiliate][user][channels][][fans][]	array of objects (User)	*
client[affiliate][user][channels][][channel_type]	object (ChannelType)	*
client[affiliate][user][channels][][channel_type][id]	integer	*
client[affiliate][user][channels][][channel_type][name]	string	*
client[affiliate][user][channels][][channel_type][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][parent]	object (Channel)	*
client[affiliate][user][channels][][channels][]	array of objects (Channel)	*
client[affiliate][user][channels][][enabled]	boolean	*
client[affiliate][user][channels][][publicated_at]	DateTime	*
client[affiliate][user][channels][][language]	string	*
client[affiliate][user][channels][][visible]	boolean	*
client[affiliate][user][channels][][num_users]	integer	*
client[affiliate][user][client]	object (Client)	*
client[affiliate][user][channels_fan][]	array of objects (Channel)	*
client[affiliate][user][profile]	object (Profile)	*
client[affiliate][user][profile][id]	integer	*
client[affiliate][user][profile][about]	string	*
client[affiliate][user][profile][seeking]	string	*
client[affiliate][user][profile][gender]	string	*
client[affiliate][user][profile][birthday]	DateTime	*
client[affiliate][user][profile][count_visits]	integer	*
client[affiliate][user][profile][you_want]	string	*
client[affiliate][user][profile][chat_on_line]	boolean	*
client[affiliate][user][deleted]	boolean	*
client[affiliate][user][created_at]	DateTime	*
client[affiliate][user][locked]	boolean	*
client[affiliate][user][ip]	string	*
client[affiliate][user][language]	string	*
client[affiliate][user][num_bounces]	integer	*
client[affiliate][user][global_statistic]	object (GlobalStatistic)	*
client[affiliate][user][global_statistic][subject]	object (User)	*
client[confirmed_uri]	string	*
client[resetting_url]	string	*
client[brand_image_url]	string	*
client[brand_facebook_url]	string	*
client[brand_twitter_url]	string	*
client[url_boilerplate]	string	*
client[url_boilerplate_messages]	string	*
client[users][]	array of objects (User)	*
client[users][][id]	integer	*
client[users][][username]	string	*
client[users][][username_canonical]	string	*
client[users][][email]	string	*
client[users][][email_canonical]	string	*
client[users][][enabled]	boolean	*
client[users][][salt]	string	*	The salt to use for hashing.
client[users][][password]	string	*	Encrypted password. Must be persisted.
client[users][][last_login]	DateTime	*
client[users][][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
client[users][][password_requested_at]	DateTime	*
client[users][][roles]	array	*
client[users][][channels][]	array of objects (Channel)	*
client[users][][channels][][id]	integer	*
client[users][][channels][][name]	string	*
client[users][][channels][][slug]	string	*
client[users][][channels][][irc_channel]	string	*
client[users][][channels][][description]	string	*
client[users][][channels][][count_visits]	integer	*
client[users][][channels][][owner]	object (User)	*
client[users][][channels][][number_fans]	integer	*	TODO this column is calculated We can delete
client[users][][channels][][fans][]	array of objects (User)	*
client[users][][channels][][channel_type]	object (ChannelType)	*
client[users][][channels][][channel_type][id]	integer	*
client[users][][channels][][channel_type][name]	string	*
client[users][][channels][][channel_type][channels][]	array of objects (Channel)	*
client[users][][channels][][parent]	object (Channel)	*
client[users][][channels][][channels][]	array of objects (Channel)	*
client[users][][channels][][enabled]	boolean	*
client[users][][channels][][publicated_at]	DateTime	*
client[users][][channels][][language]	string	*
client[users][][channels][][visible]	boolean	*
client[users][][channels][][num_users]	integer	*
client[users][][client]	object (Client)	*
client[users][][channels_fan][]	array of objects (Channel)	*
client[users][][profile]	object (Profile)	*
client[users][][profile][id]	integer	*
client[users][][profile][about]	string	*
client[users][][profile][seeking]	string	*
client[users][][profile][gender]	string	*
client[users][][profile][birthday]	DateTime	*
client[users][][profile][count_visits]	integer	*
client[users][][profile][you_want]	string	*
client[users][][profile][chat_on_line]	boolean	*
client[users][][profile][updatedAt]		*
client[users][][profile][publicatedAt]		*
client[users][][deleted]	boolean	*
client[users][][created_at]	DateTime	*
client[users][][locked]	boolean	*
client[users][][ip]	string	*
client[users][][language]	string	*
client[users][][num_bounces]	integer	*
client[users][][global_statistic]	object (GlobalStatistic)	*
client[users][][global_statistic][subject]	object (User)	*
client[users][][plainPassword]		*
username	string	*
ip	string	*
language	string	*
plainPassword		*
id	integer	*
username_canonical	string	*
email_canonical	string	*
enabled	boolean	*
salt	string	*	The salt to use for hashing.
password	string	*	Encrypted password. Must be persisted.
last_login	DateTime	*
confirmation_token	string	*	Random string sent to the user email address in order to verify it.
password_requested_at	DateTime	*
roles	array	*
channels[]	array of objects (Channel)	*
channels[][id]	integer	*
channels[][name]	string	*
channels[][slug]	string	*
channels[][irc_channel]	string	*
channels[][description]	string	*
channels[][count_visits]	integer	*
channels[][owner]	object (User)	*
channels[][owner][id]	integer	*
channels[][owner][username]	string	*
channels[][owner][username_canonical]	string	*
channels[][owner][email]	string	*
channels[][owner][email_canonical]	string	*
channels[][owner][enabled]	boolean	*
channels[][owner][salt]	string	*	The salt to use for hashing.
channels[][owner][password]	string	*	Encrypted password. Must be persisted.
channels[][owner][last_login]	DateTime	*
channels[][owner][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
channels[][owner][password_requested_at]	DateTime	*
channels[][owner][roles]	array	*
channels[][owner][channels][]	array of objects (Channel)	*
channels[][owner][client]	object (Client)	*
channels[][owner][client][id]	integer	*
channels[][owner][client][random_id]	string	*
channels[][owner][client][secret]	string	*
channels[][owner][client][redirect_uris]	array	*
channels[][owner][client][allowed_grant_types]	array	*
channels[][owner][client][name]	string	*
channels[][owner][client][affiliate]	object (Affiliate)	*
channels[][owner][client][affiliate][id]	integer	*
channels[][owner][client][affiliate][name]	string	*
channels[][owner][client][affiliate][email]	string	*
channels[][owner][client][affiliate][phone]	string	*
channels[][owner][client][affiliate][address]	string	*
channels[][owner][client][affiliate][nif]	string	*
channels[][owner][client][affiliate][clients][]	array of objects (Client)	*
channels[][owner][client][affiliate][user]	object (User)	*
channels[][owner][client][confirmed_uri]	string	*
channels[][owner][client][resetting_url]	string	*
channels[][owner][client][brand_image_url]	string	*
channels[][owner][client][brand_facebook_url]	string	*
channels[][owner][client][brand_twitter_url]	string	*
channels[][owner][client][url_boilerplate]	string	*
channels[][owner][client][url_boilerplate_messages]	string	*
channels[][owner][client][users][]	array of objects (User)	*
channels[][owner][channels_fan][]	array of objects (Channel)	*
channels[][owner][profile]	object (Profile)	*
channels[][owner][profile][id]	integer	*
channels[][owner][profile][about]	string	*
channels[][owner][profile][seeking]	string	*
channels[][owner][profile][gender]	string	*
channels[][owner][profile][birthday]	DateTime	*
channels[][owner][profile][count_visits]	integer	*
channels[][owner][profile][you_want]	string	*
channels[][owner][profile][chat_on_line]	boolean	*
channels[][owner][deleted]	boolean	*
channels[][owner][created_at]	DateTime	*
channels[][owner][locked]	boolean	*
channels[][owner][ip]	string	*
channels[][owner][language]	string	*
channels[][owner][num_bounces]	integer	*
channels[][owner][global_statistic]	object (GlobalStatistic)	*
channels[][owner][global_statistic][subject]	object (User)	*
channels[][number_fans]	integer	*	TODO this column is calculated We can delete
channels[][fans][]	array of objects (User)	*
channels[][channel_type]	object (ChannelType)	*
channels[][channel_type][id]	integer	*
channels[][channel_type][name]	string	*
channels[][channel_type][channels][]	array of objects (Channel)	*
channels[][parent]	object (Channel)	*
channels[][channels][]	array of objects (Channel)	*
channels[][enabled]	boolean	*
channels[][publicated_at]	DateTime	*
channels[][language]	string	*
channels[][visible]	boolean	*
channels[][num_users]	integer	*
channels[][ircChannel]		*
channels[][publicatedAt]		*
channels_fan[]	array of objects (Channel)	*
profile	object (Profile)	*
profile[id]	integer	*
profile[about]	string	*
profile[seeking]	string	*
profile[gender]	string	*
profile[birthday]	DateTime	*
profile[count_visits]	integer	*
profile[you_want]	string	*
profile[chat_on_line]	boolean	*
profile[updatedAt]		*
profile[publicatedAt]		*
deleted	boolean	*
created_at	DateTime	*
locked	boolean	*
num_bounces	integer	*
global_statistic	object (GlobalStatistic)	*
global_statistic[subject]	object (User)	*
global_statistic[subject][id]	integer	*
global_statistic[subject][username]	string	*
global_statistic[subject][username_canonical]	string	*
global_statistic[subject][email]	string	*
global_statistic[subject][email_canonical]	string	*
global_statistic[subject][enabled]	boolean	*
global_statistic[subject][salt]	string	*	The salt to use for hashing.
global_statistic[subject][password]	string	*	Encrypted password. Must be persisted.
global_statistic[subject][last_login]	DateTime	*
global_statistic[subject][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
global_statistic[subject][password_requested_at]	DateTime	*
global_statistic[subject][roles]	array	*
global_statistic[subject][channels][]	array of objects (Channel)	*
global_statistic[subject][client]	object (Client)	*
global_statistic[subject][channels_fan][]	array of objects (Channel)	*
global_statistic[subject][profile]	object (Profile)	*
global_statistic[subject][deleted]	boolean	*
global_statistic[subject][created_at]	DateTime	*
global_statistic[subject][locked]	boolean	*
global_statistic[subject][ip]	string	*
global_statistic[subject][language]	string	*
global_statistic[subject][num_bounces]	integer	*
global_statistic[subject][global_statistic]	object (GlobalStatistic)	*
global_statistic[subject][plainPassword]		*

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find User entity with code 32

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

channel

GET /api/channel/modes.{_format}

List all the modes for channel

Documentation
Sandbox

Documentation

List all modes one channel

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels.{_format}

List all the channels

Documentation
Sandbox

Documentation

List all Channel entities. Can you use the filters: channelType, name and isRoot (isRoot=true|false), separate with comma ( , ) for example: field=value,field2=value2

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig

Filters

Name

Information

filter

Description

channelType=adult,name=name of channel, partialName=mans (minimum 3 chars), language=es

limit

Description

Max number of records to be returned

offset

Description

Number of records to skip

order

Description

Specify the order criteria of the result using the format COLUMN_NAME=ORDER[,COLUMN_NAME=ORDER ...]. Valid column names are name, fans, randomly, numUsers. Valid orders are asc and desc. Example: If you want de channels ordered by fans in descending order and then order by name in ascending order then the order string would be fans=desc,name=asc

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/channels.{_format}

create a channel

Documentation
Sandbox

Documentation

Create a new channel entity

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig

Parameters

Parameter	Type	Required?	Description
name	string	true	channel name
irc_channel	string	false	name of irc_channel
description	string	false	description of channel
language	string	false	laguage of chat room
channel_type	string	true	adult \| sex...
modes	string	false	[{"mode" : "r", "value": " "}]

Return

Parameter	Type	Versions	Description
200
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
201	New entity created
400	Bad request

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels/{channelName}/search.{_format}

Finds and displays a channel (use Like in name with format Like '%name%' )

Documentation
Sandbox

Documentation

Finds and displays a channel by name

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channelName		string	the start string name

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find Channel entity

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/channels/{channel}.{_format}

Delete a channel

Documentation
Sandbox

Documentation

Deletes a Channel entity.

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
403	Access denied
404	Unable to find Channel entity with code 32

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels/{channel}.{_format}

show a channel by id

Documentation
Sandbox

Documentation

Finds and displays a Channel entity.

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find Channel entity

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/channels/{channel}.{_format}

Patch a channel

Documentation
Sandbox

Documentation

Edits an existing Channel entity.

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Parameters

Parameter	Type	Required?	Description
description	string	false
language	string	false	laguage of chat room
modes	string	false

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
403	Access denied
404	Unable to find Channel entity with code 32

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/channels/{channel}.{_format}

Update a channel

Documentation
Sandbox

Documentation

Edits an existing Channel entity.

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Parameters

Parameter	Type	Required?	Description
description	string	false
language	string	false	laguage of chat room
modes	string	false

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
403	Access denied
404	Unable to find Channel entity with code 32

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels/{channel}/ircname.{_format}

show a channel by irc name

Documentation
Sandbox

Documentation

Finds and displays a Channel entity irc name

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find Channel entity

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/channels/{channel}/moderators/{user}.{_format}

delete a user as moderator in one channel

Documentation
Sandbox

Documentation

Delete a user as moderator in one channel

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel
user

Return

Parameter	Type	Versions	Description
200 - add new moderator
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	add new moderator

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels/{channel}/slug.{_format}

show a channel by slug

Documentation
Sandbox

Documentation

Finds and displays a Channel entity search by slug

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find Channel entity

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/channels/{channel}/visits.{_format}

Increase the countVisits of a channel

Documentation
Sandbox

Documentation

Increase the countVisits of a channel

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
channel

Return

Parameter	Type	Versions	Description
200 - countVisits increased

Status Codes

Status Code	Description
200	countVisits increased

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels/{id}/fans

Show all fans of a channel

Documentation
Sandbox

Documentation

Show all fans of a channel

Requirements

Name	Requirement	Type	Description
id

Filters

Name

Information

limit

Description

Max number of records to be returned

offset

Description

Number of records to skip

filters

Description

has_profile_photo=[1|0]

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/channels/{id}/plugins

Assign plugins to a channel

Documentation
Sandbox

Documentation

Put plugins to a channel.

Requirements

Name	Requirement	Type	Description
id

Parameters

Parameter	Type	Required?	Description
plugins	object (PluginType)	true
plugins[name]	string	true	array of plugins
plugins[parameters]	object (PluginParametersType)	true
plugins[parameters][name]	string	true	array of parameter names
plugins[parameters][value]	string	true	array of parameter values

Return

Parameter	Type	Versions	Description
200 - Returned when successful
name	string	*
slug	string	*
ircChannel		*
owner	object (User)	*
owner[id]	integer	*
owner[username]	string	*
owner[username_canonical]	string	*
owner[email]	string	*
owner[email_canonical]	string	*
owner[enabled]	boolean	*
owner[salt]	string	*	The salt to use for hashing.
owner[password]	string	*	Encrypted password. Must be persisted.
owner[last_login]	DateTime	*
owner[confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
owner[password_requested_at]	DateTime	*
owner[roles]	array	*
owner[channels][]	array of objects (Channel)	*
owner[channels][][id]	integer	*
owner[channels][][name]	string	*
owner[channels][][slug]	string	*
owner[channels][][irc_channel]	string	*
owner[channels][][description]	string	*
owner[channels][][count_visits]	integer	*
owner[channels][][owner]	object (User)	*
owner[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
owner[channels][][fans][]	array of objects (User)	*
owner[channels][][channel_type]	object (ChannelType)	*
owner[channels][][channel_type][id]	integer	*
owner[channels][][channel_type][name]	string	*
owner[channels][][channel_type][channels][]	array of objects (Channel)	*
owner[channels][][parent]	object (Channel)	*
owner[channels][][channels][]	array of objects (Channel)	*
owner[channels][][enabled]	boolean	*
owner[channels][][publicated_at]	DateTime	*
owner[channels][][language]	string	*
owner[channels][][visible]	boolean	*
owner[channels][][num_users]	integer	*
owner[channels][][ircChannel]		*
owner[channels][][publicatedAt]		*
owner[client]	object (Client)	*
owner[client][id]	integer	*
owner[client][random_id]	string	*
owner[client][secret]	string	*
owner[client][redirect_uris]	array	*
owner[client][allowed_grant_types]	array	*
owner[client][name]	string	*
owner[client][affiliate]	object (Affiliate)	*
owner[client][affiliate][id]	integer	*
owner[client][affiliate][name]	string	*
owner[client][affiliate][email]	string	*
owner[client][affiliate][phone]	string	*
owner[client][affiliate][address]	string	*
owner[client][affiliate][nif]	string	*
owner[client][affiliate][clients][]	array of objects (Client)	*
owner[client][affiliate][user]	object (User)	*
owner[client][confirmed_uri]	string	*
owner[client][resetting_url]	string	*
owner[client][brand_image_url]	string	*
owner[client][brand_facebook_url]	string	*
owner[client][brand_twitter_url]	string	*
owner[client][url_boilerplate]	string	*
owner[client][url_boilerplate_messages]	string	*
owner[client][users][]	array of objects (User)	*
owner[channels_fan][]	array of objects (Channel)	*
owner[profile]	object (Profile)	*
owner[profile][id]	integer	*
owner[profile][about]	string	*
owner[profile][seeking]	string	*
owner[profile][gender]	string	*
owner[profile][birthday]	DateTime	*
owner[profile][count_visits]	integer	*
owner[profile][you_want]	string	*
owner[profile][chat_on_line]	boolean	*
owner[profile][updatedAt]		*
owner[profile][publicatedAt]		*
owner[deleted]	boolean	*
owner[created_at]	DateTime	*
owner[locked]	boolean	*
owner[ip]	string	*
owner[language]	string	*
owner[num_bounces]	integer	*
owner[global_statistic]	object (GlobalStatistic)	*
owner[global_statistic][subject]	object (User)	*
owner[plainPassword]		*
publicatedAt		*
language	string	*
id	integer	*
irc_channel	string	*
description	string	*
count_visits	integer	*
number_fans	integer	*	TODO this column is calculated We can delete
fans[]	array of objects (User)	*
channel_type	object (ChannelType)	*
channel_type[id]	integer	*
channel_type[name]	string	*
channel_type[channels][]	array of objects (Channel)	*
channel_type[channels][][id]	integer	*
channel_type[channels][][name]	string	*
channel_type[channels][][slug]	string	*
channel_type[channels][][irc_channel]	string	*
channel_type[channels][][description]	string	*
channel_type[channels][][count_visits]	integer	*
channel_type[channels][][owner]	object (User)	*
channel_type[channels][][number_fans]	integer	*	TODO this column is calculated We can delete
channel_type[channels][][fans][]	array of objects (User)	*
channel_type[channels][][channel_type]	object (ChannelType)	*
channel_type[channels][][parent]	object (Channel)	*
channel_type[channels][][channels][]	array of objects (Channel)	*
channel_type[channels][][enabled]	boolean	*
channel_type[channels][][publicated_at]	DateTime	*
channel_type[channels][][language]	string	*
channel_type[channels][][visible]	boolean	*
channel_type[channels][][num_users]	integer	*
channel_type[channels][][ircChannel]		*
channel_type[channels][][publicatedAt]		*
parent	object (Channel)	*
parent[id]	integer	*
parent[name]	string	*
parent[slug]	string	*
parent[irc_channel]	string	*
parent[description]	string	*
parent[count_visits]	integer	*
parent[owner]	object (User)	*
parent[number_fans]	integer	*	TODO this column is calculated We can delete
parent[fans][]	array of objects (User)	*
parent[channel_type]	object (ChannelType)	*
parent[parent]	object (Channel)	*
parent[channels][]	array of objects (Channel)	*
parent[enabled]	boolean	*
parent[publicated_at]	DateTime	*
parent[language]	string	*
parent[visible]	boolean	*
parent[num_users]	integer	*
parent[ircChannel]		*
parent[publicatedAt]		*
channels[]	array of objects (Channel)	*
enabled	boolean	*
publicated_at	DateTime	*
visible	boolean	*
num_users	integer	*

Status Codes

Status Code	Description
200	Returned when successful

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channelstype

List all the channels type

Documentation
Sandbox

Documentation

Lists all Channel type.

Filters

Name

Information

limit

Description

Max number of records to be returned

offset

Description

Number of records to skip

Return

Parameter	Type	Versions	Description
200 - Returned when successful
id	integer	*
name	string	*
channels[]	array of objects (Channel)	*
channels[][id]	integer	*
channels[][name]	string	*
channels[][slug]	string	*
channels[][irc_channel]	string	*
channels[][description]	string	*
channels[][count_visits]	integer	*
channels[][owner]	object (User)	*
channels[][owner][id]	integer	*
channels[][owner][username]	string	*
channels[][owner][username_canonical]	string	*
channels[][owner][email]	string	*
channels[][owner][email_canonical]	string	*
channels[][owner][enabled]	boolean	*
channels[][owner][salt]	string	*	The salt to use for hashing.
channels[][owner][password]	string	*	Encrypted password. Must be persisted.
channels[][owner][last_login]	DateTime	*
channels[][owner][confirmation_token]	string	*	Random string sent to the user email address in order to verify it.
channels[][owner][password_requested_at]	DateTime	*
channels[][owner][roles]	array	*
channels[][owner][channels][]	array of objects (Channel)	*
channels[][owner][client]	object (Client)	*
channels[][owner][client][id]	integer	*
channels[][owner][client][random_id]	string	*
channels[][owner][client][secret]	string	*
channels[][owner][client][redirect_uris]	array	*
channels[][owner][client][allowed_grant_types]	array	*
channels[][owner][client][name]	string	*
channels[][owner][client][affiliate]	object (Affiliate)	*
channels[][owner][client][affiliate][id]	integer	*
channels[][owner][client][affiliate][name]	string	*
channels[][owner][client][affiliate][email]	string	*
channels[][owner][client][affiliate][phone]	string	*
channels[][owner][client][affiliate][address]	string	*
channels[][owner][client][affiliate][nif]	string	*
channels[][owner][client][affiliate][clients][]	array of objects (Client)	*
channels[][owner][client][affiliate][user]	object (User)	*
channels[][owner][client][confirmed_uri]	string	*
channels[][owner][client][resetting_url]	string	*
channels[][owner][client][brand_image_url]	string	*
channels[][owner][client][brand_facebook_url]	string	*
channels[][owner][client][brand_twitter_url]	string	*
channels[][owner][client][url_boilerplate]	string	*
channels[][owner][client][url_boilerplate_messages]	string	*
channels[][owner][client][users][]	array of objects (User)	*
channels[][owner][channels_fan][]	array of objects (Channel)	*
channels[][owner][profile]	object (Profile)	*
channels[][owner][profile][id]	integer	*
channels[][owner][profile][about]	string	*
channels[][owner][profile][seeking]	string	*
channels[][owner][profile][gender]	string	*
channels[][owner][profile][birthday]	DateTime	*
channels[][owner][profile][count_visits]	integer	*
channels[][owner][profile][you_want]	string	*
channels[][owner][profile][chat_on_line]	boolean	*
channels[][owner][deleted]	boolean	*
channels[][owner][created_at]	DateTime	*
channels[][owner][locked]	boolean	*
channels[][owner][ip]	string	*
channels[][owner][language]	string	*
channels[][owner][num_bounces]	integer	*
channels[][owner][global_statistic]	object (GlobalStatistic)	*
channels[][owner][global_statistic][subject]	object (User)	*
channels[][number_fans]	integer	*	TODO this column is calculated We can delete
channels[][fans][]	array of objects (User)	*
channels[][channel_type]	object (ChannelType)	*
channels[][channel_type][id]	integer	*
channels[][channel_type][name]	string	*
channels[][channel_type][channels][]	array of objects (Channel)	*
channels[][parent]	object (Channel)	*
channels[][channels][]	array of objects (Channel)	*
channels[][enabled]	boolean	*
channels[][publicated_at]	DateTime	*
channels[][language]	string	*
channels[][visible]	boolean	*
channels[][num_users]	integer	*
channels[][ircChannel]		*
channels[][publicatedAt]		*

Status Codes

Status Code	Description
200	Returned when successful

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}/channels

show array channels of an user

Documentation
Sandbox

Documentation

Show channels of an user

Requirements

Name	Requirement	Type	Description
id

Filters

Name

Information

enabled

Description

Filter just enabled (enabled=1) or disabled (enabled=0) channels

limit

Description

Max number of records to be returned

offset

Description

Number of records to skip

Status Codes

Status Code	Description
200	Returned when successfull
404	Unable to find User entity with code 32

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}/channelsFan

Show all channels fan of an user

Documentation
Sandbox

Documentation

Show all channels fan of an user

Requirements

Name	Requirement	Type	Description
id

Filters

Name

Information

limit

Description

Max number of records to be returned

offset

Description

Number of records to skip

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
200	Returned when successful
404	Unable to find User entity with code 32

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/users/{user_id}/channels/{channel_id}/fans

Remove me as a channel fan

Documentation
Sandbox

Documentation

Remove me as a channel fan

Requirements

Name	Requirement	Type	Description
user_id
channel_id

Return

Parameter	Type	Versions	Description
200 - New entity created

Status Codes

Status Code	Description
200	New entity created
404	Unable to find Channel entity with code 32

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/users/{user_id}/channels/{channel_id}/fans

Make me a channel fan

Documentation
Sandbox

Documentation

Make me a channel fan

Requirements

Name	Requirement	Type	Description
user_id
channel_id

Return

Parameter	Type	Versions	Description
200

Status Codes

Status Code	Description
201	New entity created
404	Unable to find Channel entity with code 32

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/users/{user}/channels/{channel}/photo.{_format}

Assing photo to channel

Documentation
Sandbox

Documentation

Insert a photo entity into channel

Requirements

Name	Requirement	Type	Description
_format	html\|json\|xml\|twig
user
channel

Parameters

Parameter	Type	Required?	Format	Description
photo_id	string	false

Return

Parameter	Type	Versions	Description
200 - photo inserted

Status Codes

Status Code	Description
200	photo inserted
400	Bad request

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

contact

POST /api/contact

send an email or suggestion

Documentation
Sandbox

Documentation

Send an email or suggestion.

Parameters

Parameter	Type	Required?
contact	object (ContactFormType)	true
contact[name]	string	false
contact[nick]	string	false
contact[email]	string	true
contact[reason]	string	false
contact[message]	string	true

Status Codes

Status Code	Description
204	Returned when successful
400	Data not valid

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

location

GET /geo/cities/{id}

show a city by id

Documentation
Sandbox

Documentation

Finds and displays a city location entity.

Requirements

Name	Requirement	Type	Description
id		int	the city location id

Parameters

Parameter	Type	Required?	Format	Description
locale	string	false		The local code for countries. [en\|es], default value en

Return

Parameter	Type	Versions	Description
200 - Returned when successful

Status Codes

Status Code	Description
200	Returned when successful
204	Return if entity city not exits
400	The parameter id Code is not set

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /geo/countries

Finds and displays all countries

Documentation
Sandbox

Documentation

Finds and displays all countries

Parameters

Parameter	Type	Required?	Format	Description
locale	string	false		The local code for countries. [en\|es], default value en

Status Codes

Status Code	Description
200	Returned when successful
204	If country list is empty

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /geo/countries/{countryCode}

Finds and displays a country by code

Documentation
Sandbox

Documentation

Finds and displays a country by code

Requirements

Name	Requirement	Type	Description
countryCode		string

Parameters

Parameter	Type	Required?	Format	Description
locale	string	false		The local code for countries. [en\|es], default value en

Status Codes

Status Code	Description
200	Returned when successful
204	Unable find entity country for country code
400	The parameter countryCode Code is not set

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

API documentation

POST /api/continue

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/continue_register

Documentation

Parameters

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/oauth/v2/revoke

Documentation

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/register

Documentation

Parameters

Return

200

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /resetting/send-email

Documentation

Filters

Return

200 - Returned when successful

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

channel

GET /api/channel/modes.{_format}

Documentation

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/channels.{_format}

Documentation

Requirements

Filters

Return

200 - Returned when successful

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/channels.{_format}

Documentation