Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′UserLanguageGet′ Reference Documentation
Description
The following table displays the documentation for the 'UserLanguageGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves the current language used by VersaCloud to communicate with this user (with USer right, only own's user data) |
Español (moderno) |
Recupera el lenguaje actual utilizado por VersaCloud para comunicarse con este usuario (con derecho de usuario, sólo los datos de usuario de las propias) |
Português (Brasil) |
Recupera a língua usada por VersaCloud para se comunicar com este usuário (com direito de usuário, apenas os dados do usuário do próprio) |
Parameters
The following table describes all of 'UserLanguageGet''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 retrieving information
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 information is being retrieved
Type: email - Min-Max Length: 7-128 - 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 el usuario que toma la información
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 cuya información desea obtener
Type: email - Min-Max Length: 7-128 - 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 busca a informação
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 do qual deseja obter a informação
Type: email - Min-Max Length: 7-128 - Reentr Key Member: No - Optional: No
---
Return Value
'UserLanguageGet' returns a value of type language (minimum length of returned values is 6 characters characters, while maximum length of returned values is 6 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 'UserLanguageGet' 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
