VersaCloud API ′UserRightUntilSetAllow′ Reference Documentation

Description

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

Parameters

The following table describes all of 'UserRightUntilSetAllow''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 requesting change

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 maximum operation date with specific right is being changed

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

ID: 3 - Name: Right

Language: English (United States)

Description: Right whose final assignment date is to be modified

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

ID: 4 - Name: Until

Language: English (United States)

Description: Latest moment in time at which user will be able to use specific right on the VersaCloud platform

Type: timestamp - Min-Max Length: 10-24 - 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 al usuario que hace el pedido

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 fecha máxima de operación con un derecho específico se está cambiando

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

ID: 3 - Name: Right

Language: Español (moderno)

Description: Derecho cuya fecha final de atribución debe ser cambiada

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

ID: 4 - Name: Until

Language: Español (moderno)

Description: Último instante de tiempo em el cual el usuario podrá usar un derecho específico em la plataforma VersaCloud

Type: timestamp - Min-Max Length: 10-24 - 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 usuário que faz o pedido

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 cuja data máxima de operação com direito específico está sendo modificada

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

ID: 3 - Name: Right

Language: Português (Brasil)

Description: Direito cuja data final de atribuição deve ser modificada

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

ID: 4 - Name: Until

Language: Português (Brasil)

Description: Último instante no tempo no qual o usuário poderá usar um direito específico na plataforma VersaCloud

Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No

---

Return Value

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

US Patent Requested