{"type":"doc","content":[{"type":"table","attrs":{"layout":"default","localId":"8c19e6bc-e4a5-4fd5-b7fa-d3dfda90fe39"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[528.0]},"content":[{"type":"paragraph","content":[{"text":"user_get_preferences (session, [case])","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[152.0]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[528.0]},"content":[{"type":"paragraph","content":[{"text":"2.7.8 and higher","type":"text"}]}]}]}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{"_parentId":{"value":"2501181483"}},"macroMetadata":{"macroId":{"value":"1763132b-925c-4309-874f-8db3d3c2160b"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"09bcec7d-0c28-4fc9-bc36-62029640bd7f"},"content":[{"type":"paragraph","content":[{"text":"Returns the list of preferences of the CASE","type":"text"}]}]},{"type":"table","attrs":{"layout":"default","localId":"41dea7fa-a837-4c95-be12-6dde3322d789"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Changes respect to previous version","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"2.7.25","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Notification channels preferences are not divided in \"events\" and \"tasks\". From version 2.7.25 there is a single \"channels\" property to indicate the preferred communication channels for receiving notifications.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"Changes in version 2.7.25","type":"text","marks":[{"type":"link","attrs":{"href":"#CHANGES_2_7_25"}}]},{"text":" for more details","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"0.0.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[618.0]},"content":[{"type":"paragraph","content":[{"text":"Initial version","type":"text"}]}]}]}]},{"type":"table","attrs":{"layout":"default","localId":"21f70625-bf9e-451c-83b6-7e1341387bef"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[145.0,535.0]},"content":[{"type":"paragraph","content":[{"text":"Detailed explanation of the function","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Input parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[535.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"session","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the session token obtained in the ","type":"text"},{"text":"session_init()","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/524509"}}]},{"text":" call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"case","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Reference of the CASE. By default the function will use the session’s CASE unless a different one is specified.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Output parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[535.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result/preferences","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML with the preferences of the USER","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"editable","type":"text","marks":[{"type":"strong"}]},{"text":": (true/false) Indicates if the active SESSION’s USER has privileges to modify the preferences of the CASE","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"form_merge","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (true/false) If true, the TASKS with more than one FORM will be treated as if they had only one FORM with all the ITEMS merged","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"map_service","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Information about the preferred map service for displaying geographic information","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"code","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Code of the map service provider. See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/767885317"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Description of the map service provider","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"notifications","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Preferences of the USER about the channels of communication used to send notifications generated by the system.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"channels","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": comma separated string indicating the channels enabled for sending notifications about TASKs and EVENTs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"event_priority","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Used to filter by priority the EVENTs that should send a notification. Possible values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“all”: Send notifications about all EVENT","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“flagged“: Send only notifications of flagged EVENTs (with a priority different than 0)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Minimum time to receive notifications about pending TASKS when the TASK is not scheduled for a specific time (can be done at any time of the day). The expected format is 'hh:mm:ss'. ","type":"text"},{"text":"Introduced in API version 2.7.25","type":"text","marks":[{"type":"strong"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"preference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Name of the preference. It is possible to add new preferences using ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/2502492298"}},{"text":" or ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/2061238322"}},{"text":". ","type":"text"},{"text":"Introduced in API Version 2.7.20","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": name assigned to the preference","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": value assigned to the preference","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"scope","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": defines in which scope the preference is used. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“USER”: Preference assigned to the USER","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“PROGRAM”: Preference that is applicable only in the context of a ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260259"}},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“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","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"scope_ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"scope_description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Description of the scope object referenced by ","type":"text"},{"text":"scope_ref","type":"text","marks":[{"type":"strong"}]},{"text":". For example, if ","type":"text"},{"text":"scope","type":"text","marks":[{"type":"strong"}]},{"text":" = “PROGRAM”, then ","type":"text"},{"text":"scope_description","type":"text","marks":[{"type":"strong"}]},{"text":" will be the name of the PROGRAM","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorMsg","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains a description of the error translated to the current language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorCode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains any of the standard ","type":"text"},{"text":"ERROR CODES","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/55967818/ERROR+CODES"}}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Request sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[535.0]},"content":[{"type":"paragraph","content":[{"text":"case_get_preferences ( “LCAAAAAAAAAAAA”, 3243 );","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Response sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[535.0]},"content":[{"type":"codeBlock","content":[{"text":"\n\n \n true\n false\n \n OPENSTREET\n OpenStreet Maps\n \n \n email\n all\n 09:00:00\n \n \n patients.sort\n HIDE_INSTRUCTIONS\n 0\n PROGRAM\n 383\n COVID19\n \n ...\n \n\n\n\n","type":"text"}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[145.0]},"content":[{"type":"paragraph","content":[{"text":"Notes:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[535.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"40094a0a-ba18-45d9-8d5f-0e72a4c1054c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The session token provided is not valid","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"INSUFFICIENT_PRIVILEGES","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The session user does not have the necessary privileges to request the preferences of the CASE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"CASE.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The CASE specified was not found","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"CHANGES_2_7_25"},"_parentId":{"value":"2501181483"}},"macroMetadata":{"macroId":{"value":"8fec84df62b1e92a8804d936e81fe736"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"4c1222a0-4716-47fe-a0c5-f116a3145dcc"}},{"text":"XML changes in API version 2.7.25 respect previous versions","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"include","parameters":{"macroParams":{"":{"value":"Changes in \"preferences\" structure in version 2.7.25"},"_parentId":{"value":"2501181483"}},"macroMetadata":{"macroId":{"value":"b63880e15167937cc3354353f3bfc6b3"},"schemaVersion":{"value":"1"},"title":"Include Page"}},"localId":"702a0d7f-f2dc-47b1-acf2-e6011f7c8bab"}},{"type":"paragraph"}],"version":1}

Browser not supported