{"type":"doc","content":[{"type":"table","attrs":{"layout":"default","localId":"acc30a53-591b-474f-96e5-e320222e28d4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[590.0]},"content":[{"type":"paragraph","content":[{"text":"notification_channels_list (session, object_type, [object_ref])","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[590.0]},"content":[{"type":"paragraph","content":[{"text":"2.7.25 and higher","type":"text"}]}]}]}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"1763132b-925c-4309-874f-8db3d3c2160b"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"001725b1-3073-4109-b6b0-9217e8a6e6a9"},"content":[{"type":"paragraph","content":[{"text":"Returns a list of the available channels that can be used to send notifications to a user (either a USER or CASE). ","type":"text"}]}]},{"type":"table","attrs":{"layout":"default","localId":"43cd94be-1853-4cce-8e31-ccf61f40fb7d"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[163.0,597.0]},"content":[{"type":"paragraph","content":[{"text":"The list of channel types returned can be used to set the notification preferences of the user.","type":"text"}]},{"type":"paragraph","content":[{"text":"This function will only return a particular communication channel when:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The USER or CASE has the corresponding communication channel informed","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Linkcare instance is configured to send notifications through the specified channel","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"For example, the SMS channel will not be indicated if:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user does not have a phone number assigned","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The SMS messaging subsystem is not configured in the Linkcare platform","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Input parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.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"},{"type":"inlineCard","attrs":{"url":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/524509"}},{"text":" call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"object_type","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": can be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“USER”: To get the list of notification channels available of a professional.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"“CASE”: To get the list of notification channels available of a patient. ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"object_ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": the reference to the object (a CASE or USER reference). If no value is provided, the active user reference will be assumed","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML with the list of available notification channels:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"channels","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"channel","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Name of the continent (e.g. Europe)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": code of the channel","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": name of the communication channel (e.g. “","type":"text"},{"text":"Email address","type":"text","marks":[{"type":"em"}]},{"text":"”)","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":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Request sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.0]},"content":[{"type":"paragraph","content":[{"text":"notification_channel_list ('LC12312312:23413', ‘CASE’, 12324);","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Response sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.0]},"content":[{"type":"codeBlock","content":[{"text":"\n\n \n \n email\n Email address\n \n \n push\n Push notifications\n \n ...\n \n\n\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"23383813-988e-4246-8727-0052f5c9a38d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[224.0]},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[536.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[224.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[536.0]},"content":[{"type":"paragraph","content":[{"text":"The session token provided is not valid","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported