NGOUserSQLEx

This call is used to perform Select operation on the userUser-defined tablesTables.

 

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.

NGOUserSQLEx

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

Query

Root

Specifies the query  that is to be performed on some User defined tTable. Only Select operation is allowed in it.Query can be like “Select columnname1, columnname2 from tableName1,tableName2 where condition”. The query can have nested where clauses.

 

N/A

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

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

Columns

Root

It specifies the information about all the columns on which the required operation was performed.

Column

Columns

It specifies the complete information about a particular row Column i.e. its name, type, length on which the required operation was performed.

Name

Column

Name of the column.

Type

Column

Type of the colume like int, smallint, varchar etc.

Length

Column

Length of that particular column e.g. for int it is 11, for smallint it is 6, for varchar it is 255.

Rows

Root

It is representing a single row from the result set.

Row

Rows

It is representing a single field in that particular row.This field will correpond to a column name specified above.

Value

Row

This value corresponds to value of that particular field(specified in row) in that particular column(specified in column).

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

The value for some input parameter is not correct or is invalid. This exception may come when the TableName is null or Operation tag contains some value other than the valid values or is null.

In case of Select, the exception may come when ColumnList tag is null or ValueLists tag is not null

-50182

Table does not exist.

The table Table on which the specified operation is to be performed does not exist.