JSON API » ingroups » ingroups/times/create

Creates a new inbound group time chunk.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
ingroupIntegerID number of inbound group.Yes
nameStringName.Yes
daysStringDays time chunk is active. Monday = 1, Sunday = 7. For example, "12345" for Monday to Friday.No"1234567"
descriptionStringDescription.NoEmpty string.
endhourIntegerEnd hour from 0 to 23.No23
endminuteIntegerEnd minute from 0 to 59.No59
priorityIntegerPriority from 0 to 5.No1
starthourIntegerStart hour from 0 to 23.No0
startminuteIntegerStart minute from 0 to 59.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.

Data returned

The ID of the created inbound group time chunk.

Example: With required parameters

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

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

Change history

VersionChanges
3.13Function added.