VersaCloud API ′UserLanguageSetAllow′ Reference Documentation

Description

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

Parameters

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

ID: 1 - Name: Login

Language: English (United States)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Email

Language: English (United States)

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

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: LanguageCode

Language: English (United States)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Español (moderno)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Email

Language: Español (moderno)

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

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: LanguageCode

Language: Español (moderno)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Português (Brasil)

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

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: Email

Language: Português (Brasil)

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

Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No

ID: 3 - Name: LanguageCode

Language: Português (Brasil)

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

Type: language - Min-Max Length: 6-6 - Reentr Key Member: No - Optional: 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):

US Patent Requested