JSON API » outgroups » outgroups/times/update

Updates an existing 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
id	Integer	ID of outbound group time chunk to update.	Yes
days	String	Days time chunk is active. Monday = 1, Sunday = 7. For example, "12345" for Monday to Friday.	No	Current value.
description	String	Description.	No	Current value.
endhour	Integer	End hour from 0 to 23.	No	Current value.
endminute	Integer	End minute from 0 to 59.	No	Current value.
name	String	Name.	No	Current value.
priority	Integer	Priority from 0 to 5.	No	Current value.
starthour	Integer	Start hour from 0 to 23.	No	Current value.
startminute	Integer	Start minute from 0 to 59.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
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.
404	The outbound group time chunk does not exist.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/outgroups/times/update/?auth_username=user;auth_password=password;id=123;name=example

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.