Description

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

Language

Documentation

English (United States)

Verifies if user owns a specific right on the VersaCloud platform

Español (moderno)

Verifica si el usuario posee un derecho específico en la plataforma VersaCloud

Português (Brasil)

Verifica se o usuário é dono de um direito específico na plataforma VersaCloud

Parameters

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

operationhandle

48-48

No

No

2

Email

English (United States)

E-mail address identifying user to be validated for owning a specific right

email

7-128

No

No

3

Signature

English (United States)

Type of user right that will be verified if valid for indicated user

right

2-2

No

No

1

Login

Español (moderno)

Protocolo de operación resultante de llamada exitosa a UserLoginAllow

operationhandle

48-48

No

No

2

Email

Español (moderno)

Dirección de correo electrónico del usuario a ser verificado como titular de un derecho específico

email

7-128

No

No

3

Signature

Español (moderno)

Tipo de derecho de usuario que será validado como disponible para el usuario especificado

right

2-2

No

No

1

Login

Português (Brasil)

Protocolo de operação resultante de chamada bem sucedida a UserLoginAllow

operationhandle

48-48

No

No

2

Email

Português (Brasil)

Endereço de e-mail identificando o usuário a ser validado como titular de um direito específico

email

7-128

No

No

3

Signature

Português (Brasil)

Tipo de direito de usuário que será verificado como sendo válido para o usuário indicado

right

2-2

No

No

Return Value

'UserRightValid' returns a value of type boolean (minimum length of returned values is 4 characters characters, while maximum length of returned values is 5 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 'UserRightValid' 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