JSON API » prefixes » prefixes/get

Gets the fields of a feature prefix.

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
id	String	ID of feature prefix to get.	Yes

Responses

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

Data returned

Fields of feature prefix.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.