JSON API » classes » classes/create

Creates a new number class.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
callerid_location	Integer	1 to allow customers to use as location callerid, 0 not to.	No	0
customer	Integer	ID of customer to assign to. 0 for none.	No	0
description	String	Description.	No	Empty string.
ported	Integer	1 to put ported numbers in this class, 0 not to.	No	0
rank	Integer	1 to 10.	No	1
transaction_text_create	String	Text to show on transactions for creation.	No	Empty string.
transaction_text_period	String	Text to show on transactions each billing period.	No	Empty string.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

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

Data returned

The ID of the created number class.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.