Description
The following table displays the documentation for the 'SolutionDocumentationGet' API in all languages currently available:
Language |
Documentation |
---|---|
English (United States) |
Retrieves a specific solution's description |
Español (moderno) |
Recupera la descripción de una solución específica |
Português (Brasil) |
Recupera descrição de uma solução específica |
Parameters
The following table describes all of 'SolutionDocumentationGet''s parameters, in every language available.
ID: 1 - Name: SolutionName
Language: English (United States)
Description: Name of solution to have its description retrieved
Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Language
Language: English (United States)
Description: Specific human language to be used to retrieve the solution's description
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionName
Language: Español (moderno)
Description: Nombre de la solución cuya descripción desea obtener
Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Language
Language: Español (moderno)
Description: Idioma humano específico a ser utilizado para obtener la descripción de la solución
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
ID: 1 - Name: SolutionName
Language: Português (Brasil)
Description: Nome da solução cuja descrição deseja obter
Type: solution - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No
ID: 2 - Name: Language
Language: Português (Brasil)
Description: Língua humana específica a ser usada para obter a descrição da solução
Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No
---
Return Value
'SolutionDocumentationGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 256 characters characters).
Please note that all APIs returning values of types that allow for localized values (like e.g. boolean or country) always return the standard type values.
Specific Error Codes
If an error happens during the execution of any VersaCloud call, an errorcode is returned instead of the standard return value described above.
The following table lists errorcodes returned specifically by the 'SolutionDocumentationGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
---|---|---|
:@Err#Sol0000001 |
English (United States) |
Value provided as Solution is not registered with VersaCloud |
:@Err#Sol0000243 |
English (United States) |
Solution description not available in specified language |
:@Err#Sol0000001 |
Español (moderno) |
Valor informado como Solución no está registrado en VersaCloud |
:@Err#Sol0000243 |
Español (moderno) |
Descripción de la solución no está disponible en el idioma especificado |
:@Err#Sol0000001 |
Português (Brasil) |
Valor informado como Solução não está registrado em VersaCloud |
:@Err#Sol0000243 |
Português (Brasil) |
Descrição da solução não está disponível no idioma solicitado |
US Patent Requested