JSON API » cos » cos/outroutes/update

Updates an existing class of service exception.

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.	Yes
type	String	"internal" or "external".	Yes
prefix	String	Prefix of exception.	Yes
allow	Integer	Whether to allow calls. 0 to forbid, 1 to allow, 2 to allow if time group is active, 3 to allow if timegroup is not active.	Yes

Responses

Code	Description
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 role does not allow this.
404	The class of service or exception does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/cos/outroutes/update/?auth_username=user;auth_password=password;id=123;type=external;prefix=011;allow=1

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

Change history

Version	Changes
3.13	Function added.