JSON API » provisioning » provisioning/create

Creates a new provisioning template.

Input parameters

Requires authentication and the provisioning role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
name	String	Name.	Yes
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
lines_start	Integer	The number of the first line. 0, 1, or -1 for an absolute suffix.	No	1
model	String	The model, or empty string for any.	No	Empty string.
custom_name	String	Model name if provisioning a custom phone type.	No	Empty string.
priority	Integer	Priority from 1 to 10.	No	1
shared	Integer	1 to share with all customers on the system, 0 not to. Only has effect if system owner.	No	0
speeddials_maximum	Integer	The maximum number of speed dials.	No	1000
speeddials_start	Integer	The number of the first speed dial.	No	1
template1	String	The first, or only, provisioning template.	No	Empty string.
template2	String	The second provisioning template if used.	No	Empty string.
template_directory	String	The directory (speed dials) provisioning template if used.	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.
403	Your rate plan does not allow this.

Data returned

The ID of the created provisioning template.

Example: With required parameters

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

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

Change history

Version	Changes
3.14	custom_name input parameter added.
3.13	Function added.