Description

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

Language

Documentation

English (United States)

Retrieves the current country user resides in (with USer right, only own's user data)

Español (moderno)

Recupera el usuario actual del país reside en (con derecho de usuario, sólo los datos de usuario de las propias)

Português (Brasil)

Recupera o usuário país atual reside (com direito de usuário, apenas os dados do usuário do próprio)

Parameters

The following table describes all of 'UserCountryGet''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 retrieving information

operationhandle

48-48

No

No

2

Email

English (United States)

E-mail address of user whose information is being retrieved

email

7-128

No

No

1

Login

Español (moderno)

Protocolo de operación obtenido de llamada exitosa a UserLoginAllow, identificando el usuario que toma la información

operationhandle

48-48

No

No

2

Email

Español (moderno)

Dirección de correo electrónico del usuario cuya información desea obtener

email

7-128

No

No

1

Login

Português (Brasil)

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

operationhandle

48-48

No

No

2

Email

Português (Brasil)

Endereço de e-mail do usuário do qual deseja obter a informação

email

7-128

No

No

Return Value

'UserCountryGet' returns a value of type country (minimum length of returned values is 2 characters characters, while maximum length of returned values is 2 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 'UserCountryGet' 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