JSON API » cos » cos/update

Updates an existing class of service.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of class of service to update.Yes
descriptionStringDescription.NoCurrent value.
external_outIntegerWhether 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.NoCurrent value.
failureStringNumber to redirect to if call is forbidden. Empty string to play error message.NoCurrent value.
internal_outIntegerWhether 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.NoCurrent value.
nameStringName.NoCurrent value.
timegroupIntegerID of time group. 0 for none.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The 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

VersionChanges
3.13Function added.