VersaCloud API ′UserRightAddAllow′ Reference Documentation

Description

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

Parameters

The following table describes all of 'UserRightAddAllow''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 trying to grant new rights

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 who will be assigned a new right

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

ID: 3 - Name: Signature

Language: English (United States)

Description: Type of user right that the logged user will concede

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

ID: 1 - Name: Login

Language: Español (moderno)

Description: Protocolo de operación resultante de llamada exitosa a UserLoginAllow, identificando al usuario que intenta conceder nuevos derechos

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 que recibirá un nuevo derecho

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

ID: 3 - Name: Signature

Language: Español (moderno)

Description: Tipo de derecho de usuario que el usuario conectado desea conceder

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

ID: 1 - Name: Login

Language: Português (Brasil)

Description: Protocolo de operação resultante de chamada bem sucedida a UserLoginAllow, identificando o usuário que intenta conceder novos direitos

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 ao qual será atribuído um novo direito

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

ID: 3 - Name: Signature

Language: Português (Brasil)

Description: Tipo de direito de usuário que o usuário logado deseja conceder

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

---

Return Value

'UserRightAddAllow' 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 'UserRightAddAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):

US Patent Requested