JSON API » outgroups » outgroups/times/create

Creates a new outbound group time chunk.

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
outgroup	Integer	ID number of outbound group.	Yes
name	String	Name.	Yes
days	String	Days time chunk is active. Monday = 1, Sunday = 7. For example, "12345" for Monday to Friday.	No	"1234567"
description	String	Description.	No	Empty string.
endhour	Integer	End hour from 0 to 23.	No	23
endminute	Integer	End minute from 0 to 59.	No	59
priority	Integer	Priority from 0 to 5.	No	1
starthour	Integer	Start hour from 0 to 23.	No	0
startminute	Integer	Start minute from 0 to 59.	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.

Data returned

The ID of the created outbound group time chunk.

Example: With required parameters

http://enswitch.example.com/api/json/outgroups/times/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.