JSON API » plans » plans/routes/get

Gets the fields of a rate plan route.

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.	Yes
prefix	String	Prefix of route to get.	Yes
media	String	Media type of route to get. "fax", "voice", or "voice_fax".	No	"voice_fax"
prefix_media	String	For internal use only.	No	Empty string.

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The rate plan route does not exist, or you do not have permission to view it.

Data returned

Fields of rate plan route.

Example: With required parameters

http://enswitch.example.com/api/json/plans/routes/get/?auth_username=user;auth_password=password;plan=2;prefix=011

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "plan":2, "prefix":"011", ... } }

Change history

Version	Changes
3.13	Function added.