JSON API » customs » customs/list

Gets array of fields of all custom settings in given rate plan.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
plan	Integer	ID of rate plan to get custom settings for.	Yes, unless available is specified.
available	Integer	1 to return the names of all possible custom settings, 0 to use rate plan.	No	0

Specify plan or available, not both.

Responses

Code	Description
200	Success.
400	Invalid rate plan specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the customs_* tables in the database.

Example: With rate plan

http://enswitch.example.com/api/json/customs/list/?auth_username=user;auth_password=password;plan=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "plan":1, "name":"footer_text", ... }, { "plan":2, "name":"footer_url", ... } ] }

Change history

Version	Changes
3.13	Function added.