JSON API » cos » cos/create

Creates a new class of service.

Input parameters

Requires authentication and the administrator role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName.Yes
customerIntegerID of customer to create in.NoCustomer of authentication user.
descriptionStringDescription.NoEmpty string.
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.No1
failureStringNumber to redirect to if call is forbidden. Empty string to play error message.NoEmpty string.
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.No1
timegroupIntegerID of time group. 0 for none.No0
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created class of service.

Example: With required parameters

http://enswitch.example.com/api/json/cos/create/?auth_username=user;auth_password=password;name=user1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

VersionChanges
3.13Function added.