NGOAddKeywords

This call is used to add new Keywords to the System. Only Keywords of a particular type, authorized or Unauthorized can be added at a time. Authorized Keywords cannot be deleted from the System whereas unauthorized Keywords can be deleted from the System.

 

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.

NGOAddKeywords

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect 

Cabinet call.

 

N/A

GroupIndex

Root

User can send a default value for it.

 

0

Authorization

Flag

Root

Flag that specifies whether the given Keyword can be deleted.

A - Authorized and cannot be deleted.

U – Unauthorized and can be deleted.

U

Keywords

Root

Specifies the List of Keywords that is to be added.

 

N/A

KeywordProperty

Keywords

Parent tag for keyword which are to be added

 

N/A

Keyword

KeywordKeywordsProperty

Specifies the Name of the Keyword that is to be added.

 

N/A

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

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

NoOfKeywords

Root

Specifies the number of Keywords that are added.

Keywords

Root

Specifies the List of Keywords that is added, providing the complete information about all the added Keywords.

KeywordProperty

Keywords

Parent tag for keyword which are added 

KeywordIndex

KeywordProperty

Specifies the Index of the added Keyword.

Keyword

KeywordProperty

Specifies the Name of the added Keyword.

GroupIndex 

KeywordProperty 

The keyword returned is associated with this Group Index 

AuthorizationFlag

KeywordProperty

Specifies whether the Keyword that was added can be deleted.

A - Authorized to be deleted.

U - Unauthorized to be deleted.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

The value for some input parameter is not correct or is invalid.

-50041

Keyword(s) with the same name already exist

Some Keywords with the same Name must be already be present.

-50040

All keyword index already exist

All the specified Keywords are already there in the System.