JSON API » routes » routes/get

Gets the fields of a route.

Input parameters

Requires authentication and the system or top lists role privileges.

Name	Type	Description	Required	Default value
id	Integer	ID of route to get.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The route does not exist.

Data returned

Fields of route.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "called_prefix":"012", ... } }

Change history

Version	Changes
3.13	Function added.