/
case_get_preference ()

case_get_preference ()

Owned by Pedro Jose Sanchez Luling, created
Last updated: Jul 12, 2022
2 min read

Function prototype

case_get_preference(session, case, parameter, [scope = "USER"], [scope_ref])

API Version

2.7.20 and higher

Returns the value of a specific preference of a CASE.

This function only returns a value if the active session user has privileges to view the profile of the CASE

Input parameters:

  • session: is the session token obtained in the session_init ()  call

  • case: Reference of the CASE

  • parameter: name of the preference.

  • scope: defines in which scope the preference is used. Possible values are:

    • “USER”: Preference assigned to the USER

    • “PROGRAM”: Preference that is applicable only in the context of a PROGRAM OBJECT .

    • “APPLICATION”: Preference stored by an client application. For example it may be used to store preferences of the user about how to sort tables, colors of the interface, or any other setting that may affect the behavior of the client application

  • scope_ref: When the scope is different than “USER”, it is necessary to indicate the reference of the scope. For example, when defining a preference of a PROGRAM, then it is necessary to indicate the reference of the PROGRAM.

Output parameters:

  • result: value of the preference

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request sample:

case_get_preference ( “LCAAAAAAAAAAAA”, 21253, "MY_PREF", "PROGRAM", "323" );

Response sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result>343</result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>





Return Error codes

ERROR CODE



ERROR CODE



INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the preferences of the CASE

CASE.NOT_FOUND

The specified CASE was not found



Related content