Home Page
English (1.167)
VersaCloud (1.163)
VersaCloud API 'RightDocumentationShortGet' Reference Documentation
Description
The following table displays the documentation for the 'RightDocumentationShortGet' API in all languages currently available:
Language |
Documentation |
|---|---|
English (United States) |
Retrieves the short description of a specific VersaCloud right in a specific language |
Español (moderno) |
Recupera la breve descripción de un VersaCloud específica derecho en un idioma específico |
Português (Brasil) |
Recupera a breve descrição de uma VersaCloud específico direito em um idioma específico |
Parameters
The following table describes all of 'RightDocumentationShortGet''s parameters, in every language available.
ID |
Name |
Language |
Description |
Type |
Min-Max Length |
Reentr Key Member |
Optional |
|---|---|---|---|---|---|---|---|
1 |
Right |
English (United States) |
Right's two-letter signature |
2-2 |
No |
No |
|
2 |
Language |
English (United States) |
Language to be used to get rights' short description |
6-6 |
No |
No |
|
1 |
Right |
Español (moderno) |
Código del derecho cuya descripción corta se obtiene |
2-2 |
No |
No |
|
2 |
Language |
Español (moderno) |
Idioma a utilizar para obteber la descripción corta del derecho de usuario |
6-6 |
No |
No |
|
1 |
Right |
Português (Brasil) |
Assinatura do direito cuja descrição breve é retornada |
2-2 |
No |
No |
|
2 |
Language |
Português (Brasil) |
Idioma a ser usado para obter a descrição breve do direito de usuário |
6-6 |
No |
No |
Return Value
'RightDocumentationShortGet' returns a value of type string (minimum length of returned values is one character characters, while maximum length of returned values is 12 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 'RightDocumentationShortGet' API (generic errorcodes like wrong number of parameters or invalid values for parameters' types are not listed):
Errorcode |
Language |
Description |
|---|---|---|
:@Err#Rgt0000243 |
English (United States) |
Short user Right's description is not available in specified language |
:@Err#Rgt0000243 |
Español (moderno) |
La descripción resumida del Derecho de usuario no está disponible en el idioma especificado |
:@Err#Rgt0000243 |
Português (Brasil) |
A descrição resumida do Direito de usuário não está disponível no idioma especificado |
US Patent Requested
