VersaCloud API ′MethodRightValid′ Reference Documentation

Description

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

Parameters

The following table describes all of 'MethodRightValid''s parameters, in every language available.

ID: 1 - Name: Login

Language: English (United States)

Description: Operation handle returned from succesful call of UserLoginAllow

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: English (United States)

Description: Valid solution token identifying solution the method corresponds to

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

ID: 3 - Name: Method

Language: English (United States)

Description: Method to be verified if callable with a specific right

Type: method - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 4 - Name: Right

Language: English (United States)

Description: Right to be verified

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 obtenido de llamada exitosa a UserLoginAllow

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Español (moderno)

Description: Token de Solución válido identificando la solución a la cual el método pertenece

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

ID: 3 - Name: Method

Language: Español (moderno)

Description: Método a ser verificado si puede ser accionado con un derecho específico

Type: method - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 4 - Name: Right

Language: Español (moderno)

Description: Derecho a ser verificado

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 retornado por chamada bem sucedida a UserLoginAllow

Type: operationhandle - Min-Max Length: 48-48 - Reentr Key Member: No - Optional: No

ID: 2 - Name: SolutionToken

Language: Português (Brasil)

Description: Token de Solução válido identificando a solução à qual o método pertence

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

ID: 3 - Name: Method

Language: Português (Brasil)

Description: Método a ser verificado se pode ser acionado com um direito específico

Type: method - Min-Max Length: 8-32 - Reentr Key Member: No - Optional: No

ID: 4 - Name: Right

Language: Português (Brasil)

Description: Direito a ser verificado

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

---

Return Value

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

US Patent Requested