Delete Form

 

Function Name: getDeleteFormXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to retrieve the list of Forms.

 

Input Parameters                                                      Sample InputXML

Output Parameters                                                   Sample OutputXML

View xml API::NGODeleteForm

 

Prototype:

public String getDeleteFormXml (String cabinetName, String userDBId,

                                                            String currentDate, String flag, String objectIndex);

 

Input Parameters:

 

Name

Description

Valid Values

Default Behavior

CabinetName

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

 

 

UserDBId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

 

currentDate

Current Date and Time at which the call is made.

 

Current Date Time

flag

Flag  that specifies whether the call is made for a particular Form or for all the Forms that are registered for a particular DataDefinition.

F – Form

D – Data Definition

N/A

objectIndex

It specifies the Index of the object on which the call is made. If the call is made for a particular Form i.e. F is sent in the Flag tag, then it specifies the Form Index, otherwise if the call is made to delete all the Forms that are registered for a particular Data Definition i.e. D is sent in the Flag tag, then it specifies the Index of the Data Definition.

 

N/A

 

Output Parameters:

 

An inputXml string of the NGODeleteForm call.