JSON API » timegroups » timegroups/create

Creates a new time group.

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
name	String	Name.	Yes
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
active	Integer	1 if time group is active when any time period is active, 0 if time group is active when no time periods are active.	No	1
description	String	Description.	No	Empty string.
priority	Integer	Priority from 1 to 10.	No	1
shared	Integer	1 to share with all customers recursively, 0 not to. Only has effect with commerce role privilege.	No	0
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 time group.

Example: With required parameters

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

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

Change history

Version	Changes
4.1	shared input parameter changed to mean customers recursively.
3.13	Function added.