JSON API » plans » plans/routes/import

Imports rate plan routes from a CSV file.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
csvStringThe contents of the CSV file.Yes
planIntegerID of rate plan to import into.Yes
deleteInteger1 to delete all routes in rate plan first, 0 not to.No0
overwriteInteger1 to allow overwriting of existing routes, 0 not to.No0

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
500An 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

VersionChanges
3.13Function added.