JSON API » codes » codes/times/get
Gets the fields of a feature code time route.
Input parameters
Requires authentication and the administrator, user, or wholesale role privileges.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
code | String | Feature code. | Yes | |
timegroup | Integer | ID of time group. | Yes | |
customer | Integer | ID of customer owning feature code. | No | Customer of authentication user. |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The feature code or time route does not exist, or you do not have permission to view it. |
Data returned
Fields of feature code time route.
Example: With required parameters
http://enswitch.example.com/api/json/codes/times/get/?auth_username=user;auth_password=password;code=100;timegroup=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "code":"100", "timegroup":1, ... } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |