Description

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

Language

Documentation

English (United States)

Requests to set a new language for user to communicate with VersaCloud platform (with User right, only for himself)

Español (moderno)

Las solicitudes para establecer un nuevo lenguaje para usuario comunicarse con la plataforma VersaCloud (con derecho de usuario, sólo para sí mismo)

Português (Brasil)

Solicitações para definir uma nova linguagem para o usuário se comunicar com plataforma VersaCloud (com direito de usuário, apenas para si mesmo)

Parameters

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

ID

Name

Language

Description

Type

Min-Max Length

Reentr Key Member

Optional

1

Login

English (United States)

Operation handle returned from succesful call of UserLoginAllow, identifying user requesting change

operationhandle

48-48

No

No

2

Email

English (United States)

E-mail address of user whose default language is being changed

email

7-128

Yes

No

3

LanguageCode

English (United States)

New language to be used by the VersaCloud platform to communicate with this user

language

6-6

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando al usuario que pide el cambio

operationhandle

48-48

No

No

2

Email

Español (moderno)

Dirección de correo electrónico del usuario cuyo idioma standard se está cambiando

email

7-128

Yes

No

3

LanguageCode

Español (moderno)

Nuevo idioma a ser utilizado por la plataforma VersaCloud para comunicarse con este usuario

language

6-6

No

No

1

Login

Português (Brasil)

Protocolo de operação retornado por chamada bem sucedida a UserLoginAllow, identificando o usuário que solicita a mudança

operationhandle

48-48

No

No

2

Email

Português (Brasil)

Endereço de e-mail do usuário cujo idioma default está sendo modificado

email

7-128

Yes

No

3

LanguageCode

Português (Brasil)

Novo idioma a ser usado pela plataforma VersaCloud para se comunicar com este usuário

language

6-6

No

No

Return Value

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

Errorcode

Language

Description

:@Err#Usr0000002

English (United States)

Value provided as user e-mail is not registered with VersaCloud

:@Err#Usr0000024

English (United States)

Specified user does not have the needed right to invoke this API

:@Err#Usr0000002

Español (moderno)

Valor informado como correo electrónico de usuario no está registrado en VersaCloud

:@Err#Usr0000024

Español (moderno)

Usuario informado no tiene los derechos necesarios para llamar esta API

:@Err#Usr0000002

Português (Brasil)

Valor informado como e-mail de usuário não está registrado em VersaCloud

:@Err#Usr0000024

Português (Brasil)

Usuário especificado não possui os direitos necessários para chamar esta API

US Patent Requested