Therefore Web API Programming Interface 1.0

GetDictionaryInfo

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	optional 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	optional 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		optional nillable	Gets the keyword dictionary data.
■ FolderNo	xs:int	optional	Gets the folder number of the keyword dictionary.
□ Items		optional nillable	Gets the list of keywords for the keyword dictionary.
≡ WSKeyword		optional unbounded nillable
■ ID	xs:int	optional	Gets the identity of the keyword.
■ IsDeactivated	xs:boolean	optional	Returns true if the keyword is deactivated.
□ Name	xs:string	optional nillable	Gets the name of the keyword.
□ AvailableLCIDs		optional nillable	Gets list of LCIDs of all the translations available for the keyword.
≡ LCID	xs:int	optional unbounded
■ CurrentLCID	xs:int	optional	Gets current LCID.
■ KeywordDictionaryNo	xs:int	optional	Gets the number of the keyword dictionary.
■ MultiTypeNo	xs:int	optional	Gets the multi type number of the keyword dictionary.
□ Name	xs:string	optional nillable	Gets the name of the keyword dictionary.
■ SingleTypeNo	xs:int	optional	Gets the single type number of the keyword dictionary.
□ TableName	xs:string	optional nillable	Gets the table name of the dictionary.
□ TableNameMultiKeyword	xs:string	optional nillable	Gets the 'multi keyword' table name of the dictionary.
□ AvailableLCIDs		optional nillable	Gets list of LCIDs of all the translations available for the keyword dictionary.
≡ LCID	xs:int	optional unbounded

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.