Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetDictionaryInfo

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDictionaryInfo

 

Gets detailed information for the keyword dictionary. Keyword dictionary can be located either by ByDictionaryID or by ByDictionaryTypeNo.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDictionaryInfo

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ ByDictionaryID

xs:int

nillable

Sets the dictionary id to add a new keyword. Either ByDictionaryID or ByDictionaryTypeNo must be specified (set to not nil, absent or 0(zero)). If both are specified, the ByDictionaryID will be taken into account.

â–¡ ByDictionaryTypeNo

xs:int

nillable

Sets the dictionary type number to add a new keyword. Either ByDictionaryTypeNo or ByDictionaryID must be specified (set to not nil, absent or 0(zero)).

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetDictionaryInfoResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Dictionary

 

nillable

Gets the keyword dictionary data.

â–  FolderNo

xs:int

 

Gets the folder number of the keyword dictionary.

â–¡ Items

 

nillable

Gets the list of keywords for the keyword dictionary.

≡ WSKeyword

 

list nillable


â–  ID

xs:int

 

Gets the identity of the keyword.

â–  IsDeactivated

xs:boolean

 

Returns true if the keyword is deactivated.

â–¡ Name

xs:string

nillable

Gets the name of the keyword.

â–¡ AvailableLCIDs

 

nillable

Gets list of LCIDs of all the translations available for the keyword.

≡ LCID

xs:int

list


â–  CurrentLCID

xs:int

 

Gets current LCID.

â–  KeywordDictionaryNo

xs:int

 

Gets the number of the keyword dictionary.

â–  MultiTypeNo

xs:int

 

Gets the multi type number of the keyword dictionary.

â–¡ Name

xs:string

nillable

Gets the name of the keyword dictionary.

â–  SingleTypeNo

xs:int

 

Gets the single type number of the keyword dictionary.

â–¡ TableName

xs:string

nillable

Gets the table name of the dictionary.

â–¡ TableNameMultiKeyword

xs:string

nillable

Gets the 'multi keyword' table name of the dictionary.

â–¡ AvailableLCIDs

 

nillable

Gets list of LCIDs of all the translations available for the keyword dictionary.

≡ LCID

xs:int

list


 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.