VersaCloud API ′UserRightValid′ Reference Documentation

Description

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

Parameters

The following table describes all of 'UserRightValid''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 collecting 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 identifying user to be validated for owning a specific right

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

ID: 3 - Name: Signature

Language: English (United States)

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

Type: right - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación resultante de llamada exitosa a UserLoginAllow

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 a ser verificado como titular de un derecho específico

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

ID: 3 - Name: Signature

Language: Español (moderno)

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

Type: right - Min-Max Length: 2-2 - Reentr Key Member: No - Optional: No

ID: 1 - Name: Login

Language: Português (Brasil)

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

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 identificando o usuário a ser validado como titular de um direito específico

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

ID: 3 - Name: Signature

Language: Português (Brasil)

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

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

US Patent Requested