NGOGetRoutesList

This transaction fetches the list of all local routes defined by the logged-in user. It takes CabinetName and UserDBId as input and returns the status and names of the various routes defined for the logged-in user.

 

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

NGOGetRoutes

List

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


Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOGetRoutesListUnique Option for the Call.

Status

Root

Status of the call. If the Status is 0, then the call is successful.

Routes

Root

Contains all the route names defined for the logged-in user.

RouteName

Routes

Name of the route.

 

Errors returned from call

Code

Message

Comments

-50146

Invalid session.

Session corresponding to the UserDBId sent in the call is invalid.

-50006

User account has expired.

The user’s account 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.