NGOUserSQL

This call is used to perform the basic operations like Insert, Delete, Modify, Select 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.

NGOUserSQL

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

Operation

Root

Specifies the type of operation that is to be performed on some User defined tTable.

I – Insert

D – Delete

M – Modify

S – Select

N/A

TableName

Root

Name of the Ttable on which the above operation is to be performed.

 

N/A

ColumnList

Root

List of fields Fields in the table Table on which the above operation is to be performed.

 

N/A

ValueLists

Root

It contains the list List of one or more set of values for the Ffields listed above using which the above mentioned operation like Insert or Modify is to be performed.

 

 

ValueList

ValueLists

It contains one set of values for the fields i.e. the information regarding one record Record set Set that is to be inserted or modified.

 

 

Value

ValueList

It specifies the value of a field. The field values are specified in the order in which they are listed in the ColumnList tag.

 

 

WhereCriterion

Root

It specifies the list of conditions that are to be applied when performing the above mentioned operation. The conditions may joined by particular operators like ‘AND’ or ‘OR’ etc.

 

 

WhereCriteria

Where

Criterion

It specifies a particular condition that is to be applied while performing the above mentioned operation.

 

 

Expression1

Where

Criteria

It specifies the left hand side expression of the condition that is to be applied while performing the above mentioned operation.

 

 

Operator

Where

Criteria

It specifies the operator like =, <, >, >=, <=, like, etc. that is to be used in the condition .All operators supported by SQL queries can be used here.

 

 

Expression2

Where

Criteria

It specifies the right hand side expression of the condition that is to be applied while performing the above mentioned operation.

 

 

JoinCondition

Where

Criterion

The condition by which two or more criterion may be joined using operators like ‘AND’ or ‘OR’. All operators supported by SQL queries can be used here.

 

 

 

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.

Rows

Root

It specifies the information about all the rows and their fields and their values on which the required operation was performed.

Row

Rows

It specifies the complete information about a particular row Row and its fields and their values on which the required operation was performed.

It shows the fields and their values as:

<FieldName>Value1</FieldName>

<FieldName>Value2</FieldName>

<FieldName>Value3</FieldName>

 

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 Insert, the exception may come when ColumnList tag is null or ValueLists tag is null or WhereCriterion tag is not null

 

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

 

In case of Delete, the exception may come when ColumnList tag is not null or ValueLists tag is not 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.