{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This document provides a list of all EFS Service-Layer services. ","type":"text"},{"text":"To have general information on the EFS Service-Layer, please go to this page","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/DOC/pages/1273102351"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"As mentioned in the EFS Service-Layer overview, all requests should use the ","type":"text"},{"text":"token","type":"text","marks":[{"type":"code"}]},{"text":" URL parameter to authenticate the service user, for example ","type":"text"},{"text":"GET https://your-efs.com/service/survey/surveys/?token=1234567890","type":"text","marks":[{"type":"code"}]},{"text":". An alternative to using the provided token, is to create a basic authentication request as specified in the HTTP protocol.","type":"text"}]},{"type":"paragraph","content":[{"text":"REST status codes","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"When using REST to access the Service Layer, the service will use the following HTTP status codes, 500 being the most common error status code and 200 being used for all successful requests.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9265a8f9-04d6-4637-9e0a-1b061be8a851"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"Status","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"The request has been processed, see end point description for expected response body","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"400","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"The validation of the entity given in the body of the request failed. Can also be caused by a malformed JSON request.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"401","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"Can be caused by missing, invalid or expired token or username/password combination.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"403","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"The user does not have the permission to execute this service or service is unknown or not enabled/available.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[90.0]},"content":[{"type":"paragraph","content":[{"text":"500","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[668.0]},"content":[{"type":"paragraph","content":[{"text":"All regular errors and exceptions will use this status code, please see the message for additional information. ","type":"text"},{"text":"In some rare exceptions, the returned value may not be json encoded.","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Example for response body of a error status code:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"error\": {\n \"message\": \"REST route [efs/test] not found, not activated or no access\",\n \"code\": 403\n }\n}","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The title of the expandable area uses the following format:","type":"text"},{"type":"hardBreak"},{"text":"Description | ","type":"text","marks":[{"type":"strong"}]},{"text":"{REST method} ","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" | ","type":"text","marks":[{"type":"strong"}]},{"text":" {SOAP method}","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"The examples provided are REST requests, our recommended method for accessing the Service-Layer. The list of services omits the mandatory /service/ base path. All service layer requests need to use this base path, e.g. ","type":"text"},{"text":"GET /survey/surveys/","type":"text","marks":[{"type":"code"}]},{"text":" should be ","type":"text"},{"text":"GET https://efs-installation.com/service/survey/surveys/","type":"text","marks":[{"type":"code"}]},{"text":" in your application.","type":"text"}]},{"type":"paragraph","content":[{"text":"When requesting services to be activated through the support, it is best to provide the SOAP method names, as these are unique and avoid confusion.","type":"text"}]}]},{"type":"rule"},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"1"}},"macroMetadata":{"macroId":{"value":"0beb5c66-5e6d-474d-9674-d4ee9794044b"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"5fe3a56b-4948-4386-8434-47fbdb361973"}},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"EFS","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Email blocklist, global and survey based","type":"text"}]},{"type":"expand","attrs":{"title":"Delete emails from email blocklist | DELETE /efs/mailblacklist/ | efs_mailblacklist_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/mailblacklist/","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a list of email addresses from blocklist","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"emailList\": [\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 1234\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 1234,\n \"result\": 1\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get email block list | GET /efs/mailblacklist/ | efs_mailblacklist_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/mailblacklist/","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of all blocklisted email addresses (both global and survey). Global entries have ","type":"text"},{"text":"surveyId","type":"text","marks":[{"type":"em"}]},{"text":" 0.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 0,\n \"createdAt\": \"2020-07-02T12:53:50+00:00\",\n \"createdBy\": \"SERVICE\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":" Add emails to blocklist | POST /efs/mailblacklist/ | efs_mailblacklist_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailblacklist/","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a list of email addresses to blocklist. If surveyId is specified the email will be blocked for given survey, otherwise if omitted or if surveyId is 0, the email will be added to global blocklist.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"emailList\": [\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 1234\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 1234,\n \"result\": 1\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Check if email is in blocklist | POST /efs/mailblacklist/check | efs_mailblacklist_isBlacklisted"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailblacklist/check","type":"text"}]},{"type":"paragraph","content":[{"text":"If surveyId is not specified, or the id is 0, only the global blocklist will be checked. By providing a surveyId, the system will check if the email is blocked in the given survey only. The return value is a boolean.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"emailAddress\": \"example@domain.tld\",\n \"surveyId\": 1234\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Query email blocklist by date | POST /efs/mailblacklist/getListByDateRange | efs_mailblacklist_getListByDateRange"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailblacklist/getListByDateRange","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of blocklisted email addresses (both global and survey related) restricted by date range.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"dateRange\": {\n \"from\": \"2020-07-01T12:53:50+00:00\",\n \"to\": \"2020-07-03T12:53:50+00:00\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 1234,\n \"result\": 1\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Query email blocklist by email | POST /efs/mailblacklist/getListByEmailAddress | efs_mailblacklist_getListByEmailAddress"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailblacklist/getListByEmailAddress","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of all surveys where given email is blacklisted. In case of global blacklist the surveyId is 0.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"emailAddress\": \"example@domain.tld\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"email\": \"example@domain.tld\",\n \"surveyId\": 0,\n \"createdAt\": \"2020-08-26T11:01:22+00:00\",\n \"createdBy\": \"SERVICE\"\n }\n]","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Mail templates","type":"text"}]},{"type":"expand","attrs":{"title":"Add a mail template | POST /efs/mailtemplates/ | efs_mailtemplates_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailtemplates/","type":"text"}]},{"type":"paragraph","content":[{"text":"Add mail template. Please see the mail template form in EFS for required and optional information. Returns the id of the newly created mail template. Use ","type":"text"},{"text":"GET /efs/mailtemplates/{id}","type":"text","marks":[{"type":"code"}]},{"text":" on an existing template, if unsure about the correct parameters and also have a look at the mail template editor in EFS for optional and required parameters and supported wildcards, specific to your mail template type.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"3a59a405-416e-4557-953d-503cb90e7572"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"Option","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"Valid values","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"default_mail, invitation_mail, reminder_mail, survey_ends_mailtype, welcome_mail, pwrecovery_mail, doub_check_mail, register_check_mail, md_invitation_mail, md_reminder_mail, winner_mail, promotion_mail, bonus_mail, exchange_mail, orgprocessor_mail, website_notifications, system_mail, eat_your_own_dogfood, result_mail, reportnotification_mail","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"site_id","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"ID of Panel Website language version, on installations without Panel Website, please use 0.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"format","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"TEXT, HTML, TEXT_AND_HTML","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"charset","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"UTF-8, UTF-16, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ISO-8859-13, ISO-8859-15, US-ASCII, KOI8-R, GB18030, x-EUC-CN, GBK, x-EUC-TW, Big5, Big5-HKSCS, EUC-JP, Shift_JIS, ISO-2022-JP, EUC-KR, ISO-2022-KR, TIS-620","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"priority","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"NO_PRIORITY, HIGHEST, HIGH, NORMAL, LOW, LOWEST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"sensitivity","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"NORMAL, PRIVATE, PERSONAL, COMPANY","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"notify","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"NO_NOTIFICATION, WITH_RETURN_PATH, WITH_FROM_PATH","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"localeString","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"See EFS mail template interface for a current list of locales.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[126.0]},"content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"from","type":"text","marks":[{"type":"code"}]},{"text":" needs to be one of registered sender email addresses in EFS. See: Libraries > Mail templates > Mail senders.","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"mailtemplate\": {\n \"meta\": {\n \"description\": \"Example description\",\n \"type\": \"default_mail\",\n \"site_id\": \"123\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example\",\n \"format\": \"TEXT_AND_HTML\",\n \"text_content\": \"Example\",\n \"html_content\": \"

Example

\"\n },\n \"options\": {\n \"charset\": \"UTF-8\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": true,\n \"send_copy\": true,\n \"cc\": \"example@domain.tld\",\n \"bcc\": \"example@domain.tld\",\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\",\n \"sms_from\": \"+491234567890\",\n \"sms_content\": \"Example\"\n },\n \"translations\": [\n {\n \"localeString\": \"de_DE\",\n \"subject\": \"Beispiel\",\n \"text_content\": \"Beispiel\",\n \"html_content\": \"

Beispiel

\",\n \"sms_content\": \"Beispiel\"\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]}]},{"type":"expand","attrs":{"title":"Delete a mail template | DELETE /efs/mailtemplates/{id} | efs_mailtemplates_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/mailtemplates/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete mail template by id. Successful requests have no response body.","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"22a70557-1357-4ba4-87a7-47ce3732ba05"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The mail-template id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get a mail template by id | GET /efs/mailtemplates/{id} | efs_mailtemplates_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/mailtemplates/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get mail template by id","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear #u_firstname#, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n },\n \"id\": 1234\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f630e360-a364-41fd-8998-6b963fa48564"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The mail-template id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get a mail template by id with attachments | GET /efs/mailtemplates/withAttachments/{id} | efs_mailtemplates_getWithAttachments"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/mailtemplates/withAttachments/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get mail template by id with attachments. The content of attachment is gzip and base64 encoded.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear #u_firstname#, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n },\n \"attachments\": [\n {\"name\":\"example.jpg\", \"content\":\"skkfdsjksdjkfsd...\"}\n ]\n \"id\": 1234\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"30171363-b495-465a-b5a5-600e1576a287"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The mail-template id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update a mail template | PUT /efs/mailtemplates/{id} | efs_mailtemplates_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /efs/mailtemplates/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Change mail template data, returns the mail id","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"mailtemplate\": {\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear #u_firstname#, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"722eecff-5d62-4c3f-8c81-c3cdc19d0182"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The mail-template id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get a list of mail templates | POST /efs/mailtemplates/list | efs_mailtemplates_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailtemplates/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of mailtemplates. You can restrict the list of templates, by providing a POST body with the list of types.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"mailTemplateTypes\": [\n \"default_mail\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear #u_firstname#, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n },\n \"id\": 1234\n }\n]","type":"text"}]},{"type":"paragraph"}]},{"type":"expand","attrs":{"title":"Get a list of mail templates w. attachments | POST /efs/mailtemplates/attachments/list | efs_mailtemplates_getListWithAttachments"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailtemplates/listWithAttachments","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of mailtemplates. You can restrict the list of templates, by providing a POST body with the list of types.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"mailTemplateTypes\": [\n \"default_mail\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear #u_firstname#, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"attachments\": [\n ]\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n },\n \"id\": 1234\n }\n]","type":"text"}]},{"type":"paragraph"}]},{"type":"expand","attrs":{"title":"Send preview email | POST /efs/mailtemplates/send | efs_mailtemplates_send"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/mailtemplates/send","type":"text"}]},{"type":"paragraph","content":[{"text":"Send a preview email. Similar to the mail template preview send functionality in the EFS UI.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": 353,\n \"recieverMails\":\"example@example.tld\",\n \"localeString\":\"de_DE\",\n \"placeholders\": [\n {\"placeholderName\":\"#test#\", \"placeholderValue\":\"Test\"}\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"success\": true\n}","type":"text"}]},{"type":"paragraph"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Management of EFS organisations","type":"text"}]},{"type":"expand","attrs":{"title":"Delete an EFS admin organisation | DELETE /efs/organizations/ | efs_organizations_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/organizations/","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an EFS admin organisation.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgIdentifierType\": \"id\",\n \"adminOrgIdentifierValue\": \"1234\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Update an EFS admin organisation | PATCH /efs/organizations/ | efs_organizations_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/organizations/","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets an organization's value. See ","type":"text"},{"text":"POST /efs/organizations/","type":"text","marks":[{"type":"code"}]},{"text":" for possible ","type":"text"},{"text":"adminOrgField","type":"text","marks":[{"type":"em"}]},{"text":" names. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgIdentifierType\": \"id\",\n \"adminOrgIdentifierValue\": \"1234\",\n \"adminOrgField\": \"customer_no_common\",\n \"adminOrgValue\": \"KD1234\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add an EFS admin organisation | POST /efs/organizations/ | efs_organizations_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/organizations/","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds an EFS admin organization.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgRecord\": {\n \"name\": \"Example\",\n \"description\": \"Example org\",\n \"contract_start\": \"2020-07-02T12:53:50+00:00\",\n \"contract_end\": \"2022-07-02T12:53:50+00:00\",\n \"customer_no_common\": \"Example\",\n \"max_active_projects_allowed\": \"Example\",\n \"max_archived_projects_allowed\": \"Example\",\n },\n \"adminOrgIdentifierReturnType\": \"id\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add existing admin users to organisation | PUT /efs/organizations/ | efs_organizations_addUser"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /efs/organizations/","type":"text"}]},{"type":"paragraph","content":[{"text":"Add an existing staff member to an organization.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminUserIdentifierType\": \"u_email\",\n \"adminUserIdentifierValue\": \"example@domain.tld\",\n \"adminOrgIdentifierType\": \"id\",\n \"adminOrgIdentifierValue\": \"1234\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get an organisation by Id | POST /efs/organizations/details | efs_mailtemplates_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/organizations/details","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns an organization.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgIdentifierType\": \"id\",\n \"adminOrgIdentifierValue\": \"1234\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"name\": \"Example\",\n \"description\": \"Example org\",\n \"contract_start\": \"2019-07-01T00:00:00+00:00\",\n \"contract_end\": \"2023-12-30T00:00:00+00:00\",\n \"customer_no_common\": \"KD1234\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get a list of organisations | POST /efs/organizations/list | efs_mailtemplates_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/organizations/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of organizations specified by a search value.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgField\": \"name\",\n \"adminOrgValue\": \"Example\",\n \"pageFrom\": 0,\n \"pageLimit\": 100\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"name\": \"Example\",\n \"description\": \"Example org\",\n \"contract_start\": \"2019-07-01T00:00:00+00:00\",\n \"contract_end\": \"2023-12-30T00:00:00+00:00\",\n \"customer_no_common\": \"KD1234\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Modify Reporting+ export templates of an organisation | PATCH /efs/organizations/templates | efs_organizations_changeReportingExportTemplates"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/organizations/templates","type":"text"}]},{"type":"paragraph","content":[{"text":"Changes an admin organization's Reporting+ export templates configuration for one file type format. Possible values for reportingExportFormat are: html, ppt, pdf, pptx and pptxpdf. To disable an export, send ","type":"text"},{"text":"\"reportingExportTemplates\": []","type":"text","marks":[{"type":"code"}]},{"text":", otherwise provide a list of export template ids to be enabled.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminOrgIdentifierType\": \"id\",\n \"adminOrgIdentifierValue\": \"1234\",\n \"reportingExportFormat\": \"pptxpdf\",\n \"reportingExportTemplates\": [\n 123,\n 124\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Management of EFS teams","type":"text"}]},{"type":"expand","attrs":{"title":"Create a EFS team | POST /efs/teams/ | efs_teams_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/teams/","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a new EFS team, returns the id of the team.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"team\": {\n \"teamName\": \"Example\",\n \"teamTitle\": \"Example\",\n \"teamDesription\": \"Example description\",\n \"teamAccessability\": [\n 1\n ],\n \"areasAccessable\": [\n \"www\"\n ],\n \"rightTemplateId\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get list of teams by criteria | POST /efs/teams/list | efs_teams_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/teams/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves a list of teams matching given search criteria","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"teamName\",\n \"identifierValue\": \"Example\",\n \"page\": 0,\n \"limit\": 100\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"teamId\": 1,\n \"teamName\": \"Example\",\n \"teamTitle\": \"Example\",\n \"teamDesription\": \"Example description\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Delete a team | DELETE /efs/teams/{teamId} | efs_teams_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/teams/{teamId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an EFS team","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"4952be78-0f5e-462c-bbac-2b8c395c4c64"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"teamId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"team id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get team by id | GET /efs/teams/{teamId} | efs_teams_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/teams/{teamId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves the data of an EFS team","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"teamId\": 1,\n \"teamName\": \"Example\",\n \"teamTitle\": \"Example\",\n \"teamDesription\": \"Example description\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"583f4e9c-8998-4d3e-b6e9-f486640ca677"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"teamId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"team id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update a team | PATCH /efs/teams/{teamId} | efs_teams_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/teams/{teamId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Changes the EFS team details","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"team\": {\n \"teamName\": \"Example\",\n \"teamTitle\": \"Example\",\n \"teamDescription\": \"Example\",\n \"teamAccessability\": [\n 1\n ],\n \"areasAccessable\": [\n \"www\"\n ],\n \"rightTemplateId\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"432d01d9-465d-4237-bc1e-0910c9698d20"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"teamId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"team id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Object rights","type":"text"}]},{"type":"expand","attrs":{"title":"Remove object rights of a team | DELETE /efs/privileges/ | efs_privileges_removeRight"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/privileges/","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes the right from the object for the given team.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"objectId\": 1,\n \"groupId\": 1,\n \"right\": \"read\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add or replace object right of a team | PATCH /efs/privileges/ | efs_privileges_changeRight"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/privileges/","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets a right on an object for given team, replaces any existing condition","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"objectId\": 1,\n \"groupId\": 1,\n \"right\": \"read\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add object right of a team | POST /efs/privileges/addright | efs_privileges_addRight"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/privileges/addright","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds the right to the object for the given team.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"objectId\": 1,\n \"groupId\": 1,\n \"right\": \"read\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Check if user has access to a feature | POST /efs/privileges/features | efs_privileges_hasAccessToFeature"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/privileges/features","type":"text"}]},{"type":"paragraph","content":[{"text":"Tells if current user has access to a specific access right (team rights). Valid parameters for ","type":"text"},{"text":"right","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"read, write","type":"text","marks":[{"type":"em"}]},{"text":". The parameter ","type":"text"},{"text":"feature","type":"text","marks":[{"type":"code"}]},{"text":" accepts a string containing the name of an act right, please see team rights management in ","type":"text"},{"text":"System > Users > Teams","type":"text","marks":[{"type":"em"}]},{"text":" in EFS or the ","type":"text"},{"text":"online manual","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/DOC/pages/1455883410"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"feature\": \"ct42partadm\",\n \"right\": \"read\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Check if user has access to an object | POST /efs/privileges/object | efs_privileges_hasAccessToObject"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/privileges/object","type":"text"}]},{"type":"paragraph","content":[{"text":"Tells if current user has access to an object. See Options > ACL Rights > Object instances","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"objectId\": 1,\n \"right\": \"read\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"EFS admin user management","type":"text"}]},{"type":"expand","attrs":{"title":"Delete a EFS admin user | DELETE /efs/staff/ | efs_staff_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /efs/staff/","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a staff member. A successful request has no response body.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"email\",\n \"identifier\": \"example@domain.tld\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get information about current EFS admin user | GET /efs/staff/ | efs_staff_getAdminUser"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/staff/","type":"text"}]},{"type":"paragraph","content":[{"text":"Return information about the current admin user thats using the service. This method also keeps admin-session alive.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"adminUserId\": 1234,\n \"accountName\": \"Example\",\n \"firstName\": \"First\",\n \"lastName\": \"Last\",\n \"email\": \"example@domain.tld\",\n \"language\": \"EN\",\n \"expireDate\": \"2020-07-02T12:53:50+00:00\",\n \"organisation\": 1,\n \"primaryGroup\": 1,\n \"groups\": [\n 1\n ]\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Change EFS admin user information | PATCH /efs/staff/ | efs_staff_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/staff/","type":"text"}]},{"type":"paragraph","content":[{"text":"Changes a staff members data. You only need to provide the fields you want to change.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"email\",\n \"identifier\": \"example@domain.tld\",\n \"changes\": {\n \"firstName\": \"First\",\n \"lastName\": \"Last\",\n \"email\": \"example@domain.tld\",\n \"password\": \"New Password\",\n \"gender\": \"NOT_SPECIFIED\",\n \"street\": \"None\",\n \"zip\": \"12345\",\n \"city\": \"Example\",\n \"phone\": \"+491234567890\",\n \"country\": \"Germany\",\n \"mobile\": \"+491234567890\",\n \"language\": \"EN\",\n \"expireDate\": \"2024-07-02T12:53:50+00:00\",\n \"organisation\": 1,\n \"primaryTeam\": 1,\n \"teams\": [\n 1\n ],\n \"enabled\": true,\n \"mobile2\": \"+491234567891\",\n \"www\": \"Some URL\",\n \"comment\": \"Additional Comment\",\n \"department\": \"Department info\"\n }\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Create EFS admin user | POST /efs/staff/ | efs_staff_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/staff/","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a new staff member for the EFS admin interface. To set the staff members organization you need to have the appropriate right. If no organization is set the staff member will inherit the creating staff members organization. Returns the user id.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"staffMember\": {\n \"identifierType\": \"email\",\n \"identifier\": \"example@domain.tld\",\n \"changes\": {\n \"account\": \"Example\",\n \"firstName\": \"First\",\n \"lastName\": \"Last\",\n \"email\": \"example@domain.tld\",\n \"password\": \"New Password\",\n \"gender\": \"NOT_SPECIFIED\",\n \"street\": \"None\",\n \"zip\": \"12345\",\n \"city\": \"Example\",\n \"phone\": \"+491234567890\",\n \"country\": \"Germany\",\n \"mobile\": \"+491234567890\",\n \"language\": \"EN\",\n \"expireDate\": \"2024-07-02T12:53:50+00:00\",\n \"organisation\": 1,\n \"primaryTeam\": 1,\n \"teams\": [\n 1\n ],\n \"enabled\": true,\n \"mobile2\": \"+491234567891\",\n \"www\": \"Some URL\",\n \"comment\": \"Additional Comment\",\n \"department\": \"Department info\"\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get information about a EFS admin user | POST /efs/staff/details | efs_staff_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/staff/details","type":"text"}]},{"type":"paragraph","content":[{"text":"Return information about a staff member","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"email\",\n \"identifier\": \"example@domain.tld\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"userId\": 1234,\n \"account\": \"Example\", \n \"firstName\": \"First\",\n \"lastName\": \"Last\",\n \"email\": \"example@domain.tld\",\n \"password\": \"New Password\",\n \"gender\": \"NOT_SPECIFIED\",\n \"street\": \"None\",\n \"zip\": \"12345\",\n \"city\": \"Example\",\n \"phone\": \"+491234567890\",\n \"country\": \"Germany\",\n \"mobile\": \"+491234567890\",\n \"language\": \"EN\",\n \"expireDate\": \"2020-07-02T12:53:50+00:00\",\n \"organisation\": 1,\n \"primaryTeam\": 1,\n \"teams\": [\n 1\n ],\n \"enabled\": true,\n \"mobile2\": \"Example\",\n \"www\": \"Example\",\n \"comment\": \"Example\",\n \"department\": \"Example\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all EFS admin users | GET /efs/staff/list | efs_staff_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/staff/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of all EFS staff members","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"adminUserId\": 1234,\n \"accountName\": \"Example\",\n \"firstName\": \"First\",\n \"lastName\": \"Last\",\n \"email\": \"example@domain.tld\",\n \"language\": \"EN\",\n \"expireDate\": \"2020-07-02T12:53:50+00:00\",\n \"organisation\": 1,\n \"primaryGroup\": 1,\n \"groups\": [\n 1\n ]\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Send mail to EFS admin user | POST /efs/staff/mail | efs_staff_sendMail"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/staff/mail","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends email to the specified EFS admin user","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"email\",\n \"identifierValue\": \"example@domain.tld\",\n \"mailTemplateData\": {\n \"meta\": {\n \"description\": \"Example message\",\n \"type\": \"default_mail\",\n \"site_id\": \"7\",\n \"active\": true\n },\n \"content\": {\n \"from\": \"example@domain.tld\",\n \"subject\": \"Example message\",\n \"format\": \"TEXT\",\n \"text_content\": \"Dear user, \\r\\n\\r\\nyou have a new message.\",\n \"attachments\": false\n },\n \"options\": {\n \"charset\": \"ISO-8859-1\",\n \"reply_to\": \"example@domain.tld\",\n \"return_path\": \"example@domain.tld\",\n \"to_realname\": false,\n \"send_copy\": false,\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\"\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add EFS admin user to a team | PATCH /efs/staff/role | efs_staff_changeRole"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /efs/staff/role","type":"text"}]},{"type":"paragraph","content":[{"text":"Alters a staff members role within a given team","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"userId\": 1,\n \"teamId\": 1,\n \"newRole\": \"MEMBER\",\n \"newOwnerUserId\": 1\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"System information","type":"text"}]},{"type":"expand","attrs":{"title":"Get version of the EFS installation | GET /efs/system/ | efs_system_getVersion"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/system/","type":"text"}]},{"type":"paragraph","content":[{"text":"determine the version number of the EFS installation","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"20.1\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get current server time | POST /efs/system/ | efs_system_getTime"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /efs/system/","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the current server time, use ","type":"text"},{"text":"format","type":"text","marks":[{"type":"code"}]},{"text":" to provide a formatting string (see PHP date() formatting options), otherwise the current unix timestamp will be returned. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"format\": \"Y-m-d H:i:s\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"2020-08-26 13:35:26\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get system load | GET /efs/system/load | efs_system_getLoad"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/system/load","type":"text"}]},{"type":"paragraph","content":[{"text":"query the current system's 1-minute load average","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1.345","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Other","type":"text"}]},{"type":"expand","attrs":{"title":"Get admin user id by session id | GET /efs/session/{sessionId} | efs_session_getAdminUserId"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/session/{sessionId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the admin user id for an admin session id Will throw an exception if the session id is invalid or the session is expired","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"97e74484-bdc3-4360-9e2e-806c2a3db052"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sessionId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of admin session.","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get status of asynchronous task | GET /efs/taskqueue/{taskId} | efs_taskqueue_getResult"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/taskqueue/{taskId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns json encoded array with either execution-status or (if available) result of asynchronous service-calls for given taskId. Possible values for status: ","type":"text"},{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":" - Task is pending for execution, ","type":"text"},{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - Task is currently running, ","type":"text"},{"text":"3","type":"text","marks":[{"type":"strong"}]},{"text":" - Task execution failed;","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"2\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"d1d1271b-23e3-421f-a050-99c3dbf8541c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"taskId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of taskqueue task ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get status of a job | GET /efs/jobs/{jobId} | efs_jobs_getStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /efs/jobs/{jobId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Query the status of a single EFS job maker job. This service is only enabled in certain use cases for customers.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"2\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"787dd154-74d0-40c3-bff5-426c6f6b3fda"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"jobId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"job id, ","type":"text"},{"text":"Example:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"10898768285f48e49c0d49f","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Employee","type":"text"}]},{"type":"expand","attrs":{"title":"Add a report | POST /employee/reports/ | employee_reports_addReport"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /employee/reports/","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a report","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"report\": {\n \"report_definition_id\": 1234,\n \"pid\": 1234,\n \"lang_id\": 1234,\n \"report_type\": \"pdf\",\n \"unit_metaname\": \"Example\",\n \"file_content\": \"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\",\n \"report_label\": \"Example\",\n \"replace\": true,\n \"report_filename\": \"Example.pdf\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"report_definition_id\": 1234,\n \"pid\": 1234,\n \"lang_id\": 1234,\n \"report_type\": \"pdf\",\n \"unit_metaname\": \"Example\",\n \"file_content\": \"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\",\n \"report_label\": \"Example\",\n \"replace\": true,\n \"report_filename\": \"Example.pdf\",\n \"rid\": \"1234\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get list of report definitions for surveyID | GET /employee/reports/{surveyId} | employee_reports_getDefinitions"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /employee/reports/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the List of Report definitions including report versions for ","type":"text"},{"text":"surveyId","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"report_id\": 1234,\n \"pid\": 1234,\n \"name\": \"Example\",\n \"title_pattern\": \"Example\",\n \"template\": \"Example\",\n \"cat\": \"Example\",\n \"download_status\": \"Example\",\n \"file_download_pattern\": \"Example\",\n \"report_type\": 1234,\n \"number_of_reports\": 1234,\n \"min_participants\": 1234,\n \"min_item\": 1234\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"c5e51c4e-608f-4a66-90f3-66ba5c916a4a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel or masterdata survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"GDPR","type":"text"}]},{"type":"expand","attrs":{"title":"Get GDPR consent for a locale in Panel | GET /gdpr/panel/getConsentForm/{localeString} | gdpr_panel_getConsentForm"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /gdpr/panel/getConsentForm/","type":"text"},{"text":"{localeString}","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns GDPR consent for given locale string","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"content_value\": \"Example\",\n \"welcome_text_value\": \"Example\",\n \"title_headline\": \"Example\",\n \"contact_us_headline_headline\": \"Example\",\n \"company_name_value\": \"Example\",\n \"contact_detail_value\": \"Example\",\n \"representative_headline\": \"Example\",\n \"representative_value\": \"Example\",\n \"data_scope_headline\": \"Example\",\n \"data_scope_value\": \"Example\",\n \"data_category_headline\": \"Example\",\n \"data_category_value\": \"Example\",\n \"legal_basis_headline\": \"Example\",\n \"legal_basis_value\": \"Example\",\n \"recipient_headline\": \"Example\",\n \"recipient_value\": \"Example\",\n \"transfer_data_headline\": \"Example\",\n \"transfer_data_value\": \"Example\",\n \"contractual_requirement_headline\": \"Example\",\n \"contractual_requirement_value\": \"Example\",\n \"auto_decision_headline\": \"Example\",\n \"auto_decision_value\": \"Example\",\n \"info_subject_headline\": \"Example\",\n \"info_subject_value\": \"Example\",\n \"info_withdrawal_headline\": \"Example\",\n \"info_withdrawal_value\": \"Example\",\n \"info_supervisor_headline\": \"Example\",\n \"info_supervisor_value\": \"Example\",\n \"contact_officer_headline\": \"Example\",\n \"contact_officer_value\": \"Example\",\n \"data_retention_headline\": \"Example\",\n \"data_retention_value\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"35283569-b227-43ff-9600-8f8b1b8666d8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"localeString","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Language string, ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"de_DE","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"en_GB","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Set consent for given locale in Panel | POST /gdpr/panel/setConsentForm | gdpr_panel_setConsentForm"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /gdpr/panel/setConsentForm","type":"text"}]},{"type":"paragraph","content":[{"text":"Set content of GDPR consent for given locale string","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"localeString\": \"de_DE\",\n \"consentData\": {\n \"content_value\": \"Example\",\n \"welcome_text_value\": \"Example\",\n \"title_headline\": \"Example\",\n \"contact_us_headline_headline\": \"Example\",\n \"company_name_value\": \"Example\",\n \"contact_detail_value\": \"Example\",\n \"representative_headline\": \"Example\",\n \"representative_value\": \"Example\",\n \"data_scope_headline\": \"Example\",\n \"data_scope_value\": \"Example\",\n \"data_category_headline\": \"Example\",\n \"data_category_value\": \"Example\",\n \"legal_basis_headline\": \"Example\",\n \"legal_basis_value\": \"Example\",\n \"recipient_headline\": \"Example\",\n \"recipient_value\": \"Example\",\n \"transfer_data_headline\": \"Example\",\n \"transfer_data_value\": \"Example\",\n \"contractual_requirement_headline\": \"Example\",\n \"contractual_requirement_value\": \"Example\",\n \"auto_decision_headline\": \"Example\",\n \"auto_decision_value\": \"Example\",\n \"info_subject_headline\": \"Example\",\n \"info_subject_value\": \"Example\",\n \"info_withdrawal_headline\": \"Example\",\n \"info_withdrawal_value\": \"Example\",\n \"info_supervisor_headline\": \"Example\",\n \"info_supervisor_value\": \"Example\",\n \"contact_officer_headline\": \"Example\",\n \"contact_officer_value\": \"Example\",\n \"data_retention_headline\": \"Example\",\n \"data_retention_value\": \"Example\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get consent in a survey | GET /gdpr/survey/{surveyId}/{languageId} | gdpr_survey_getConsentForm"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /gdpr/survey/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns GDPR consent for given surveyId and languageId","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"content_value\": \"Example\",\n \"welcome_text_value\": \"Example\",\n \"title_headline\": \"Example\",\n \"contact_us_headline_headline\": \"Example\",\n \"company_name_value\": \"Example\",\n \"contact_detail_value\": \"Example\",\n \"representative_headline\": \"Example\",\n \"representative_value\": \"Example\",\n \"data_scope_headline\": \"Example\",\n \"data_scope_value\": \"Example\",\n \"data_category_headline\": \"Example\",\n \"data_category_value\": \"Example\",\n \"legal_basis_headline\": \"Example\",\n \"legal_basis_value\": \"Example\",\n \"recipient_headline\": \"Example\",\n \"recipient_value\": \"Example\",\n \"transfer_data_headline\": \"Example\",\n \"transfer_data_value\": \"Example\",\n \"contractual_requirement_headline\": \"Example\",\n \"contractual_requirement_value\": \"Example\",\n \"auto_decision_headline\": \"Example\",\n \"auto_decision_value\": \"Example\",\n \"info_subject_headline\": \"Example\",\n \"info_subject_value\": \"Example\",\n \"info_withdrawal_headline\": \"Example\",\n \"info_withdrawal_value\": \"Example\",\n \"info_supervisor_headline\": \"Example\",\n \"info_supervisor_value\": \"Example\",\n \"contact_officer_headline\": \"Example\",\n \"contact_officer_value\": \"Example\",\n \"data_retention_headline\": \"Example\",\n \"data_retention_value\": \"Example\",\n \"data_retention_type\": \"YEAR\",\n \"data_retention_amount\": 1\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"aefb6b07-73f1-4b65-8a79-26b2d2ad26d2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey Id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Language Id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Set consent in a survey | POST /gdpr/survey/{surveyId}/{languageId} | gdpr_survey_setConsentForm"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /gdpr/survey/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Set content of GDPR consent for given surveyId and languageId","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"consentData\": {\n \"content_value\": \"Example\",\n \"welcome_text_value\": \"Example\",\n \"title_headline\": \"Example\",\n \"contact_us_headline_headline\": \"Example\",\n \"company_name_value\": \"Example\",\n \"contact_detail_value\": \"Example\",\n \"representative_headline\": \"Example\",\n \"representative_value\": \"Example\",\n \"data_scope_headline\": \"Example\",\n \"data_scope_value\": \"Example\",\n \"data_category_headline\": \"Example\",\n \"data_category_value\": \"Example\",\n \"legal_basis_headline\": \"Example\",\n \"legal_basis_value\": \"Example\",\n \"recipient_headline\": \"Example\",\n \"recipient_value\": \"Example\",\n \"transfer_data_headline\": \"Example\",\n \"transfer_data_value\": \"Example\",\n \"contractual_requirement_headline\": \"Example\",\n \"contractual_requirement_value\": \"Example\",\n \"auto_decision_headline\": \"Example\",\n \"auto_decision_value\": \"Example\",\n \"info_subject_headline\": \"Example\",\n \"info_subject_value\": \"Example\",\n \"info_withdrawal_headline\": \"Example\",\n \"info_withdrawal_value\": \"Example\",\n \"info_supervisor_headline\": \"Example\",\n \"info_supervisor_value\": \"Example\",\n \"contact_officer_headline\": \"Example\",\n \"contact_officer_value\": \"Example\",\n \"data_retention_headline\": \"Example\",\n \"data_retention_value\": \"Example\",\n \"data_retention_type\": \"YEAR\",\n \"data_retention_amount\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"010ca472-9611-4cac-9e5c-1c75ded21b16"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey Id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Language Id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete all personal data in a survey | DELETE /gdpr/survey/{surveyId} | gdpr_survey_deletePersonalData"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /gdpr/survey/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes personal data of all participants for given surveyId","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"46251a3a-eade-42ba-988e-2773251fdda4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey Id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Leadership","type":"text"}]},{"type":"expand","attrs":{"title":"Add participants to pool | POST /loft/participants/pool/{sampleId} | loft_participants_importPoolParticipants"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /loft/participants/pool/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"add multiple feedback-participants from a CSV file to the participants pool using data from a CSV file. note this operation works on surveys of type \"leadership\" only","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"csvData\": \"CSV content\",\n \"returnIdentifierType\": \"u_email\",\n \"mappingColumn\": \"u_email\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 1,\n \"failed\": 1,\n \"failedRows\": [\n {\n \"line\": 1234,\n \"value\": \"Example\",\n \"errors\": [\n {\n \"column\": \"Example\",\n \"value\": \"Example\",\n \"details\": [\n {\n \"code\": \"Example\",\n \"translated\": \"Example\",\n \"type\": 1234\n }\n ]\n }\n ]\n }\n ],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"u_email\",\n \"externalReturnValue\": \"u_email\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a6ddb1e6-33f5-4f2c-a9f6-43878dfaf2b5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add participants to a feedback wave from CSV | POST /loft/participants/{sampleId} | loft_participants_importProcessParticipants"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /loft/participants/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"add multiple feedback-provider and -receiver from a CSV file to a feedback-wave using data from a CSV file. note this operation works on surveys of type \"leadership\" only","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"waveId\": 1,\n \"csvData\": \"CSV Import data\",\n \"returnIdentifierType\": \"u_email\",\n \"mappingColumn\": \"Mail\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 1,\n \"failed\": 1,\n \"failedRows\": [\n {\n \"line\": 1,\n \"value\": \"Example\",\n \"errors\": [\n {\n \"column\": \"Example\",\n \"value\": \"Example\",\n \"details\": [\n {\n \"code\": \"Example\",\n \"translated\": \"Example\",\n \"type\": 1234\n }\n ]\n }\n ]\n }\n ],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"u_email\",\n \"externalReturnValue\": \"Mail\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"6728bdc9-7d39-44ec-b53d-43d6dc60939c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get feedback center user data | GET /loft/participants/{project_id}/{fid} | loft_participants_getUserEmail"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /loft/participants/{project_id}/{fid}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get feedback center user data","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"Encoded Feedback Center data\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"1b02a837-57d4-41e8-b110-7f8977e3efd1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"project_id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Efs project id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"fid","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Feedback center user id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Check if user has access to feedback center | GET /loft/participants/{project_id}/{fid}/{token} | loft_participants_hasAccessToFeedbackCenter"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /loft/participants/{project_id}/{fid}/{token}","type":"text"}]},{"type":"paragraph","content":[{"text":"Check if user has access to feedback center for project","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"c9e2bdf8-3aad-489d-85b6-178f91a663b2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"project_id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Efs project id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"fid","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Feedback center user id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"token","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"token to validate request at data voyager ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"Example","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"MySight","type":"text"}]},{"type":"expand","attrs":{"title":"Update data of access panel groups | PATCH /mysight/groups/{instanceId} | mysight_groups_refreshAccountAdditionalData"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /mysight/groups/{instanceId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates additional data of configured panel groups for given mySight instance","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"0679481a-0435-4887-b176-9f899a228f6b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"instanceId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"mySight instanceId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"People Module / Panel","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Panel circles","type":"text"}]},{"type":"expand","attrs":{"title":"Add a new panel circle | POST /panel/circles/ | panel_circles_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/circles/","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a new panel circle (portals group), used in Portals","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"circleInitData\": {\n \"title\": \"People in my organization\",\n \"circleAccessType\": \"PRIVATE\",\n \"matchVar\": \"m_gcid_recode\",\n \"matchAgainstVar\": \"m_gcid_recode\",\n \"panelGroupId\": 1,\n \"startDateTime\": \"2021-01-09 09:00:00\",\n \"intervalType\": \"DAY\",\n \"intervalValue\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"circleId\": 123,\n \"title\": \"People in my organization\",\n \"circleType\": \"COMPANY_MANAGED\",\n \"circleAccessType\": \"PRIVATE\",\n \"circleProcessStatus\": \"IDLE\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Generate a managed circle | POST /panel/circles/generate/{id} | panel_circles_generate"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/circles/generate/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Generates a company managed panel circle (portals group)","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"71b29d0d-c8c1-4f81-ab69-5c6ad2f02cf8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel circle ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get list of panel circles by condition | POST /panel/circles/listByCondition | panel_circles_getListByCriteria"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/circles/listByCondition","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of panel circle objects to given logical condition. See ","type":"text"},{"text":"filtering results with conditions","type":"text","marks":[{"type":"link","attrs":{"href":"https://qbdocs.atlassian.net/wiki/spaces/DOC/pages/1273102351/How-to%3A+Service+Layer#Filtering-results-with-conditions"}}]},{"text":" for help on building conditions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"condition\": {\n \"join\": {\n \"operator\": \"AND\",\n \"condition1\": {\n \"comparison\": {\n \"variable\" : \"circleType\",\n \"operator\" : \"EQUAL\",\n \"value\" : \"USER_MANAGED\"\n }\n },\n \"condition2\": {\n \"inComparison\": {\n \"variable\": \"circleAccessType\",\n \"operator\": \"IN\",\n \"value\": [\"PUBLIC\", \"PRIVATE\"]\n }\n }\n }\n },\n \"offset\": 0,\n \"limit\": 10\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"circleId\": 1,\n \"title\": \"Example\",\n \"circleType\": \"USER_MANAGED\",\n \"circleAccessType\": \"PRIVATE\",\n \"circleProcessStatus\": \"IDLE\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Delete a panel circle | DELETE /panel/circles/{id} | panel_circles_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/circles/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a panel circle","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"afd18bf1-11ca-4e08-bc44-7ea9375fa595"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel circle ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get a panel circle | GET /panel/circles/{id} | panel_circles_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/circles/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns panel circle object to given circle ID","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"circleId\": 1,\n \"title\": \"Example\",\n \"circleType\": \"USER_MANAGED\",\n \"circleAccessType\": \"PRIVATE\",\n \"circleProcessStatus\": \"IDLE\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"dc56aa1d-08b1-4d74-89b6-8221c6fe35e0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel circle ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"External surveys management","type":"text"}]},{"type":"expand","attrs":{"title":"Delete an external survey | DELETE /panel/externalsurveys/ | panel_externalsurveys_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/externalsurveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an external study with all its participation data.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"internal_id\",\n \"identifierValue\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all external surveys | GET /panel/externalsurveys/ | panel_externalsurveys_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/externalsurveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves a list of all external surveys.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"externalSurveyId\": 1,\n \"externalSurveyExternalId\": \"1234\",\n \"externalSurveyTitle\": \"Example\",\n \"externalSurveyType\": 1234,\n \"externalSurveyAttributes\": [\n {\n \"attributeName\": \"Name\",\n \"attributeValue\": \"Example\"\n }\n ],\n \"externalSurveyModificationDate\": \"2020-07-02T12:53:50+00:00\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Update an existing external survey | PATCH /panel/externalsurveys/ | panel_externalsurveys_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/externalsurveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates an existing external survey with new attributes. The survey's external ID cannot be changed.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"internal_id\",\n \"identifierValue\": \"Example\",\n \"title\": \"Example\",\n \"type\": 1234,\n \"attributes\": [\n {\n \"attributeName\": \"Name\",\n \"attributeValue\": \"Example\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all external surveys after date | POST /panel/externalsurveys/ | panel_externalsurveys_getListModified"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/externalsurveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves a list of external surveys that were modified since a given timestamp","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"timestamp\": \"2020-07-02T12:53:50+00:00\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"externalSurveyId\": 1,\n \"externalSurveyExternalId\": \"1234\",\n \"externalSurveyTitle\": \"Example\",\n \"externalSurveyType\": 1234,\n \"externalSurveyAttributes\": [\n {\n \"attributeName\": \"Name\",\n \"attributeValue\": \"Example\"\n }\n ],\n \"externalSurveyModificationDate\": \"2020-07-02T12:53:50+00:00\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add external survey | POST /panel/externalsurveys/add | panel_externalsurveys_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/externalsurveys/add","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a new external survey, returns ID","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"title\": \"Example\",\n \"type\": 1234,\n \"attributes\": [\n {\n \"attributeName\": \"some_attribute\",\n \"attributeValue\": \"Example\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all data of a external survey | POST /panel/externalsurveys/data | panel_externalsurveys_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/externalsurveys/data","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieves the data of the external survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"internal_id\",\n \"identifierValue\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"externalSurveyId\": 1,\n \"externalSurveyExternalId\": \"123\",\n \"externalSurveyTitle\": \"Example\",\n \"externalSurveyType\": 1234,\n \"externalSurveyAttributes\": [\n {\n \"attributeName\": \"Name\",\n \"attributeValue\": \"Example\"\n }\n ],\n \"externalSurveyModificationDate\": \"2020-07-02T12:53:50+00:00\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add or update participation status of participants | POST /panel/externalsurveys/participants | panel_externalsurveys_addParticipants"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/externalsurveys/participants","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds or updates the participation status of multiple participants in an external survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"internal_id\",\n \"identifierValue\": \"Example\",\n \"panelistIdentifierType\": \"u_email\",\n \"surveyParticipations\": [\n {\n \"panelistIdentifierValue\": \"example@domain.tld\",\n \"participationStatus\": \"10\",\n \"participationDate\": \"2020-07-02T12:53:50+00:00\",\n \"participationPoints\": 1.345,\n \"participationScore\": 1.345\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Group categories","type":"text"}]},{"type":"expand","attrs":{"title":"Add group category | POST /panel/groups/category | panel_groups_addGroupCategory"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/groups/category","type":"text"}]},{"type":"paragraph","content":[{"text":"adds a new panel group category","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"categoryName\": \"Example\",\n \"categoryDescription\": \"Example description\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"categoryId\": 123,\n \"categoryName\": \"Example\",\n \"categoryDescription\": \"Example description\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get group category by Id | GET /panel/groups/category/{categoryId} | panel_groups_getGroupCategoryById"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/groups/category/{categoryId}","type":"text"}]},{"type":"paragraph","content":[{"text":"returns group category data","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"categoryId\": 2,\n \"categoryName\": \"Example\",\n \"categoryDescription\": \"Example description\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"d4c1a2cb-76b9-4b5d-99d3-3bfc0ef0a083"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"categoryId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel group category ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get group category by name | POST /panel/groups/categoryByName | panel_groups_getGroupCategoryByName"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/groups/categoryByName","type":"text"}]},{"type":"paragraph","content":[{"text":"returns group category data","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"categoryName\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"categoryId\": 2,\n \"categoryName\": \"Example\",\n \"categoryDescription\": \"Example description\"\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Groups","type":"text"}]},{"type":"expand","attrs":{"title":"Remove panelist from group | DELETE /panel/groups/ | panel_groups_removePanelists"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/groups/","type":"text"}]},{"type":"paragraph","content":[{"text":"Removes panelist from group (id)","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": 1234,\n \"identifierType\": \"u_email\",\n \"identifierValues\": [\n \"example@domain.tld\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add panel group | POST /panel/groups/ | panel_groups_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/groups/","type":"text"}]},{"type":"paragraph","content":[{"text":"add a new panel group, returns id of group","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"name\": \"Example\",\n \"description\": \"Example\",\n \"categoryId\": 1\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"123","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get panel groups | POST /panel/groups/list | panel_groups_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/groups/list","type":"text"}]},{"type":"paragraph","content":[{"text":"gets a list of panel groups, optionally restricted to a specific panel group category","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"restrictCategoryId\": 2\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"groupId\": 123,\n \"name\": \"Example\",\n \"description\": \"Example description\",\n \"size\": 1234,\n \"categoryId\": 2,\n \"categoryName\": \"Example\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Delete group | DELETE /panel/groups/{id} | panel_groups_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/groups/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete a panel group along with any panelist-group membership records plus any update rules for group. Panelist data of group members will not be deleted.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a0176ddb-04f9-422d-ba98-723843ca51a7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel group to be deleted ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add panelists to group | PATCH /panel/groups/{id} | panel_groups_addPanelists"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/groups/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"add panelists to an existing panel group","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValues\": [\n 123, 124, 125\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"58f700d2-1a47-41d7-8953-468eff610e45"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel group to be deleted ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get panelists of a group | POST /panel/groups/{id} | panel_groups_getGroupMembers"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/groups/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Supplies a list of panelists which are members in a given group","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"uid\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ \"123\", \"124\", \"125\" ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f30f359c-a55c-4d9f-84c0-065c4bc4dac2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel group to be deleted ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Remove all panelists from group | PUT /panel/groups/{id} | panel_groups_removePanelists"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /panel/groups/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"empty a panel group by deleting all members from it","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"772cd973-2eab-41fb-a2c1-239af8b5e7e7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel group to be deleted ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Lotteries","type":"text"}]},{"type":"expand","attrs":{"title":"Create price draw | POST /panel/lotteries/{gid} | panel_lotteries_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/lotteries/{gid}","type":"text"}]},{"type":"paragraph","content":[{"text":"Create prize draw, returns id","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"title\": \"Example\", \"description\": \"Description\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"09791594-cb10-48de-9f66-d6b854910c78"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"gid","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Panel group id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete a prize draw | DELETE /panel/lotteries/{id} | panel_lotteries_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/lotteries/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete prize draw. Includes deletion of prizes and winners.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"bff1d979-3881-430e-a7b6-235a3a51048b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Lottery id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get prize draw by ID | GET /panel/lotteries/{id} | panel_lotteries_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/lotteries/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get prize draw by prize draw ID. Provides prize draw object to access gratification and other parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": 2,\n \"title\": \"Example\",\n \"description\": \"Example\",\n \"status\": \"Created\",\n \"groupId\": 1\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"e19fa5d9-f6b9-42f3-9471-86e0aea36851"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Lottery id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update status of prize draw | PATCH /panel/lotteries/{id} | panel_lotteries_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/lotteries/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Update status of prize draw with given prize draw ID.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"status\": \"ARCHIVED\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"0b27f029-13e3-4ef2-8275-49eb066a5855"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Lottery id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete winner of prize draw | DELETE /panel/lotteries/{id}/winners | panel_lotteries_deleteWinners"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/lotteries/{id}/winners","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete winner","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"ac6cc88a-3a1f-44aa-80df-ad85b0b4b184"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Lottery id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get winners by prize draw id | GET /panel/lotteries/{id}/winners | panel_lotteries_getWinners"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/lotteries/{id}/winners","type":"text"}]},{"type":"paragraph","content":[{"text":"Get winners by prize draw id","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"grid\": 1234,\n \"prid\": 1234,\n \"uid\": 1234,\n \"status\": \"Example\",\n \"u_firstname\": \"Example\",\n \"u_name\": \"Example\",\n \"u_email\": \"example@domain.tld\",\n \"pricetitle\": \"Example\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"98aee100-af5b-4a82-8560-ba10db88ac0c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Lottery id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Master data","type":"text"}]},{"type":"expand","attrs":{"title":"Get all master data variables | GET /panel/masterdata/ | panel_masterdata_getDescriptionList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/masterdata/","type":"text"}]},{"type":"paragraph","content":[{"text":"returns the panel's master data variables along with their predefined answer codes","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"varname\": \"m_0000\",\n \"label\": \"Country\",\n \"type\": \"int\",\n \"typeGroup\": \"numeric\",\n \"recoded\": false,\n \"categories\": [\n {\n \"code\": 3,\n \"label\": \"USA\"\n },\n {\n \"code\": 2,\n \"label\": \"United Kingdom\"\n },\n {\n \"code\": 1,\n \"label\": \"Germany\"\n },\n {\n \"code\": 0,\n \"label\": \"Please select\"\n }\n ]\n },\n {...}\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add master data variable | POST /panel/masterdata/ | panel_masterdata_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/masterdata/","type":"text"}]},{"type":"paragraph","content":[{"text":"add masterdata variable","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"name\": \"m_9988\",\n \"label\": \"m_9988 Label\",\n \"type\": \"tinyint\",\n \"category\": 1,\n \"optional\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"m_9988\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get master data variables modified after | GET /panel/masterdata/{modificationDate}/list | panel_masterdata_getDescriptionListV2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/masterdata/{modificationDate}/list","type":"text"}]},{"type":"paragraph","content":[{"text":"returns the panel's master data variables along with their predefined answer codes, which were modified after ","type":"text"},{"text":"modificationDate","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"varname\": \"m_9988\",\n \"label\": \"Example\",\n \"type\": \"smallint\",\n \"typeGroup\": \"Example\",\n \"recoded\": true,\n \"categories\": [\n {\n \"code\": 1234,\n \"label\": \"Example\",\n \"isMissing\": true\n }\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"8db3936b-8313-42d1-a89a-f78d47c9adfc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"modificationDate","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"variables with modification date newer than given parameter will be respected (timestamp) ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"1599147158","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Panelists","type":"text"}]},{"type":"expand","attrs":{"title":"Delete a panelist | DELETE /panel/panelists/ | panel_panelists_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/panelists/","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete panelist","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Update panelists from CSV | PATCH /panel/panelists/ | panel_panelists_changeCSV"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/panelists/","type":"text"}]},{"type":"paragraph","content":[{"text":"change multiple panelists' account data from a CSV file (batch operation)","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"u_email\",\n \"csvData\": \"csv content\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 1,\n \"failed\": 1,\n \"failedRows\": [\n {\n \"line\": 2,\n \"errors\": [\n {\n \"column\": \"Example\",\n \"value\": \"Example\",\n \"details\": [\n {\n \"code\": \"Example\",\n \"translated\": \"Example\",\n \"type\": 1234\n }\n ]\n }\n ]\n }\n ],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"Example\",\n \"externalReturnValue\": \"Example\"\n }\n ]\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add panelist | POST /panel/panelists/v1 | panel_panelists_addV1"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/v1","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a panelist to the panel. Fields ","type":"text"},{"text":"u_email, u_firstname, u_name, u_passwd","type":"text","marks":[{"type":"code"}]},{"text":" are required.","type":"text"},{"type":"hardBreak"},{"text":"Please note, that ","type":"text"},{"text":"POST /panel/panelists","type":"text","marks":[{"type":"code"}]},{"text":" (without v1) is deprecated and should no longer be used.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"uid\",\n \"panelistData\": {\n \"u_account\": \"Example\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_street\": \"Example\",\n \"u_zip\": \"12345\",\n \"u_city\": \"Example\",\n \"u_phone\": \"+4912345\",\n \"u_email\": \"example@domain.tld\",\n \"u_www\": \"Example\",\n \"u_address\": \"Example\",\n \"u_country\": \"Example\",\n \"u_other_id\": \"123\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_address2\": \"Example\",\n \"u_address3\": \"Example\",\n \"u_mobile\": \"Example\",\n \"u_mobile2\": \"Example\",\n \"pci\": 127,\n \"masterDataValues\": [\n {\n \"key\": \"m_0000\",\n \"value\": \"12\"\n }\n ],\n \"u_sec_quest\": \"Example\",\n \"u_sec_quest_answer\": \"Example\",\n \"site_id\": 1,\n \"u_timezone\": \"+0:00\",\n \"gc_id\": 1,\n \"u_passwd\": \"Example\",\n \"gid\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"123\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add panelists from CSV | POST /panel/panelists/csv | panel_panelists_addCSV"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/csv","type":"text"}]},{"type":"paragraph","content":[{"text":"add multiple panelists from a CSV file to the panel (batch operation)","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"uid\",\n \"csvData\": \"Csv Data here\",\n \"mappingColumn\": \"email\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 1,\n \"failed\": 1,\n \"failedRows\": [\n {\n \"line\": 2,\n \"errors\": [\n {\n \"column\": \"Email\",\n \"value\": \"example@domain.tld\",\n \"details\": [\n {\n \"code\": \"Example\",\n \"translated\": \"Example\",\n \"type\": 1234\n }\n ]\n }\n ]\n }\n ],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"123\",\n \"externalReturnValue\": \"example@domain.tld\"\n }\n ]\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get panelist | POST /panel/panelists/details | panel_panelists_getV1"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/details","type":"text"}]},{"type":"paragraph","content":[{"text":"get information about a panelist","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If no panelist is found, this service will return a 500 error.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"u_account\": \"Example\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_street\": \"Example\",\n \"u_zip\": \"12345\",\n \"u_city\": \"Example\",\n \"u_phone\": \"+4912345\",\n \"u_email\": \"example@domain.tld\",\n \"u_www\": \"Example\",\n \"u_address\": \"Example\",\n \"u_country\": \"Example\",\n \"u_other_id\": \"12345\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_address2\": \"Example\",\n \"u_address3\": \"Example\",\n \"u_mobile\": \"+4912345\",\n \"u_mobile2\": \"+4912345\",\n \"masterDataValues\": [\n {\n \"key\": \"m_0000\",\n \"value\": \"1\"\n }\n ],\n \"site_id\": 1,\n \"u_timezone\": \"+0:00\",\n \"gc_id\": 10,\n \"uid\": 123\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Update panelist | PUT /panel/panelists/details | panel_panelists_changeV1"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /panel/panelists/details","type":"text"}]},{"type":"paragraph","content":[{"text":"Change an existing panelist's data","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"panelistData\": {\n \"u_firstname\": \"NewFirst\",\n \"u_name\": \"NewLast\",\n \"masterDataValues\": [\n {\n \"key\": \"m_0001\",\n \"value\": \"2\"\n }\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Delete external authentication mapping | DELETE /panel/panelists/external | panel_panelists_deleteExternalAuthentication"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /panel/panelists/external","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes an external authentication mapping from EFS. Please note: Only the mapping will be deleted. The panelist will not be removed from EFS.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"externalServiceId\": 1234,\n \"externalAuthenticationValue\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Create an external authentication mapping | POST /panel/panelists/external | panel_panelists_saveExternalAuthentication"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/external","type":"text"}]},{"type":"paragraph","content":[{"text":"Establishes a mapping between a member of an external system (specified by the external_service_id and the external_service_authentication_value) and an EFS panelist. This can be used to implement seamless logins for EFS panelists coming from external web applications.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"externalServiceId\": 1,\n \"externalAuthenticationValue\": \"Example\",\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get EFS identifier for external system | POST /panel/panelists/external/{externalServiceId} | panel_panelists_getExternalAuthentication"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/external/{externalServiceId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the EFS identifier for a member of an external system. If the member has not been registered in EFS using the save_external_panelist_authentication web service before, this service will throw an exception.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"externalAuthenticationValue\": \"Example\",\n \"identifierReturnType\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"Example\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"7ea7d72e-f054-438d-b572-4475d09186a3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"externalServiceId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The external ID. ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get panelists in a group | POST /panel/panelists/group/{groupId}/list | panel_panelists_getListByGroup"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/group/{groupId}/list","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of panelists in a specific panel group","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"returnDataFields\": [ \"Example\" ] }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ [ \"Example\" ] ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"99140874-3a20-4597-a9be-93b7e45907b7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"groupId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel group ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get all groups of a panelist | POST /panel/panelists/groups | panel_panelists_getGroupMembership"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/groups","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of panel groups in which the panelist is a member","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"panelGroupId\": 10,\n \"panelGroupName\": \"Example\",\n \"panelGroupStatus\": \"ACTIVE\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get panelists of a sample | POST /panel/panelists/list | panel_panelists_getListBySample"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/list","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of panelists matched by a specific panel survey sample","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sampleId\": 1,\n \"returnDataFields\": [\n \"u_email\",\n \"uid\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n [\n \"example@domain.tld\",\n \"123\"\n ]\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Test if panelists exist | POST /panel/panelists/list/find | panel_panelists_getListByIdentifiers"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/list/find","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of actual panelists from a list of possible panelist identifiers using this service it can be checked if specific panelists are already contained in the panel or not","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"u_email\",\n \"identifierList\": [\n \"example@domain.tld\", \"example2@domain.tld\"\n ],\n \"returnDataFields\": [\n \"uid\",\n \"u_email\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n [\n \"215\",\n \"example2@domain.tld\"\n ],\n [\n \"214\",\n \"example@domain.tld\"\n ]\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Check if panelist can login with provided credentials | POST /panel/panelists/login | panel_panelists_isValidLogin"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/login","type":"text"}]},{"type":"paragraph","content":[{"text":"Checks whether a panelist can login to the panel website with the login data specified.","type":"text"}]},{"type":"paragraph","content":[{"text":"Login types: login_type_interviewer, login_type_email or login_type_account","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"loginType\": \"login_type_account\",\n \"account\": \"example\",\n \"password\": \"Example123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Send mail to panelists | POST /panel/panelists/mail | panel_panelists_sendMail"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/mail","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends mails to one or more panelists by a specific identifier","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValues\": [\n \"123\"\n ],\n \"mailTemplate\": {\n \"subject\": \"Example\",\n \"textContent\": \"Example\",\n \"htmlContent\": \"Example\",\n \"charset\": \"UTF-8\",\n \"replyTo\": \"example@domain.tld\",\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\",\n \"toRealname\": true,\n \"from\": \"example@domain.tld\",\n \"fromRealname\": \"Example\"\n },\n \"dispcodes\": [\n \"10\"\n ],\n \"sendOptions\": {\n \"sendDate\": \"2020-07-02T12:53:50+00:00\",\n \"useRecipientTimezone\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Increment/decrement a master data variable | PATCH /panel/panelists/masterdata | panel_panelists_incrementValue"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/panelists/masterdata","type":"text"}]},{"type":"paragraph","content":[{"text":"increment/decrement a master data variable's value for one or multiple panelists","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierList\": [\n \"123\"\n ],\n \"variableName\": \"m_starcount\",\n \"step\": 1\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get master data values for panelist | POST /panel/panelists/masterdata | panel_panelists_getValue"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/masterdata","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a master data variable's value for panelist","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"variableName\": \"m_starcount\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"12\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all modified panelists since timestamp | POST /panel/panelists/modified | panel_panelists_getListOfModified"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/modified","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the identifiers of all panelists whose data (participant data plus master data) has changed since this given timestamp. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"modificationDate\": \"2020-07-02T12:53:50+00:00\",\n \"excludeModifier\": 0\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"identifier\": \"123\" } ]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Return all online panelists of a website | POST /panel/panelists/online | panel_panelists_getOnline"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/online","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the panelists who are online on the website. Panelists are returned as an array of e-mail addresses, pseudonyms, panelist codes etc. together with the language ID of the website they are active on. A panelist might be active in multiple languages at the same time (e.g. by viewing the English version of the website and then changing to the French version). In this case, the panelist will be returned twice in the result array, but with different language IDs each. The interval for counting as being online can be specified in the global configuration of the website in the EFS admin area.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierReturnType\": \"uid\",\n \"languageIds\": [\n {\n \"langId\": 1234\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"panelist_identifier_value\": \"123\",\n \"language_id\": 1234\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get panel status of panelist | POST /panel/panelists/status | panel_panelists_getStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/status","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the current panel status of a panelist and accepts single uid only if given.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"identifierType\": \"uid\", \"identifierValue\": \"123\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"2","type":"text"}]}]},{"type":"expand","attrs":{"title":"Update panel status of panelist | PATCH /panel/panelists/setstatus | panel_panelists_updateStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/panelists/setstatus","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates the panel status of a panelist.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"u_email\",\n \"identifierValue\": \"example@domain.tld\",\n \"status\": 2\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add panelist to survey | POST /panel/panelists/survey/{surveyId} | panel_panelists_addToSurvey"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/survey/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a panelist to a panel or master data survey. Valid options for ","type":"text"},{"text":"resetParticipation","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"reset_if_completed, reset_always, reset_delete_if_completed, reset_delete_always, reset_no_change","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"resetParticipation\": \"reset_if_completed\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sampleId\": 1,\n \"dispositionCode\": \"10\",\n \"code\": \"Example\",\n \"isTester\": false,\n \"link\": \"http://Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"8992e122-1f83-4565-8781-36824535f6bc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the panel or masterdata survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add panelist to sample | POST /panel/panelists/{sampleId} | panel_panelists_addToSample"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a panelist to a sample. Valid options for ","type":"text"},{"text":"resetParticipation","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"reset_if_completed, reset_always, reset_delete_if_completed, reset_delete_always, reset_no_change","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"resetParticipation\": \"reset_if_completed\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sampleId\": 1,\n \"dispositionCode\": \"10\",\n \"code\": \"Example\",\n \"isTester\": false,\n \"link\": \"http://Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"192b2607-602f-4f7c-be38-625110ed1223"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel survey sample ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get panelists by filter | POST /panel/panelists/{filterId}/list | panel_panelists_getListByFilter"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/{filterId}/list","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of panelists matched by a specific panel grouping filter","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"returnDataFields\": [ \"u_email\" ] }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ [ \"example@domain.tld\" ] ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b3670910-5291-42b4-a60d-589294b5996c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"filterId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of panel grouping filter ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Bonus points","type":"text"}]},{"type":"expand","attrs":{"title":"Reset bonus points of panelists | PATCH /panel/panelists/bonuspoints | panel_panelists_resetBonusPoints"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /panel/panelists/bonuspoints","type":"text"}]},{"type":"paragraph","content":[{"text":"Reset the bonus points of one or multiple panelists to zero. This action will also add a note to each panelists' bonus points balance so panelists get informed about the nullification. If a panelist already has a balance of zero points, no additional note will be added to his/her points log","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierList\": [\n \"123\"\n ],\n \"description\": \"Example bonus points reset\"\n}","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get bonus points of a panelist | POST /panel/panelists/bonuspoints | panel_panelists_getBonusPoints"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/bonuspoints","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the bonus points of a given panelist.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1345","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add or subtract bonus points to a panelist | PUT /panel/panelists/bonuspoints | panel_panelists_modifyPoints"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /panel/panelists/bonuspoints","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds or subtracts bonus points for a panelist's account. The panelist can be identified by different criteria (uid, panelist code, pseudonym etc.). The transaction will be shown in the panelists' account balance history afterwards.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"pointsValue\": 10,\n \"pointsReason\": \"Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1355","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get changes to bonus balance since last call | POST /panel/panelists/bonuspoints/balance | panel_panelists_getPointsStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/bonuspoints/balance","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the account balance/bonus points positions for all panelists of the installation that happened since the last call to the service. This method can be used to do a regular, incremental replication of the panel's bonus points to another application (where EFS is used as the master system for managing the points). The panelist identifier for the returned balance positions can be uid, panelist code, pseudonym etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"uid\",\n \"fetchAll\": true,\n \"logTransfer\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"panelist_identifier_value\": \"123\",\n \"item_type\": 0,\n \"survey_id\": 1701,\n \"points_id\": 6,\n \"description\": \"Participation in survey Demo\",\n \"credit_points\": 10,\n \"date\": \"2018-07-05T08:37:57+00:00\",\n \"paid\": 0,\n \"paid_date\": \"\",\n \"alt_address\": \"\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get bonus point balance positions of a panelist | POST /panel/panelists/bonuspoints/balance/find | panel_panelists_getPointsHistory"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/bonuspoints/balance/find","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the account balance/bonus points positions for a panelist that happened in the last months. The panelist can be identified by different criteria (user_id, panelist code, pseudonym etc.).","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123,\n \"monthsRange\": 1,\n \"skipEmpty\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"panelist_identifier_value\": \"123\",\n \"item_type\": 0,\n \"survey_id\": 1701,\n \"points_id\": 6,\n \"description\": \"Participation in survey Demo\",\n \"credit_points\": 10,\n \"date\": \"2018-07-05T08:37:57+00:00\",\n \"paid\": 0,\n \"paid_date\": \"\",\n \"alt_address\": \"\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Add bonus points to multiple panelists | POST /panel/panelists/bonuspoints/{surveyId} | panel_panelists_grantBonusPointsForSurveyParticipation"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/bonuspoints/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Manually grants bonus points to a list of panelists for participation in a panel or master data survey. Successful requests have no response body.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierList\": [\n \"123\", \"124\", \"125\"\n ],\n \"points\": 10,\n \"description\": \"Example bonus points\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"c87abd38-a724-4c1c-b2a1-51834c37790d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Id of the panel or master data survey. ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get all bonus point redemptions since last call | POST /panel/panelists/redemption | panel_panelists_getRedemptionStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/panelists/redemption","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the bonus points redemption positions for all panelists of the installation that happened since the last call to the service. This method can be used to do a regular, incremental replication of the panel's bonus points redemption to another application (where EFS is used as the master system for managing the points). The panelist identifier for the returned redemption can be user_id, panelist code, pseudonym etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"fetchAll\": true,\n \"logTransfer\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"panelist_identifier_value\": \"Example\",\n \"item_type\": 1234,\n \"survey_id\": 1234,\n \"points_id\": 1234,\n \"description\": \"Example\",\n \"credit_points\": 1.345,\n \"date\": \"Example\",\n \"paid\": 1234,\n \"paid_date\": \"Example\",\n \"alt_address\": \"Example\",\n \"voucher_code\": \"Example\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Invite Friends: Check invitation status of email | POST /panel/promotions/ | panel_promotions_getStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/promotions/","type":"text"}]},{"type":"paragraph","content":[{"text":"This service can be used to check whether an e-mail address has already been entered into the promotional system and what its status is. Invited only or already converted into a panelist.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"recipientEmail\": \"example@domain.tld\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"status\": 1234,\n \"code\": \"Example\",\n \"date_invited\": \"2018-07-05T08:37:57+00:00\",\n \"date_converted\": \"2018-07-05T08:40:00+00:00\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Invite Friends: Send mail | PUT /panel/promotions/ | panel_promotions_tellafriend"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /panel/promotions/","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends an invitation as e-mail to a friend.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"promotionId\": 1234,\n \"recipientEmail\": \"example@domain.tld\",\n \"header\": \"Example text\",\n \"footer\": \"Example text\",\n \"panelistUid\": 123\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Send mail to sample | POST /panel/samples/ | panel_samples_sendMail"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/samples/","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends mails to every panelist in the sample","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sampleId\": 1,\n \"mailTemplate\": {\n \"subject\": \"Example\",\n \"textContent\": \"Example\",\n \"htmlContent\": \"Example\",\n \"charset\": \"UTF-8\",\n \"replyTo\": \"Example\",\n \"returnPath\": \"Example\",\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\",\n \"toRealname\": true,\n \"from\": \"Example\",\n \"sms_from\": \"Example\",\n \"sms_content\": \"Example\",\n \"cc\": \"Example\",\n \"bcc\": \"Example\",\n \"fromRealname\": \"Example\"\n },\n \"dispcodes\": [\n \"10\"\n ],\n \"sendOptions\": {\n \"sendDate\": \"2020-07-02T12:53:50+00:00\",\n \"useRecipientTimezone\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Panel statistics","type":"text"}]},{"type":"expand","attrs":{"title":"Get panel status distribution | GET /panel/statistics/status | panel_statistics_getStatus"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/statistics/status","type":"text"}]},{"type":"paragraph","content":[{"text":"Panel status distribution","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"code\": \"1\",\n \"label\": \"Admitted temporarily\",\n \"value\": 26,\n \"ratio\": 0.19259259259259\n },\n {\n \"code\": \"2\",\n \"label\": \"Active\",\n \"value\": 93,\n \"ratio\": 0.68888888888889\n }, ...\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Dynamic panel status distribution | POST /panel/statistics/status | panel_statistics_getVariables"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/statistics/status","type":"text"}]},{"type":"paragraph","content":[{"text":"Dynamic panel status distribution","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"panelStatisticsFilter\": {\n \"panelCategoryId\": 1234,\n \"panelGroupId\": 1234,\n \"siteId\": 1234,\n \"filterId\": 1234,\n \"from\": \"2020-07-01T12:53:50+00:00\",\n \"to\": \"2020-07-03T12:53:50+00:00\",\n \"panelistStatus\": [\n 1234\n ],\n \"attributes\": [\n \"Example\"\n ],\n \"masterdata\": [\n \"Example\"\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n [\n {\n \"code\": \"Example\",\n \"label\": \"Example\",\n \"value\": 1234,\n \"ratio\": 1.345\n }\n ]\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all surveys of panelist | POST /panel/surveys/ | panel_surveys_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/surveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"get the list of surveys for a panelist","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"identifierType\": \"uid\", \"identifierValue\": \"123\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 1234,\n \"title\": \"Example\",\n \"titleGlobal\": \"Example\",\n \"description\": \"Example\",\n \"author\": \"Example\",\n \"staff\": \"Example\",\n \"comment\": \"Example\",\n \"url\": \"http://qb-feedback.com/\",\n \"fieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-07-02T12:53:50+00:00\"\n },\n \"type\": \"ANONYMOUS\",\n \"bonusPoints\": {\n \"label\": \"Example\",\n \"value\": 1.345\n },\n \"participantsLeft\": 1234\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get completed surveys of panelist | POST /panel/surveys/list | panel_surveys_getListCompleted"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /panel/surveys/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the list of EFS Panel surveys (surveys of type panel survey or master data survey) a panelist has completed so far","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"identifierType\": \"uid\", \"identifierValue\": \"123\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"surveyId\": 1234,\n \"surveyTitle\": \"Some Title\",\n \"surveyDescription\": \"Example\",\n \"surveyType\": \"ANONYMOUS\",\n \"completionReward\": 1.345,\n \"completionDate\": \"2020-07-02T12:53:50+00:00\"\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all panel variables | GET /panel/variables/ | panel_variables_getDescriptionList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/variables/","type":"text"}]},{"type":"paragraph","content":[{"text":"returns the panel's variables along with their predefined answer codes (if any)","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"varname\": \"m_0000\",\n \"label\": \"Country\",\n \"type\": \"int\",\n \"typeGroup\": \"numeric\",\n \"recoded\": false,\n \"categories\": [\n {\n \"code\": 3,\n \"label\": \"USA\"\n },\n {\n \"code\": 2,\n \"label\": \"United Kingdom\"\n },\n {\n \"code\": 1,\n \"label\": \"Germany\"\n },\n {\n \"code\": 0,\n \"label\": \"Please select\"\n }\n ]\n }, ...\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get all panel websites | GET /panel/websites/ | panel_websites_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /panel/websites/","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of panel websites","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 4,\n \"name\": \"Panel Website\",\n \"description\": \"\",\n \"isDefault\": true,\n \"languages\": [\n {\n \"id\": 7,\n \"name\": \"english\",\n \"isDefault\": true\n }\n ]\n }\n]","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Portals","type":"text"}]},{"type":"expand","attrs":{"title":"Get portal export | GET /portal/portal/export/{portalId} | portal_portal_exportPortal"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /portal/portal/export/{portalId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get portal export by portalId","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"{\\\"isPortalCopy\\\":true,\\\"metaData\\\":{\\\"name\\\":\\\"[...]\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"3225efed-c526-4510-a4bb-6f0b08ca4e4c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"portalId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Export portal with this ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Import portal | POST /portal/portal/import | portal_portal_importPortal"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /portal/portal/import","type":"text"}]},{"type":"paragraph","content":[{"text":"Import portal by using previous export","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"portalData\": \"{\\\"isPortalCopy\\\":true,\\\"metaData\\\":{\\\"name\\\":\\\"[...]\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"123\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Validate extension API token of panelist | POST /portal/users/getUserDataByToken | portal_users_getUserDataByToken"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /portal/users/getUserDataByToken","type":"text"}]},{"type":"paragraph","content":[{"text":"Checks whether API-token is valid (not expired). Returns userId and portalId. Otherwise will throw an exception.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"apiToken\": \"Example123\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"portalUserId\": \"123\", \"portalId\": \"123\" }","type":"text"}]}]},{"type":"expand","attrs":{"title":"Invite panelists to portal | PUT /portal/users/invitePanelistToPortal | portal_users_invitePanelistToPortal"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /portal/users/invitePanelistToPortal","type":"text"}]},{"type":"paragraph","content":[{"text":"Invite Panelists to Portal","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierList\": [\n \"123\"\n ],\n \"portalId\": 1234,\n \"mailTemplateId\": 1234\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get login code | POST /portal/users/logincode | portal_users_getTmpLoginCode"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /portal/users/logincode","type":"text"}]},{"type":"paragraph","content":[{"text":"Get tmp login code","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"identifierType\": \"uid\", \"identifierValue\": \"123\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"1233ffaa123...\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Set roles of users in portal | POST /portal/users/setUserRoles | portal_users_setUserRolesInPortal"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /portal/users/setUserRoles","type":"text"}]},{"type":"paragraph","content":[{"text":"Set role(s) for user(s) in portal","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"portalUsersRolesList\": [\n {\n \"portalUserId\": \"123\",\n \"userRoleList\": [\n \"1\", \"3\"\n ]\n }\n ],\n \"portalId\": \"1\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Survey","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Languages","type":"text"}]},{"type":"expand","attrs":{"title":"Get all languages in a Survey | GET /survey/languages/{surveyId} | survey_languages_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/languages/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"get a list of all languages in a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"label\": \"German\",\n \"localestring\": \"de_DE\",\n \"languageId\": 1,\n \"isStandard\": true\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f5aeaa8a-ee67-4ef4-8850-13b78dda3ea0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get a language by id | GET /survey/languages/{surveyId}/{languageId} | survey_languages_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/languages/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"get a language","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"label\": \"German\",\n \"localestring\": \"de_DE\",\n \"languageId\": 1,\n \"isStandard\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"490f5ae1-c23e-42bf-a4ab-fa333c2c9089"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"languageId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add a new language | POST /survey/languages/{surveyId} | survey_languages_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/languages/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"adds a new language","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"language\": {\n \"label\": \"English\",\n \"localestring\": \"en_GB\",\n \"adoptTranslationFromId\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"408e7bd0-0d2d-43ca-bbd8-ba61470acb19"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Change a language | PATCH /survey/languages/{surveyId} | survey_languages_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/languages/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"change language data","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"language\": {\n \"label\": \"Deutsch\",\n \"localestring\": \"de_DE\",\n \"languageId\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"41f57e7c-3f45-4d5e-8d79-4dee7fb5ab55"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete a language | DELETE /survey/languages/{surveyId} | survey_languages_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/languages/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"deletes a language","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"languageId\": 1 }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"bffcaa1d-36ed-49db-9df7-a3f012c84af3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Layouts","type":"text"}]},{"type":"expand","attrs":{"title":"Get list of layouts | GET /survey/layouts/ | survey_layouts_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/layouts/","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of all survey layouts the user has access to","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"layoutId\": 1, \"name\": \"Example\" } ]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get list of layouts by criteria | POST /survey/layouts/find | survey_layouts_getListByCriteria"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/layouts/find","type":"text"}]},{"type":"paragraph","content":[{"text":"returns a list of survey layouts the user has access to, based on search criteria. See ","type":"text"},{"text":"filtering results with conditions","type":"text","marks":[{"type":"link","attrs":{"href":"https://qbdocs.atlassian.net/wiki/spaces/DOC/pages/1273102351/How-to%3A+Service+Layer#Filtering-results-with-conditions"}}]},{"text":" for help on building conditions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"logicalCondition\": {\n \"comparison\": {\n \"variable\": \"title\",\n \"operator\": \"CONTAINS\",\n \"value\": \"Example\"\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"layoutId\": 1, \"name\": \"Example Layout\" } ]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Apply layout to a survey project | PATCH /survey/layouts/{surveyId} | survey_layouts_apply"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/layouts/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Applies a survey layout in a specific survey.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"layoutId\": 1 }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a5e09bc0-322f-4f60-b891-75f304977b4e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Static lists","type":"text"}]},{"type":"expand","attrs":{"title":"Get static lists of a survey | GET /survey/lists/{surveyId} | survey_lists_getStaticListsList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/lists/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the list of available static lists for a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"listId\": 1234, \"label\": \"Example\" } ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"ad2ce4b5-d83e-49b0-97e1-9a9b3fa3ca53"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Create a static list | POST /survey/lists/{surveyId} | survey_lists_createStaticList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/lists/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the ID of the created static list","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"label\": \"Example\",\n \"placeholder\": \"example\",\n \"delimiter\": \", \",\n \"lastDelimiter\": \" and \"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"123","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"25dbb29c-c5f8-4df4-9042-99bed1c1e3ff"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete a static list | DELETE /survey/lists/{surveyId}/{listId} | survey_lists_deleteList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/lists/{surveyId}/{listId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a list","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f9180793-f642-43e6-aa67-ce3f38ce0c97"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"listId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"list id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add elements to static list | PUT /survey/lists/{surveyId} | survey_lists_addStaticListElements"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/lists/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds an array of static list elements","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"listId\": 1,\n \"items\": [\n {\n \"number\": 1,\n \"label\": \"Apples\"\n },\n {\n \"number\": 2,\n \"label\": \"Oranges\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ 1, 2 ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"5ad04a2f-e4bf-4957-bdb2-649d711e49fe"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add a single element to static list | PUT /survey/lists/{surveyId}/{listId} | survey_lists_addStaticListElement"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/lists/{surveyId}/{listId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a static list element","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"label\": \"Pears\",\n \"number\": 3\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"c5a3ea2d-fe7a-46ac-9851-6205535d30e9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"listId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"list id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Clear static list | DELETE /survey/lists/{surveyId}/{listId}/elements | survey_lists_clearList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/lists/{surveyId}/{listId}/elements","type":"text"}]},{"type":"paragraph","content":[{"text":"Clears a list","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"1724cb7e-9fdf-43da-8f70-a65c249d7678"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"listId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of list ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Participants","type":"text"}]},{"type":"expand","attrs":{"title":"Add participants | POST /survey/participants/v2/{sampleId} | survey_participants_addListV2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/participants/v2/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Add multiple participants to a survey. Only ","type":"text"},{"text":"u_email","type":"text","marks":[{"type":"code"}]},{"text":" is required and you can skip all other fields. Additional participant variables can be filled through ","type":"text"},{"text":"additionalFields","type":"text","marks":[{"type":"code"}]},{"text":". When providing ","type":"text"},{"text":"u_passwd","type":"text","marks":[{"type":"code"}]},{"text":", please note that this field needs to be unique. Valid options for ","type":"text"},{"text":"returnIdentifierType","type":"text","marks":[{"type":"code"}]},{"text":" are ","type":"text"},{"text":"u_email","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"code","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"uid. u_email","type":"text","marks":[{"type":"em"}]},{"text":" is only available if ","type":"text"},{"text":"allowDuplicateEmails","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"false","type":"text","marks":[{"type":"em"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"POST /survey/participants/{sampleId}","type":"text","marks":[{"type":"code"}]},{"text":", without v2, should no longer be used, as it was replaced with this call. To migrate your application to the new call, add ","type":"text"},{"text":"allowDuplicateEmails","type":"text","marks":[{"type":"code"}]},{"text":" to the old request and change the end point to ","type":"text"},{"text":"…/v2/","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Also, in personalised projects, the sampleId is the surveyId plus 1.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"code\",\n \"participantList\": [\n {\n \"u_passwd\": \"123456\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_email\": \"example@domain.tld\",\n \"u_mobile\": \"0049123456\",\n \"u_title\": \"Dr.\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_group\": 1,\n \"u_language\": 1,\n \"u_timezone\": \"+0:00\",\n \"additionalFields\": [\n {\n \"key\": \"u_example\",\n \"value\": \"test\"\n }\n ]\n }\n ],\n \"allowDuplicateEmails\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ \"fd68114f34314916\" ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f6e2e137-3cd1-4c28-b619-4a5a60e5af42"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add participants, asynchronous | POST /survey/participants/v3/{sampleId} | survey_participants_addListAsynchronous"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/participants/v3/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Add multiple participants to a survey via task queue. Returns ","type":"text"},{"text":"taskId","type":"text","marks":[{"type":"em"}]},{"text":" which has to be used to get results via ","type":"text"},{"text":"GET /efs/taskqueue/{taskId}","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"This is the recommended call for importing bigger batches of participants to a survey and this call is request body compatible to /v2.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"returnIdentifierType\": \"u_email\",\n \"participantList\": [\n {\n \"u_passwd\": \"123456\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_email\": \"example@domain.tld\",\n \"u_mobile\": \"0049123456\",\n \"u_title\": \"Dr.\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_group\": 1,\n \"u_language\": 1,\n \"u_timezone\": \"+0:00\",\n \"additionalFields\": [\n {\n \"key\": \"u_example\",\n \"value\": \"test\"\n }\n ]\n }\n ],\n \"allowDuplicateEmails\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"88437c70-4229-47ae-b6af-8247cbe958c8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add participants from CSV | POST /survey/participants/{sampleId}/csv | survey_participants_importCSV"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/participants/{sampleId}/csv","type":"text"}]},{"type":"paragraph","content":[{"text":"Add multiple participants from a CSV file to a survey or update existing participants using data from a CSV file. Note: this operation works on surveys of type \"personalized\" only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Unlike in the interface, the first row of the CSV data needs to have the correct column labels from the import template of the project. Only ","type":"text"},{"text":"u_email","type":"text","marks":[{"type":"em"}]},{"text":" is required.","type":"text"}]},{"type":"paragraph","content":[{"text":"This call corresponds to the participant import of the participant administration.","type":"text"}]},{"type":"paragraph","content":[{"text":"returnIdentifierType","type":"text","marks":[{"type":"code"}]},{"text":" returns the specified identifier variable as ","type":"text"},{"text":"internalReturnValue","type":"text","marks":[{"type":"code"}]},{"text":", usually you will want to know the “uid” of the participant.","type":"text"}]},{"type":"paragraph","content":[{"text":"mappingColumn","type":"text","marks":[{"type":"code"}]},{"text":" returns the specified participant variable as ","type":"text"},{"text":"externalReturnValue","type":"text","marks":[{"type":"code"}]},{"text":". This can used to store back information in your system, e.g. by uploading u_crm_id in your CSV data and using that variable as a mappingColumn.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"csvData\": \"u_email,u_first,u_name\\nexample@domain.tld,First,Last\\nexample2@domain.tld,First2,Last2\",\n \"returnIdentifierType\": \"uid\",\n \"allowDuplicateEmails\": true,\n \"mappingColumn\": \"u_email\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 3,\n \"failed\": -1,\n \"failedRows\": [],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"1\",\n \"externalReturnValue\": \"example@domain.tld\"\n },\n {\n \"internalReturnValue\": \"2\",\n \"externalReturnValue\": \"example2@domain.tld\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a6d877f7-bebf-4376-97cc-4cda991d3a3d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to or to update the participants in ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Add participants and survey data from CSV | POST /survey/participants/{sampleId}/csv2 | survey_participants_importParticipantAndSurveyResultFromCSV"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/participants/{sampleId}/csv2","type":"text"}]},{"type":"paragraph","content":[{"text":"Add multiple participants and optionally survey results from a CSV file to a survey or update existing participants using data from a CSV file. Note: this operation works on surveys of type “personalized” or “employee” only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Unlike in the interface, the first row of the CSV data needs to have the correct column labels from the import template of the project. Unless status is specified, the disposition code will be automatically set to","type":"text"},{"text":" 31 - Completed","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"This call corresponds to the results import of the participant administration.","type":"text"}]},{"type":"paragraph","content":[{"text":"returnIdentifierType","type":"text","marks":[{"type":"code"}]},{"text":" returns the specified identifier variable as ","type":"text"},{"text":"internalReturnValue","type":"text","marks":[{"type":"code"}]},{"text":", usually you will want to know the “uid” of the participant.","type":"text"}]},{"type":"paragraph","content":[{"text":"mappingColumn","type":"text","marks":[{"type":"code"}]},{"text":" returns the specified participant variable as ","type":"text"},{"text":"externalReturnValue","type":"text","marks":[{"type":"code"}]},{"text":". This can used to store back information in your system, e.g. by uploading u_crm_id in your CSV data and using that variable as a mappingColumn.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"csvData\": \"u_email,u_first,u_name,v_1\\nexample@domain.tld,First,Last,2\\nexample2@domain.tld,First2,Last2,1\",\n \"returnIdentifierType\": \"uid\",\n \"allowDuplicateEmails\": true,\n \"mappingColumn\": \"u_email\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"successful\": 3,\n \"failed\": -1,\n \"failedRows\": [],\n \"returnIdentifiers\": [\n {\n \"internalReturnValue\": \"1\",\n \"externalReturnValue\": \"example@domain.tld\"\n },\n {\n \"internalReturnValue\": \"2\",\n \"externalReturnValue\": \"example2@domain.tld\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"84fad104-5712-42f0-871f-a501e3b24ea4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample to add the participants to ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update participants variables | PUT /survey/participants/{sampleId}/updateParticipantVariablesList | survey_participants_update"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/participants/{sampleId}/updateParticipantVariablesList","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates user's participant variables for given sample ID. Only available for personalized surveys. Returns list of participation data with updated values. Unknown participations and unknown variables are removed, invalid values will be replaced by standard values.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"participantVariablesList\": [\n {\n \"uid\": 1,\n \"variables\": [\n {\n \"variable\": \"u_example\",\n \"value\": \"Example\"\n }\n ]\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"uid\": 1,\n \"variables\": [\n {\n \"variable\": \"u_example\",\n \"value\": \"Example\"\n }\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f8f5cf6c-842a-4c3f-96e5-531e1ffe907e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get list of participants | GET /survey/participants/v2/{sampleId}/{additionalInfo} | survey_participants_getListV2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/participants/v2/{sampleId}/{additionalInfo}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of participants. The operation is allowed for personalized surveys only. If the parameter ","type":"text"},{"text":"withAdditionalFields","type":"text","marks":[{"type":"code"}]},{"text":" is set to true, additional variables for participant will be returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"uid\": 1,\n \"u_passwd\": \"ZDhjNDA2OGY=\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_email\": \"example@domain.tld\",\n \"u_mobile\": \"\",\n \"u_title\": \"\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_group\": 0,\n \"m_date\": \"2020-02-18T12:33:19+00:00\",\n \"c_date\": \"2020-02-18T11:39:29+00:00\",\n \"u_timezone\": \"+0:00\"\n }, ...\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"158a09f8-1964-40b7-afb5-1f9d4a18bccd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"sample to query ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"additionalInfo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Flag for the additional information to participant ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get list of participants by criteria | POST /survey/participants/{sampleId}/find | survey_participants_getListByCriteriaV3"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/participants/{sampleId}/find","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of participants according to the specified sample. The operation is allowed for personalized surveys only. The size of result set can be limited by using parameter 'offset' and 'limit'. Use parameter 'withAdditionalFields' in order to get the additional information for participant or suppress it.","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"text":"filtering results with conditions","type":"text","marks":[{"type":"link","attrs":{"href":"https://qbdocs.atlassian.net/wiki/spaces/DOC/pages/1273102351/How-to%3A+Service+Layer#Filtering-results-with-conditions"}}]},{"text":" for help on building conditions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"logicalCondition\": {\n \"comparison\": {\n \"variable\": \"u_email\",\n \"operator\": \"CONTAINS\",\n \"value\": \"example\"\n }\n },\n \"offset\": 0,\n \"limit\": 10,\n \"additionalInfo\": false\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"uid\": 19,\n \"u_passwd\": \"MjRkM2ZiZWE=\",\n \"u_firstname\": \"First\",\n \"u_name\": \"Last\",\n \"u_email\": \"example@domain.tld\",\n \"u_mobile\": \"\",\n \"u_title\": \"\",\n \"u_gender\": \"NOT_SPECIFIED\",\n \"u_group\": 0,\n \"m_date\": \"2020-08-28T08:24:11+00:00\",\n \"c_date\": \"2020-08-28T08:24:11+00:00\",\n \"u_timezone\": \"+0:00\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"aa41ce4d-a644-497c-89ef-f63c4fc2b159"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"sample to query ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Empty sample of a survey | DELETE /survey/participants/{sampleId} | survey.participants.deleteAll"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/participants/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes all participants from sample of a personalised or anonymous survey project, including their already collected survey results.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"60689496-ef58-420a-b08d-0b3efb28227e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete a participant | DELETE /survey/participants/{sampleId}/{userId} | survey_participants_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/participants/{sampleId}/{userId}","type":"text"}]},{"type":"paragraph","content":[{"text":"delete a participant from a survey sample, along with any already collected survey results for the participant","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b3f7ea3c-fdbc-49f9-86e8-8e1f683c740f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"userId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of participant ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Reset participation | PATCH /survey/participants/{surveyId}/reset | survey_participants_reset"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/participants/{surveyId}/reset","type":"text"}]},{"type":"paragraph","content":[{"text":"Resets a survey participation for participant. Existing survey data can be kept or deleted. The operation is allowed for personalized surveys only. Valid options for ","type":"text"},{"text":"resetType","type":"text","marks":[{"type":"code"}]},{"text":" are ","type":"text"},{"text":"keepData, deleteData","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"participantIdentifierType\": \"u_email\",\n \"participantIdentifierValue\": \"example@domain.tld\",\n \"resetType\": \"keepData\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"da0e053e-b103-4e22-9c17-019ef5e095ae"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Send mail to sample using mail template | PATCH /survey/participants/{sampleId} | survey_participants_sendMailByTemplateId"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/participants/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends mails to participants in a sample. Request is not available for anonymous surveys. With dis-codes you can decide which participants will receive the mail, e.g. when sending a reminder email, use codes 11 and 12 (and 10 in GDPR enabled projects).","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"uids\": [\n 1\n ],\n \"mailTemplateId\": 1234,\n \"dispcodes\": [\n \"11\", \"12\"\n ],\n \"sendOptions\": {\n \"sendDate\": \"2020-07-02T12:53:50+00:00\",\n \"useRecipientTimezone\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"8b0b74aa-304b-4b22-b7a1-c3fd328b452e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of sample ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Send mail to all survey participants | PUT /survey/participants/{surveyId} | survey_participants_sendMailV2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/participants/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Sends mails to every participiant in a survey. Please note This service will fail on anonymous surveys and sending of SMS is not supported by this service.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"mailTemplate\": {\n \"subject\": \"Example\",\n \"textContent\": \"Example\",\n \"htmlContent\": \"Example\",\n \"charset\": \"UTF-8\",\n \"replyTo\": \"Example\",\n \"returnPath\": \"Example\",\n \"priority\": \"NO_PRIORITY\",\n \"sensitivity\": \"NORMAL\",\n \"notify\": \"NO_NOTIFICATION\",\n \"toRealname\": true,\n \"from\": \"Example\",\n \"sms_from\": \"Example\",\n \"sms_content\": \"Example\",\n \"cc\": \"Example\",\n \"bcc\": \"Example\",\n \"fromRealname\": \"Example\"\n },\n \"uids\": [\n 1\n ],\n \"dispcodes\": [\n \"10\"\n ],\n \"sendOptions\": {\n \"sendDate\": \"2020-07-02T12:53:50+00:00\",\n \"useRecipientTimezone\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"da8afe6b-0110-4261-a388-6047e6d012c4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Samples","type":"text"}]},{"type":"expand","attrs":{"title":"Get all samples | GET /survey/samples/ | survey_samples_getAll"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/samples/","type":"text"}]},{"type":"paragraph","content":[{"text":"return the list of samples for all surveys","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"sampleId\": 2287,\n \"title\": \"(internal)\",\n \"desc\": \"\",\n \"cdate\": \"2020-02-13T10:11:11+00:00\",\n \"isInternal\": true,\n \"surveyId\": 2286\n }, ...\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get samples in a survey | GET /survey/samples/survey/{surveyId} | survey_samples_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/samples/survey/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"return the list of samples for a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"sampleId\": 2287,\n \"title\": \"(internal)\",\n \"desc\": \"\",\n \"cdate\": \"2020-02-13T10:11:11+00:00\",\n \"isInternal\": true,\n \"surveyId\": 2286\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"7da73b5c-9d7d-40c1-8475-13eb3ab6d931"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get sample | GET /survey/samples/sample/{sampleId} | survey_samples_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/samples/sample/{sampleId}","type":"text"}]},{"type":"paragraph","content":[{"text":"return information about a survey sample","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"sampleId\": 2287,\n \"title\": \"(internal)\",\n \"desc\": \"\",\n \"cdate\": \"2020-02-13T10:11:11+00:00\",\n \"isInternal\": true,\n \"surveyId\": 2286\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"504cf2f8-bc4d-40ef-b6a4-30820e929789"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"sampleId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of the sample ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Create sample | POST /survey/samples/{pid} | survey_samples_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/samples/{pid}","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a sample to a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"title\": \"Example\", \"description\": \"Example sample\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a8726466-115e-45ce-bb90-fc48ef3b95ae"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"pid","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"project id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Placeholders","type":"text"}]},{"type":"expand","attrs":{"title":"Get wildcards of a survey | GET /survey/placeholders/{surveyId} | survey_placeholders_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/placeholders/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of all survey wildcards for a given survey id, text is using default survey language.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 3,\n \"key\": \"#example#\",\n \"text\": \"Hello Example\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"90bebeae-0d68-42c2-b934-99ee5aab28aa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get wildcards in a survey for a language | GET /survey/placeholders/{surveyId}/{languageId} | survey_placeholders_getListTranslated"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/placeholders/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of all translated survey wildcards for a given survey id and survey language id","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 3,\n \"key\": \"#example#\",\n \"text\": \"Hello Example\"\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"3bfb623b-9637-4de2-ae0e-022aea99f349"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey language id the placeholder texts should be returned for ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update a wildcard | PATCH /survey/placeholders/{surveyId}/{id} | survey_placeholders_change"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/placeholders/{surveyId}/{id}","type":"text"}]},{"type":"paragraph","content":[{"text":"Change an existing survey wildcard text in the default survey language","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"text\": \"Hallo Example\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b7473e2e-bc43-45e6-874a-3895a9c4858c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of placeholder to change ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update a wildcard in language translation | PATCH /survey/placeholders/{surveyId}/{id} | survey_placeholders_changeTranslated"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/placeholders/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Change an existings survey wildcards text in a certain survey language","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"id\": 1, \"text\": \"Example\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"da51abcf-d430-403e-98d1-13f2450aa459"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey language id the placeholder texts should be returned for ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Questionnaire","type":"text"}]},{"type":"expand","attrs":{"title":"Get survey structure | GET /survey/questionnaire/{surveyId} | survey_questionnaire_getStructure"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/questionnaire/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Return the questionnaire structure for a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"title\": \"System\",\n \"pgid\": 1712,\n \"type\": \"SYSTEM\",\n \"questions\": [\n {\n \"questiontext\": \"\",\n \"variables\": []\n }\n ],\n \"subPages\": []\n },\n {\n \"title\": \"End page\",\n \"pgid\": 1714,\n \"type\": \"ENDPAGE\",\n \"questions\": [],\n \"subPages\": []\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"1f36002b-ac2c-4e72-86ed-e697a4efe779"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get survey structure with IDs | GET /survey/questionnaire/withIds/{surveyId} | survey_questionnaire_getStructureWithIds"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/questionnaire/withIds/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Return the questionnaire structure for a survey with internal IDs for all elements","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"title\": \"System\",\n \"pgid\": 1712,\n \"type\": \"SYSTEM\",\n \"questions\": [\n {\n \"questiontext\": \"\",\n \"variables\": []\n }\n ],\n \"subPages\": []\n },\n {\n \"title\": \"End page\",\n \"pgid\": 1714,\n \"type\": \"ENDPAGE\",\n \"questions\": [],\n \"subPages\": []\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"00eb28d6-1935-44a7-ac9c-2442234b5f95"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Create a page | POST /survey/questionnaire/{surveyId} | survey_questionnaire_createPage"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/questionnaire/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"create a questionnaire page","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"pageTitle\": \"Example\",\n \"pageType\": \"STANDARD\",\n \"options\": {\n \"hideSubmit\": false,\n \"hideBackbutton\": true,\n \"autoPost\": false,\n \"parentPageId\": -1,\n \"previousPageId\": 1\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"4a2894ca-2e07-44bc-9073-37f5bd5db1a1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete a page | DELETE /survey/questionnaire/{surveyId} | survey_questionnaire_deletePage"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/questionnaire/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"delete a questionnaire page","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"pageId\": 1, \"force\": true }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"70ebcce5-f169-4b3c-8f75-a38a3a9d0096"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get bonus points for all end pages | GET /survey/questionnaire/{surveyId}/list | survey_questionnaire_getBonusPoints"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/questionnaire/{surveyId}/list","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the configured bonus points for all end pages to the given surveyId, panel or master data surveys only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"pageId\": 1234, \"points\": 10.0 } ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b4bf4527-6dca-405c-af9a-1bab5f393563"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Set bonus points for end pages | PUT /survey/questionnaire/{surveyId}/setPageBonusPoints | survey_questionnaire_setBonusPoints"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/questionnaire/{surveyId}/setPageBonusPoints","type":"text"}]},{"type":"paragraph","content":[{"text":"Applies bonus points to survey end-pages for the given surveyId, panel or master data surveys only.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"pageBonusPoints\": [\n {\n \"pageId\": 1234,\n \"points\": 10.0\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"pageId\": 1234, \"points\": 10.0 } ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"9b0e1fa2-fa84-4132-af29-adc82203d65d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get categories for a variable | GET /survey/questions/{surveyId}/{varname} | survey_questions_getResponseCategoriesByVarname"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/questions/{surveyId}/{varname}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get response-categories by variable name and survey id","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"code\": 0,\n \"rcat\": \"Unspecified\"\n },\n {\n \"code\": 1,\n \"rcat\": \"Male\"\n },\n {\n \"code\": 2,\n \"rcat\": \"Female\"\n },\n {\n \"code\": 3,\n \"rcat\": \"Other\"\n } \n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"bd20162b-4c62-4000-8925-6dfcb4814314"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"varname","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"variable name ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"Example","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reporting+","type":"text"}]},{"type":"expand","attrs":{"title":"Create standard Reporting+ report | POST /survey/reports/{surveyId} | survey_reports_createStandardReport"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/reports/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a standard Reporting+ report for a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"title\": \"Example\", \"description\": \"Example\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"225c60bf-f71d-46d0-8f69-7b2829fbeff2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Create export | POST /survey/reports/v2/{reportId}/publication | survey_reports_createReportPublicationV2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/reports/v2/{reportId}/publication","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a Reporting+ export, valid options for ","type":"text"},{"text":"reportType","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"html, xls, pdf, ppt, pptx, pptxpdf","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"reportType\": \"html\",\n \"fileName\": \"Example.html\",\n \"languageId\": 1,\n \"guiLanguage\": \"en\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"feb41ffc-119c-4574-9e1a-68d24c298ae3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey report (to be created with createStandardReport) ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete export | DELETE /survey/reports/{reportId} | survey_reports_deleteReport"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/reports/{reportId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete a Reporting+ export","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a8716966-c06a-444c-8a43-420eebd6b91e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey report (to be created with createStandardReport) ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get export | GET /survey/reports/{reportId}/publication/{reportPublicationId} | survey_reports_getReportPublication"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/reports/{reportId}/publication/{reportPublicationId}","type":"text"}]},{"type":"paragraph","content":[{"text":"return the data for a publication","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"ed9e9ee7-5a2e-4ca7-a69c-fdfd336d5e9b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of report ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportPublicationId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of publication ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Check if export available | GET /survey/reports/{reportId}/published/{reportPublicationId} | survey_reports_checkReportPublication"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/reports/{reportId}/published/{reportPublicationId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Check if report is available","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"cd7867c8-bc0e-4867-bcfd-5a13826832e9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of report ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"reportPublicationId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of publication ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Survey participations","type":"text"}]},{"type":"expand","attrs":{"title":"Get completed raw results as CSV | POST /survey/results/{surveyId}/configured | survey_results_getRawdataCSV"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/results/{surveyId}/configured","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the survey results as raw data in CSV format. ","type":"text"},{"text":"dateRange","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"sort","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"config","type":"text","marks":[{"type":"code"}]},{"text":" and individual config options are optional. ","type":"text"},{"type":"hardBreak"},{"text":"Valid options for ","type":"text"},{"text":"exportTemplate","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"COMPLETE_SURVEY, WITHOUT_TIMESTAMP, TEXT_ONLY, NUMBER_ONLY, PARTICIPANT, PARTICIPANT_RESULT, PARTICIPANT_MASTER_RESULT, LOFT_COMBINED, LOFT_COMBINED_ANONYM.","type":"text","marks":[{"type":"em"}]},{"type":"hardBreak"},{"text":"Valid options for ","type":"text","marks":[{"type":"em"}]},{"text":"compression","type":"text","marks":[{"type":"code"}]},{"text":": NONE, ZIP, TAR.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Note","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"POST /survey/results/{surveyId}/completed","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"POST /survey/results/{surveyId}","type":"text","marks":[{"type":"code"}]},{"text":" are deprecated. Please migrate to this call by adding /configured to your endpoint and supplying relevant config options.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"exportTypes\": [\n \"QUESTIONNAIRE\"\n ],\n \"includeVariables\": [\n \"v_1\", \"v_2\"\n ],\n \"dateRange\": {\n \"from\": \"2020-07-01T12:53:50+00:00\",\n \"to\": \"2020-07-02T12:53:50+00:00\"\n },\n \"sort\": [\n {\n \"column\": \"lfdn\",\n \"direction\": \"ASC\"\n }\n ],\n \"config\": {\n \"exportTemplate\": \"COMPLETE_SURVEY\",\n \"charset\": \"UTF-8\",\n \"compression\": \"NONE\",\n \"missingValueText\": \"-66\",\n \"missingValueNumeric\": \"-77\",\n \"missingValueTimestamp\": \"0\",\n \"missingValueDatetime\": \"0000-00-00 00:00:00\",\n \"skipLoopVars\": true,\n \"dispositionCodeList\": [\n \"31\"\n ],\n \"useCommaDelimiter\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"e216cf2d-571b-453a-b2b3-b90df8df1e17"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get dispo code frequencies | GET /survey/results/{surveyId}/participations | survey_results_getParticipations"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/results/{surveyId}/participations","type":"text"}]},{"type":"paragraph","content":[{"text":"Return frequencies for all disposition codes allocated in a survey, thus basic information about the survey's participation statuses.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"code\": 11,\n \"count\": 8\n },\n {\n \"code\": 12,\n \"count\": 2\n },\n {\n \"code\": 31,\n \"count\": 6\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"8caafd67-8c15-4519-83f7-e463c37b73af"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get frequencies for variables | GET /survey/results/{surveyId}/statistics | survey_results_getSimpleStatistics"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/results/{surveyId}/statistics","type":"text"}]},{"type":"paragraph","content":[{"text":"return frequency statistics for all closed-ended questions of a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"singleResultStatistic\": {\n \"varname\": \"v_2\",\n \"codeResultList\": [\n {\n \"code\": 1,\n \"count\": 1,\n \"pct\": 0\n },\n {\n \"code\": 2,\n \"count\": 1,\n \"pct\": 0\n }\n ]\n }\n },\n {\n \"multiResultStatistic\": {\n \"varname\": \"v_4\",\n \"codeResult\": {\n \"code\": 1,\n \"count\": 3,\n \"pct\": 0\n }\n }\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"0d676b83-555f-4606-a37c-5f8dbac1d2d0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get result for a panelist | POST /survey/results/{surveyId}/statistics | survey_results_getSimpleStatisticsByPanelist"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/results/{surveyId}/statistics","type":"text"}]},{"type":"paragraph","content":[{"text":"Get simple statistics for given panelist and variable list. Only available in panel and master data variables.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"identifierType\": \"uid\",\n \"identifierValue\": \"123\",\n \"includeVariables\": [\n \"v_1\"\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"singleResultStatistic\": {\n \"varname\": \"v_1\",\n \"codeResultList\": [\n {\n \"code\": 1,\n \"count\": 3,\n \"pct\": 33\n },\n {\n \"code\": 2,\n \"count\": 3,\n \"pct\": 33\n },\n {\n \"code\": 3,\n \"count\": 3,\n \"pct\": 33\n }\n ],\n \"mean\": 2,\n \"median\": 2\n }\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"65ab5588-31a7-4ce1-ae1a-1a32533bd48f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Update participation data with new values | PUT /survey/results/{surveyId}/updateSurveyResults | survey_results_updateSurveyResults"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/results/{surveyId}/updateSurveyResults","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates participation data for given survey ID. Participations are matched by lfdn (id). Only available for anonymous, personalized and employee surveys. Supports update of user- and survey-variables and not loop-variables. If parameter executeTriggers is set to true, then only 100 records can be processed due to performance reasons, more records will cause an error. Returns list of participation data with updated values. Unknown participations or unknown variables will be removed, invalid values will be replaced by standard values.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"surveyResults\": [\n {\n \"id\": 1234,\n \"results\": [\n {\n \"variable\": \"v_1\",\n \"value\": \"2\"\n }\n ]\n }\n ],\n \"executeTriggers\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 1234,\n \"results\": [\n {\n \"variable\": \"v_1\",\n \"value\": \"2\"\n }\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f94f84f9-5d72-4e7c-9a3c-cfbf4f553f56"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Field report / Statistics","type":"text"}]},{"type":"expand","attrs":{"title":"Get field report chart | POST /survey/statistics/{surveyId}/chart | survey_statistics_getGraph"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/chart","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the png graph which represents the participation.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"lang","type":"text","marks":[{"type":"code"}]},{"text":": EN, DE, FR, FI, IT, NB, SV","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"lang\": \"EN\",\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \" IN \",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"285be73c-66f8-4ae8-b49d-2412f2f4a7b9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get total participations count for a disposition code | POST /survey/statistics/{surveyId}/abs | survey_statistics_getCountBy"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/abs","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the absolute number of participation for a single disposition code and optionally limited by restriction.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note, contrary to the RAML and WSDL documentations, the use of ","type":"text"},{"text":"splitVariable","type":"text","marks":[{"type":"code"}]},{"text":" in ","type":"text"},{"text":"criteria","type":"text","marks":[{"type":"code"}]},{"text":" is not supported and returns erroneous result. An updated service will be provided shortly.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"criteria\": {\n \"dispositionCodes\": [\n \"31\"\n ]\n },\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"1dc0d2a2-478b-41b2-8bf5-96d8835b7425"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get participation count for all disposition codes | POST /survey/statistics/{surveyId}/abs/all | survey_statistics_getAllCodesCount "},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/abs/all","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the absolute number of participation for all disposition codes, optionally restricted by condition. ","type":"text"},{"type":"hardBreak"},{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[ { \"code\": \"10\", \"count\": 1234 } ]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"6c7a3b64-5d56-4801-a0cf-026b0617ed50"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get participation counts | POST /survey/statistics/{surveyId}/abs/filter | survey_statistics_getListOfCountsBy"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/abs/filter","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of the number/s of participation by disposition code/s and/or split-variable.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"paragraph","content":[{"text":"POST /survey/statistics/{surveyId}/abs/all","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"POST /survey/statistics/{surveyId}/abs","type":"text","marks":[{"type":"code"}]},{"text":" are similar to this call, but return only a single total value.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note, contrary to the RAML and WSDL documentations, the use of ","type":"text"},{"text":"splitVariable","type":"text","marks":[{"type":"code"}]},{"text":" in ","type":"text"},{"text":"criteria","type":"text","marks":[{"type":"code"}]},{"text":" is not supported and returns erroneous result. An updated service will be provided shortly.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"criteria\": {\n \"dispositionCodes\": [\n \"31\", \"32\"\n ]\n },\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"code\": 1,\n \"count\": 10\n },\n {\n \"code\": 2,\n \"count\": 8\n },\n {\n \"code\": 3,\n \"count\": 4\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"917efda3-c692-496b-a575-ff7916370375"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get total sample (Gross 1) | POST /survey/statistics/{surveyId}/gross | survey_statistics_getGross1"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/gross","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the total sample (Gross 1) for the project.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note, contrary to the RAML and WSDL documentations, the use of ","type":"text"},{"text":"splitVariable","type":"text","marks":[{"type":"code"}]},{"text":" is not supported and returns erroneous result. An updated service will be provided shortly.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"ac5fe673-61f1-4033-91be-020483e4dff0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get adjusted total sample (Gross 2) | POST /survey/statistics/{surveyId}/gross2 | survey_statistics_getGross2"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/gross2","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the adjusted total sample (Gross 2) for the project.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note, contrary to the RAML and WSDL documentations, the use of ","type":"text"},{"text":"splitVariable","type":"text","marks":[{"type":"code"}]},{"text":" is not supported and returns erroneous result. An updated service will be provided shortly.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"8ea65198-106a-470f-aa28-28b7ff74c10c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get net-participation | POST /survey/statistics/{surveyId}/net | survey_statistics_getNet"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/net","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the net-participation for the project.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note, contrary to the RAML and WSDL documentations, the use of ","type":"text"},{"text":"splitVariable","type":"text","marks":[{"type":"code"}]},{"text":" is not supported and returns erroneous result. An updated service will be provided shortly.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"0c8c48d8-8709-486a-ac76-6a371a578a8e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get participation count for disposition codes, filtered and split | POST /survey/statistics/{surveyId}/disposition/filter | survey_statistics_getListOfDispoCountsGroupedBy"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/statistics/{surveyId}/disposition/filter","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the absolute number of participation for a list of disposition codes, limited by restriction, split by a variable. This service allows use of u_ variables for filtering or splits.","type":"text"}]},{"type":"paragraph","content":[{"text":"Valid values for ","type":"text"},{"text":"field_link","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"IN, BETWEEN, LIKE, NOT LIKE, =, !=, <>, <, <=, >, >=","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"Values","type":"text"},{"text":" LIKE, NOT LIKE ","type":"text","marks":[{"type":"em"}]},{"text":"should only be applied to text variables and to search for a substring, append “%”: E.g. “%world” will map “Hello World” but not “World, Hello”, search for “%world%” will find both occurrences.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"criteria\": {\n \"dispositionCodes\":[\"11\",\"12\",\"22\",\"31\",\"32\"],\n \"splitVariable\":\"u_gender\"\n },\n \"restriction\": [\n {\n \"field_name\": \"v_2\",\n \"field_link\": \"IN\",\n \"field_value\": \"1, 2, 3\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"value\": \"-1\",\n \"total\": 19,\n \"participation\": [\n {\n \"code\": \"11\",\n \"count\": 1\n },\n {\n \"code\": \"12\",\n \"count\": 6\n },\n {\n \"code\": \"22\",\n \"count\": 1\n },\n {\n \"code\": \"31\",\n \"count\": 11\n }\n ]\n },\n {\n \"value\": \"Not available\",\n \"total\": 1,\n \"participation\": [\n {\n \"code\": \"11\",\n \"count\": 1\n }\n ]\n },\n {\n \"value\": \"-1\",\n \"total\": 1,\n \"participation\": [\n {\n \"code\": \"31\",\n \"count\": 1\n }\n ]\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"faf6c330-531c-4e9b-96d6-bb3a5e0b966f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"The survey ID ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Surveys","type":"text"}]},{"type":"expand","attrs":{"title":"Get all surveys | GET /survey/surveys/ | survey_surveys_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/surveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of surveys the user has access to","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 1234,\n \"title\": \"Example title\",\n \"description\": \"Example description\",\n \"marked\": true,\n \"author\": \"Example\",\n \"staff\": \"\",\n \"comment\": \"\",\n \"isMarked\": false,\n \"url\": \"http://example.questback.com/uc/main/1234/\",\n \"createTime\": \"2020-07-02T12:53:50+00:00\",\n \"fieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-08-02T12:53:50+00:00\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ANONYMOUS\",\n \"numberOfParameters\": 0,\n \"bonusPoints\": {\n \"label\": \"\",\n \"value\": 0\n }\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get surveys by criteria | POST /survey/surveys/find | survey_surveys_getListByCriteria"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/surveys/find","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a list of surveys the user has access to, based on search criteria. See ","type":"text"},{"text":"filtering results with conditions","type":"text","marks":[{"type":"link","attrs":{"href":"https://qbdocs.atlassian.net/wiki/spaces/DOC/pages/1273102351/How-to%3A+Service+Layer#Filtering-results-with-conditions"}}]},{"text":" for help on building conditions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"logicalCondition\": {\n \"comparison\": {\n \"variable\": \"title\",\n \"operator\": \"CONTAINS\",\n \"value\": \"Example\"\n }\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 1234,\n \"title\": \"Example title\",\n \"description\": \"Example description\",\n \"marked\": true,\n \"author\": \"Example\",\n \"staff\": \"\",\n \"comment\": \"\",\n \"isMarked\": false,\n \"url\": \"http://example.questback.com/uc/main/1234/\",\n \"createTime\": \"2020-07-02T12:53:50+00:00\",\n \"fieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-08-02T12:53:50+00:00\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ANONYMOUS\",\n \"numberOfParameters\": 0,\n \"bonusPoints\": {\n \"label\": \"\",\n \"value\": 0\n }\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get active surveys | GET /survey/surveys/find/active | survey_surveys_getActiveList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/surveys/find/active","type":"text"}]},{"type":"paragraph","content":[{"text":"Get a list of active surveys the user has access to","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"id\": 1234,\n \"title\": \"Example title\",\n \"description\": \"Example description\",\n \"marked\": true,\n \"author\": \"Example\",\n \"staff\": \"\",\n \"comment\": \"\",\n \"isMarked\": false,\n \"url\": \"http://example.questback.com/uc/main/1234/\",\n \"createTime\": \"2020-07-02T12:53:50+00:00\",\n \"fieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-08-02T12:53:50+00:00\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ANONYMOUS\",\n \"numberOfParameters\": 0,\n \"bonusPoints\": {\n \"label\": \"\",\n \"value\": 0\n }\n }\n]","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get survey | GET /survey/surveys/{surveyId} | survey_surveys_get"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/surveys/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Get basic information about a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"id\": 1234,\n \"title\": \"Example title\",\n \"description\": \"Example description\",\n \"marked\": true,\n \"author\": \"Example\",\n \"staff\": \"\",\n \"comment\": \"\",\n \"isMarked\": false,\n \"url\": \"http://example.questback.com/uc/main/1234/\",\n \"createTime\": \"2020-07-02T12:53:50+00:00\",\n \"fieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-08-02T12:53:50+00:00\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ANONYMOUS\",\n \"numberOfParameters\": 0,\n \"bonusPoints\": {\n \"label\": \"\",\n \"value\": 0\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"063339f8-c6ea-410c-bddc-7564c98adb60"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey to delete ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Create survey | POST /survey/surveys/ | survey_surveys_add"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/surveys/","type":"text"}]},{"type":"paragraph","content":[{"text":"Creates a new survey, returns project id. Valid options for ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ANONYMOUS, PERSONALIZED, ES, LOFT, PANEL, GEN_MASTERDATA, DIARY","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"surveyData\": {\n \"title\": \"Example title\",\n \"author\": \"Example\",\n \"type\": \"ANONYMOUS\",\n \"description\": \"Example description\",\n \"staff\": \"\",\n \"comment\": \"\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]}]},{"type":"expand","attrs":{"title":"Change field period and status | PATCH /survey/surveys/{surveyId} | survey_surveys_changeFieldData"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/surveys/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Change a survey's field period and status. Valid options for ","type":"text"},{"text":"surveyStatus","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"GENERATED, ACTIVE, CLOSING, FINISHED, ARCHIVED","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"surveyStatus\": \"ACTIVE\",\n \"surveyFieldTime\": {\n \"startTime\": \"2020-07-02T12:53:50+00:00\",\n \"endTime\": \"2020-08-02T12:53:50+00:00\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"77d5cb0b-6ba7-4e10-9a4e-4e5d40ff2fea"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey to delete ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Change survey | PUT /survey/surveys/{surveyId} | survey_surveys_changeDescription"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/surveys/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Change a survey's descriptive data (survey title, survey comment etc.)","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"title\": \"New Title\",\n \"description\": \"Example description\",\n \"author\": \"Example author\",\n \"staff\": \"Example staff field\",\n \"comment\": \"Example comment\",\n \"isMarked\": true\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"1ede2b42-6ce8-45e4-a3a9-2200ed09833b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey to delete ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Delete survey | DELETE /survey/surveys/{surveyId} | survey_surveys_delete"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"DELETE /survey/surveys/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Deletes a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f24020a2-609a-426b-9b8e-48a6cdf31b3b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey to delete ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Compile a survey | PATCH /survey/surveys/{surveyId}/compile | survey_surveys_compile"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/surveys/{surveyId}/compile","type":"text"}]},{"type":"paragraph","content":[{"text":"Compiles the survey. Creates all missing variable names and resets the participants if requested. You need the write ACL right to perform this action. Options for ","type":"text"},{"text":"surveyCompilationType","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"keep_results, delete_results, delete_tester.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"surveyCompilationType\": \"keep_results\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"78d43be2-8fbb-4ff3-94db-e09cf02fb3bd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Copy survey | POST /survey/surveys/{surveyId}/copy | survey_surveys_copy"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/surveys/{surveyId}/copy","type":"text"}]},{"type":"paragraph","content":[{"text":"Copies a survey","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"title\": \"Copy of Example\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"1234","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"a6b6e478-7c6d-4d5a-8986-c3003eac3306"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey to copy ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Change type of survey | PATCH /survey/surveys/{surveyId}/type | survey_surveys_changeType"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/surveys/{surveyId}/type","type":"text"}]},{"type":"paragraph","content":[{"text":"Change the type of a survey. Valid types for ","type":"text"},{"text":"surveyType","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"ANONYMOUS, PERSONALIZED, ES, LOFT, PANEL, GEN_MASTERDATA, DIARY","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"surveyType\": \"ANONYMOUS\" }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f9cace83-5f3b-41b3-9f4c-0c77fa58d0fb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey to change ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get survey preview url | GET /survey/surveys/{surveyId}/previewlink | survey_surveys_getPreviewLink"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/surveys/{surveyId}/previewlink","type":"text"}]},{"type":"paragraph","content":[{"text":"Uses the admin session in the url","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"Example\"","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"20eb1b23-aead-411c-ab01-cf3111847edf"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"id of survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Get variable information | POST /survey/variables/{surveyId} | survey_variables_getDescriptionList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/variables/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns description of survey's variables, machine readable version of the code book. Valid options for ","type":"text"},{"text":"surveyVariableTypes","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"STANDARD, PARTICIPANT, QUESTIONNAIRE, QUESTIONNAIRE_WITH_LOOPS, PARTICIPATION, INTERNAL.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{ \"surveyVariableTypes\": [ \"STANDARD\" ] }","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"varname\": \"quota_rejected_id\",\n \"label\": \"Rejection quota ID of participant\",\n \"type\": \"int\",\n \"typeGroup\": \"numeric\"\n },\n {\n \"varname\": \"language\",\n \"label\": \"Language\",\n \"type\": \"int\",\n \"typeGroup\": \"numeric\",\n \"categories\": [\n {\n \"code\": 1,\n \"label\": \"English\",\n \"isMissing\": false\n },\n {\n \"code\": 2,\n \"label\": \"German\",\n \"isMissing\": false\n },\n {\n \"code\": 3,\n \"label\": \"French\",\n \"isMissing\": false\n }\n ]\n },\n [...]\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"da693ada-3c2d-4469-9647-18e216e823db"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"survey id ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Export survey results | POST /survey/surveys/export | survey_surveys_getExport"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"POST /survey/surveys/export","type":"text"}]},{"type":"paragraph","content":[{"text":"Exports survey results according to the given configuration. Please note, that the example is showing all possible options, and is therefore not working. Only ","type":"text"},{"text":"surveyId","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"compression","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"exportType","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"exportFileFormat","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"exportTemplate","type":"text","marks":[{"type":"code"}]},{"text":" are required parameters. For full description of export options, see the project export mask in the EFS user interface and the relevant documentation.","type":"text"}]},{"type":"paragraph","content":[{"text":"The returned data is always base64 encoded and in addition, depending on the ","type":"text"},{"text":"gzCompression","type":"text","marks":[{"type":"code"}]},{"text":" boolean parameter, the data will be compressed using the zlib format (if true, ","type":"text"},{"text":"gzcompress","type":"text","marks":[{"type":"em"}]},{"text":" PHP function) or encoded using the gzip format (if false, ","type":"text"},{"text":"gzencode","type":"text","marks":[{"type":"em"}]},{"text":" PHP function). When handling the returned data, you first need to base64 decode it, then apply the equivalent to PHP's ","type":"text"},{"text":"gzuncompress()","type":"text","marks":[{"type":"em"}]},{"text":" or ","type":"text"},{"text":"gzdecode()","type":"text","marks":[{"type":"em"}]},{"text":" functions for your platform, then you will receive your data in the specified format, which depending on the ","type":"text"},{"text":"compression","type":"text","marks":[{"type":"code"}]},{"text":" parameter might additionally be compressed. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Please note, that not all exportConfig parameters are supported by all export types, where in doubt, please consult the relevant export user interfaces in EFS Admin area. E.g. for exportType=PARTICIPANT_DATA and exportTemplate=PARTICIPANT, ","type":"text"},{"text":"startDate","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"endDate","type":"text","marks":[{"type":"em"}]},{"text":" will be ignored, since they are not available in the export UI of EFS.","type":"text"}]}]},{"type":"table","attrs":{"layout":"default","localId":"f6345439-0343-4f0c-a99b-46062f5a34b6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"Valid options","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"compression","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"NONE, ZIP, TAR","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"protected","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"ALL, PROTECTED_ONLY, UNPROTECTED_ONLY","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"exportType","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"ALL_ANSWERS, RAW_LOOP_DATA, TEXT_ANSWERS, PARTICIPANT_DATA","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"exportFileFormat","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"CSV, XLS, XLSX, TRIPLE_S, TOP_STUD, XML, HTML, SPSS, SPSS_PORTABLE, SAS, FIXED_FORMAT, QUANTUM","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"exportTemplate","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"COMPLETE_SURVEY, WITHOUT_TIMESTAMP, TEXT_ONLY, NUMBER_ONLY, PARTICIPANT, PARTICIPANT_RESULT, PARTICIPANT_MASTER_RESULT, LOFT_COMBINED, LOFT_COMBINED_ANONYM","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"varNameType","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":"INTERNAL, EXTERNAL","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"quantumTextOption","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[480.0]},"content":[{"type":"paragraph","content":[{"text":" NONE, ALL, SURVEY', 'INTERNAL","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"exportConfig\": {\n \"surveyId\": 1234,\n \"sampleId\": 1,\n \"languageId\": 1,\n \"compression\": \"NONE\",\n \"skipMissings\": true,\n \"restrict\": \"Example\",\n \"anonymize\": true,\n \"trimNewlines\": true,\n \"substituteCode\": true,\n \"displayMetaInfo\": true,\n \"shrinkColumnWidth\": true,\n \"adjustColumnWidth\": true,\n \"includeSysMissings\": true,\n \"consecutiveNrFrom\": 0,\n \"consecutiveNrTo\": 0,\n \"protected\": \"ALL\",\n \"dispositionCodeList\": [\n \"31\"\n ],\n \"exportType\": \"ALL_ANSWERS\",\n \"exportFileFormat\": \"CSV\",\n \"exportTemplate\": \"COMPLETE_SURVEY\",\n \"charset\": \"UTF-8\",\n \"missingValueText\": \"-66\",\n \"missingValueTextEmpty\": \"-\",\n \"missingValueNumeric\": \"-77\",\n \"missingValueTimestamp\": \"0\",\n \"missingValueDatetime\": \"0000-00-00 00:00:00\",\n \"startDate\": \"2020-07-02T12:53:50+00:00\",\n \"endDate\": \"2020-07-02T12:53:50+00:00\",\n \"varNameType\": \"INTERNAL\",\n \"quantumTextOption\": \"NONE\",\n \"panelGroup\": 1,\n \"panelistStatusList\": [\n 1\n ],\n \"gzCompression\": true,\n \"modifiedOnly\": true,\n \"trackModification\": true,\n \"varNameRestriction\": [\n \"v_1\", \"v_2\"\n ],\n \"skipLoopVars\": true,\n \"cutPsppColumns\": true,\n \"useCommaDelimiter\": true\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"\"QmFzZTY0IGVuY29kZWQgYmluYXJ5IGRhdGE=\"","type":"text"}]}]},{"type":"expand","attrs":{"title":"Get performance information | GET /survey/timelog/{surveyId} | survey_timelog_getList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/timelog/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a performance data structure for a survey.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"pgid\": 1094,\n \"log_date\": \"2020-01-21T10:34:05+00:00\",\n \"servertime\": 0.61,\n \"serverload\": 0,\n \"include_time\": 0.0240839,\n \"db_time\": 0.106218,\n \"output_time\": 0.39797\n }\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b474a7a1-0a9d-44dc-af70-78d28340b66a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Id of a survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Reset performance information | PUT /survey/timelog/{surveyId} | survey_timelog_reset"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PUT /survey/timelog/{surveyId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Resets all performance data used when accessing the OSPE time log.","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"9d9b6fb8-2772-41c7-a405-89c48bf51098"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Id of a survey ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Translations","type":"text"}]},{"type":"expand","attrs":{"title":"Get translations | GET /survey/translations/{surveyId}/{languageId} | survey_translations_getTranslationList"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"GET /survey/translations/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets a list of all translations for the specified language","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"typeId\": 0,\n \"textType\": \"msg_title\",\n \"text\": \"Survey\"\n },\n [...]\n {\n \"typeId\": 0,\n \"textType\": \"msg_submit\",\n \"text\": \"Continue\"\n },\n [...]\n {\n \"typeId\": 1380,\n \"textType\": \"q_instruct\",\n \"text\": \"Here you explain how the question has to be filled in (optional).\"\n },\n [...]\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"d53f256a-274f-438e-9b62-5d89377ee7c9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"languageId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"Change translation | PATCH /survey/translations/{surveyId}/{languageId} | survey_translations_changeTranslation"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"PATCH /survey/translations/{surveyId}/{languageId}","type":"text"}]},{"type":"paragraph","content":[{"text":"Changes a translation","type":"text"}]},{"type":"paragraph","content":[{"text":"Request body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"textType\": \"q_instruct\",\n \"typeId\": 1234,\n \"text\": \"New Example\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Response body","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"true","type":"text"}]},{"type":"paragraph","content":[{"text":"URI Parameters","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b2ca6a24-ff49-4919-9138-ae19ad53aecb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"surveyId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[164.0]},"content":[{"type":"paragraph","content":[{"text":"languageId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"integer","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[162.0]},"content":[{"type":"paragraph","content":[{"text":"languageId ","type":"text"},{"text":"Examples:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported