Home Page
English (1.186)
VersaCloud (1.163)
VersaCloud API ′UserUntilSetAllow′ Reference Documentation
Description
The following table displays the documentation for the 'UserUntilSetAllow' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Requests to set a new maximum data for user to operate on the VersaCloud platform (with User right, only for himself) |
Español (moderno) |
Las solicitudes para establecer un nuevo máximo para los datos del usuario para operar en la plataforma VersaCloud (con derecho de usuario, sólo para sí mismo) |
Português (Brasil) |
Solicitações para definir um novo máximo de dados para o usuário a operar na plataforma VersaCloud (com direito de usuário, apenas para si mesmo) |
Parameters
The following table describes all of 'UserUntilSetAllow''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 is being changed
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Until
Language: English (United States)
Description: Latest moment in time at which user will be able to login onto 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 se está cambiando
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Until
Language: Español (moderno)
Description: Último instante de tiempo en el cual el usuario podrá conectarse a 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 está sendo modificada
Type: email - Min-Max Length: 7-128 - Reentr Key Member: Yes - Optional: No
ID: 3 - Name: Until
Language: Português (Brasil)
Description: Último instante no tempo no qual o usuário poderá se logar na plataforma VersaCloud
Type: timestamp - Min-Max Length: 10-24 - Reentr Key Member: No - Optional: No
---
Return Value
'UserUntilSetAllow' 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 'UserUntilSetAllow' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Tim0000002 |
English (United States) |
Maximum date/time allowed cannot be already in the past |
:@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#Tim0000002 |
Español (moderno) |
Data/hora máxima permitida no puede ser un instante que ya esté en el pasado |
:@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#Tim0000002 |
Português (Brasil) |
Data/hora máxima permitida não pode ser um instante que já esteja no passado |
:@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
