JSON API » plans » plans/routes/import

Imports rate plan routes from a CSV file.

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
csv	String	The contents of the CSV file.	Yes
plan	Integer	ID of rate plan to import into.	Yes
delete	Integer	1 to delete all routes in rate plan first, 0 not to.	No	0
overwrite	Integer	1 to allow overwriting of existing routes, 0 not to.	No	0

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.
500	An internal error occurred. Check the key and message fields for more details.

Data returned

The number of routes imported.

Example: With required parameters (csv field omitted for brevity)

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }

Change history

Version	Changes
3.13	Function added.