JSON API » prefixes » prefixes/list

Gets the fields of all feature prefixes in the given customer.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
customerIntegerID of customer to get feature prefixes for.NoCustomer of authentication user.

Responses

PrefixDescription
200Success.
400Invalid customer specified.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

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

Example: With required parameters

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

{ "responses":[ { "prefix":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "prefix":"*12", ... }, { "id":2, "prefix":"123", ... } ] }

Change history

VersionChanges
3.13Function added.