JSON API » ingroups » ingroups/times/update

Updates an existing inbound group time chunk.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of inbound group time chunk to update.Yes
daysStringDays time chunk is active. Monday = 1, Sunday = 7. For example, "12345" for Monday to Friday.NoCurrent value.
descriptionStringDescription.NoCurrent value.
endhourIntegerEnd hour from 0 to 23.NoCurrent value.
endminuteIntegerEnd minute from 0 to 59.NoCurrent value.
nameStringName.NoCurrent value.
priorityIntegerPriority from 0 to 5.NoCurrent value.
starthourIntegerStart hour from 0 to 23.NoCurrent value.
startminuteIntegerStart minute from 0 to 59.NoCurrent value.
validationInteger1 to validate input then return, 0 for full action.No0

Responses

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

Data returned

No data is returned.

Example: Changing the name

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

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

Change history

VersionChanges
3.13Function added.