JSON API » timegroups » timegroups/periods/list

Gets the fields of all time periods in a given 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
timegroup	Integer	ID of time group to get time periods for.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The time group does not exist, or you do not have permission to view it.

Data returned

An array of fields, corresponding to the rows of the time_periods table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/timegroups/periods/list/?auth_username=user;auth_password=password;timegroup=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.