Description

The following table displays the documentation for the 'TypeDocumentationGet' API in all languages currently available:

Language

Documentation

English (United States)

Retrieves a specific type's description in a specific language

Español (moderno)

Recupera la descripción de un tipo específico en un idioma específico

Português (Brasil)

Recupera a descrição de um tipo específico em um idioma específico

Parameters

The following table describes all of 'TypeDocumentationGet''s parameters, in every language available.

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

TypeName

English (United States)

String containing the type name to have its description retrieved

type

3-24

No

No

2

LanguageCode

English (United States)

Language to be used to retrieve the type's description

language

6-6

No

No

1

TypeName

Español (moderno)

Secuencia de caracteres conteniendo el nombre del tipo cuya descripción desea obtener

type

3-24

No

No

2

LanguageCode

Español (moderno)

Idioma a ser utilizado para obtener la descripción del tipo

language

6-6

No

No

1

TypeName

Português (Brasil)

Sequencia de caracteres contendo o nome do tipo cuja descrição deseja obter

type

3-24

No

No

2

LanguageCode

Português (Brasil)

Idioma a ser usado para obter a descrição do tipo

language

6-6

No

No

Return Value

'TypeDocumentationGet' returns a value of type string (minimum length of returned values is 3 characters 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 'TypeDocumentationGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

Errorcode

Language

Description

:@Err#Typ0000243

English (United States)

Type description is not available in the requested language

:@Err#Typ0000243

Español (moderno)

La descripción del tipo no está disponible en el idioma especificado

:@Err#Typ0000243

Português (Brasil)

A descrição do tipo não está disponível no idioma solicitado

US Patent Requested