JSON API » cos » cos/update

Updates an existing class of service.

Input parameters

Requires authentication and the administrator role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of class of service to update.	Yes
description	String	Description.	No	Current value.
external_out	Integer	Whether to allow external calls by default. 0 to forbid, 1 to allow, 2 to allow if time group is active, 3 to allow if timegroup is not active.	No	Current value.
failure	String	Number to redirect to if call is forbidden. Empty string to play error message.	No	Current value.
internal_out	Integer	Whether to allow internal calls by default. 0 to forbid, 1 to allow, 2 to allow if time group is active, 3 to allow if time group is not active.	No	Current value.
name	String	Name.	No	Current value.
shared	Integer	1 to share with all customers on the system, 0 not to. Only has effect if system owner.	No	Current value.
timegroup	Integer	ID of time group. 0 for none.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The class of service does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/cos/update/?auth_username=user;auth_password=password;id=123;name=example

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.0	shared input parameter added.
3.13	Function added.