NGOGetRoutesInfo

This call returns the route information for the login user for given route names.

 

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

Info

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

RouteNames

Root

Contains route names defined for the ActionItem.

 

N/A

RouteName

Route

Names

Name of the route.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOGetRoutesInfoUnique Option for the Call.

Status

Root

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

Routes

Root

Contains the information about the given routes.

RouteInfo

Routes

Route info of a particular route.

NoOfRecordsFetched

Root

Numbers of records returned.

TotalNoOfRecords

Root

Total number of records existing corresponding to the given criteria.

 

Errors returned from call

Code

Message

Comments

-50188

No routes defined for user.

There are no routes defined for the logged-in user.

-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.