NGOProcessRoutes

This call is used to process local routes. A User can add, delete or modify routes. It takes CabinetName, UserDBId, RouteName and ProcessType as input and performs the operation as indicated by the ProcessType and returns the status for the call.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call	NGOProcess Routes	N/A
CabinetName	Root	Name of the cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which is returned in the NGOConnectCabinet call.		N/A
ProcessType	Root	Indicates whether the specified route is to be Added, Modified or Deleted.	A – Add Route M – Modify Route D – Delete Route	N/A
RouteName	Root	Name of the Route.
RouteInfo	Root	Info of the specified route.

Output Parameters description

Name	Parent Tag	Description
Option	Root	NGOProcessRoutes
Status	Root	Status of the call. If the Status is 0, then the call is successful.

Errors returned from call

Code	Message	Comments
-50074	Invalid parameters.	If the ProcessType is not among ‘A’, ‘M’ or ‘D’ or if the RouteName parameter is empty.
-50146	Invalid session.	Session corresponding to the UserDBId sent in the call is invalid.
-50006	User account has expired.	The account of the user has expired.
-50010	User not alive.	The user is not alive.
-50125	Cabinet has been locked for Administrative purposes.	The Cabinet has been locked by some user for Administrative purposes.
-50186	Route already exists.	If the user wants to add a route and a route with the given name already exists.
-50187	Route not found.	If the user wants to modify a route and the given route is not found.
-50188	No routes defined for user.	If the user wants to delete a route and the specified route does not exist.