File: /var/www/apklausos/docs/open-api/v1.json
{"openapi":"3.0.2","info":{"title":"LimeSurvey V1","description":"LimeSurvey V1 REST API","version":"1"},"paths":{"\/rest\/v1\/survey":{"get":{"tags":["Survey"],"summary":"Survey list","operationId":"get.survey","parameters":[{"name":"pageSize","in":"query","schema":{"type":"integer"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey List","description":"Survey List","type":"object","properties":{"surveys":{"type":"array","items":{"allOf":[{"title":"Survey","description":"Survey","type":"object","properties":{"sid":{"type":"integer"},"gsid":{"type":"integer"},"active":{"default":false,"type":"boolean"},"expires":{"type":"boolean"},"startDate":{"type":"boolean"},"anonymized":{"type":"boolean"},"saveTimings":{"type":"boolean"},"datestamp":{"type":"boolean"},"useCookie":{"type":"boolean"},"allowRegister":{"type":"boolean"},"htmlEmail":{"type":"boolean"},"allowSave":{"type":"boolean"},"autoNumberStart":{"default":0,"type":"integer"},"autoRedirect":{"type":"boolean"},"allowPrev":{"type":"boolean"},"printAnswers":{"type":"boolean"},"ipAddr":{"type":"boolean"},"ipAnonymize":{"type":"boolean"},"refUrl":{"type":"boolean"},"dateCreated":{"format":"date-time","type":"string"},"publicStatistics":{"type":"boolean"},"publicGraphs":{"type":"boolean"},"listPublic":{"type":"boolean"},"sendConfirmation":{"type":"boolean"},"tokenAnswersPersistence":{"type":"boolean"},"assessments":{"type":"boolean"},"useCaptcha":{"type":"boolean"},"useTokens":{"type":"boolean"},"bounceEmail":{"type":"string"},"attributeDescriptions":{"type":"string"},"emailResponseTo":{"type":"boolean"},"emailNotificationTo":{"type":"string"},"tokenLength":{"type":"integer","example":15},"showXQuestions":{"type":"boolean"},"showGroupInfo":{"type":"boolean"},"showNoAnswer":{"type":"boolean"},"showQNumCode":{"type":"boolean"},"bounceTime":{"type":"integer"},"bounceProcessing":{"type":"boolean"},"bounceAccountType":{"type":"string"},"bounceAccountHost":{"type":"string"},"bounceAccountPass":{"type":"string"},"bounceAccountEncryption":{"type":"string"},"bounceAccountUser":{"type":"string"},"showWelcome":{"type":"boolean"},"showProgress":{"type":"boolean"},"questionIndex":{"type":"integer"},"navigationDelay":{"type":"integer"},"noKeyboard":{"type":"boolean"},"allowedItAfterCompletion":{"type":"boolean"},"googleAnalyticsStyle":{"type":"integer"},"googleAnalyticsApiKey":{"type":"string"},"showSurveyPolicyNotice":{"type":"integer"},"defaultlanguage":{"type":"object","properties":{"sid":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"welcomeText":{"type":"string"},"endText":{"type":"string"},"policyNotice":{"type":"string"},"policyError":{"type":"string"},"policyNoticeLabel":{"type":"string"},"url":{"type":"string"},"urlDescription":{"type":"string"},"dateFormat":{"type":"integer"},"numberFormat":{"type":"integer"}}}}}]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/survey-detail\/{_id}":{"get":{"tags":["Survey"],"summary":"Survey detail","operationId":"get.survey-detail.id","parameters":[{"name":"_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey Detail","description":"Survey Detail","type":"object","properties":{"survey":{"allOf":[{"title":"Survey","description":"Survey","type":"object","properties":{"sid":{"type":"integer"},"gsid":{"type":"integer"},"active":{"default":false,"type":"boolean"},"expires":{"type":"boolean"},"startDate":{"type":"boolean"},"anonymized":{"type":"boolean"},"saveTimings":{"type":"boolean"},"datestamp":{"type":"boolean"},"useCookie":{"type":"boolean"},"allowRegister":{"type":"boolean"},"htmlEmail":{"type":"boolean"},"allowSave":{"type":"boolean"},"autoNumberStart":{"default":0,"type":"integer"},"autoRedirect":{"type":"boolean"},"allowPrev":{"type":"boolean"},"printAnswers":{"type":"boolean"},"ipAddr":{"type":"boolean"},"ipAnonymize":{"type":"boolean"},"refUrl":{"type":"boolean"},"dateCreated":{"format":"date-time","type":"string"},"publicStatistics":{"type":"boolean"},"publicGraphs":{"type":"boolean"},"listPublic":{"type":"boolean"},"sendConfirmation":{"type":"boolean"},"tokenAnswersPersistence":{"type":"boolean"},"assessments":{"type":"boolean"},"useCaptcha":{"type":"boolean"},"useTokens":{"type":"boolean"},"bounceEmail":{"type":"string"},"attributeDescriptions":{"type":"string"},"emailResponseTo":{"type":"boolean"},"emailNotificationTo":{"type":"string"},"tokenLength":{"type":"integer","example":15},"showXQuestions":{"type":"boolean"},"showGroupInfo":{"type":"boolean"},"showNoAnswer":{"type":"boolean"},"showQNumCode":{"type":"boolean"},"bounceTime":{"type":"integer"},"bounceProcessing":{"type":"boolean"},"bounceAccountType":{"type":"string"},"bounceAccountHost":{"type":"string"},"bounceAccountPass":{"type":"string"},"bounceAccountEncryption":{"type":"string"},"bounceAccountUser":{"type":"string"},"showWelcome":{"type":"boolean"},"showProgress":{"type":"boolean"},"questionIndex":{"type":"integer"},"navigationDelay":{"type":"integer"},"noKeyboard":{"type":"boolean"},"allowedItAfterCompletion":{"type":"boolean"},"googleAnalyticsStyle":{"type":"integer"},"googleAnalyticsApiKey":{"type":"string"},"showSurveyPolicyNotice":{"type":"integer"},"defaultlanguage":{"type":"object","properties":{"sid":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"welcomeText":{"type":"string"},"endText":{"type":"string"},"policyNotice":{"type":"string"},"policyError":{"type":"string"},"policyNoticeLabel":{"type":"string"},"url":{"type":"string"},"urlDescription":{"type":"string"},"dateFormat":{"type":"integer"},"numberFormat":{"type":"integer"}}},"languages":{"type":"array","items":{"allOf":[{"type":"string"}]}},"questionGroups":{"type":"array","items":{"title":"Question Group","description":"Question Group","type":"object","properties":{"gid":{"type":"integer"},"sid":{"type":"integer"},"groupOrder":{"type":"integer"},"randomizationGroup":{"type":"string"},"gRelevance":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"gid":{"type":"integer"},"group_order":{"type":"integer"},"groupName":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}}}},"questions":{"type":"array","items":{"title":"Question","description":"Question","type":"object","properties":{"qid":{"type":"integer"},"parentQid":{"default":0,"type":"integer"},"sid":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"preg":{"type":"string"},"other":{"type":"boolean"},"mandatory":{"type":"boolean"},"encrypted":{"type":"boolean"},"questionOrder":{"default":0,"type":"integer"},"scaleId":{"type":"integer"},"sameDefault":{"type":"boolean"},"questionThemeName":{"type":"string"},"moduleName":{"type":"string"},"gid":{"default":0,"type":"integer"},"relevance":{"type":"string"},"sameScript":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"qid":{"type":"integer"},"question":{"type":"string"},"script":{"type":"string"},"language":{"type":"string"}}}},"answers":{"type":"array","items":{"allOf":[{"title":"Answer","description":"Answer","type":"object","properties":{"aid":{"type":"integer"},"qid":{"type":"integer"},"code":{"type":"string"},"sortOrder":{"type":"integer"},"assessmentValue":{"type":"integer"},"scaleId":{"type":"integer"}}}]}},"attributes":{"type":"object","properties":{"_attributeName":{"title":"Question Attributes","description":"Question Attributes","type":"object","properties":{"qid":{"type":"integer"},"_lang":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}},"":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}}}}}}}}}}}},"created_at":{"format":"date-time","type":"string"}}}]}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]},"patch":{"tags":["Survey"],"summary":"Survey update via RFC 6902 based patch","operationId":"patch.survey-detail.id","parameters":[{"name":"_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Survey Patch","description":"Survey Patch","type":"object","properties":{"patch":{"type":"array","items":{"allOf":[{"type":"object","properties":{"entity":{"enum":["survey","languageSetting","questionGroup","questionGroupL10n","question","questionL10n","questionAnswer","questionAttribute"],"type":"string"},"op":{"enum":["update","delete","create"],"type":"string"},"id":{"anyOf":[{"type":"string"},{"type":"object"}]},"props":{"type":"object"}}}]}}}},"examples":{"Example":{"value":{"patch":[{"entity":"survey","op":"update","id":282267,"props":{"anonymized":false,"language":"de-informal"}},{"entity":"languageSetting","op":"update","id":{"sid":282267,"language":"de-informal"},"props":{"title":"Beispielfragebogen f\u00fcr Limesurvey EN\/FR\/DE - reverted"}},{"entity":"questionGroup","op":"update","id":{"gid":1},"props":{"groupOrder":1000}},{"entity":"questionGroupL10n","op":"update","id":{"gid":1,"language":"de-informal"},"props":{"description":"r453q26ier steht die Beschreibung f\u00fcr die Gruppe der Textfragen. - edited"}},{"entity":"question","op":"update","id":1,"props":{"mandatory":true,"encrypted":true}},{"entity":"questionL10n","op":"update","id":{"id":1,"language":"de-informal"},"props":{"question":"Kurzer freier Text - edited"}},{"entity":"questionAttribute","op":"update","id":1,"props":{"value":"1 - edited"}},{"entity":"questionAnswer","op":"update","id":{"aid":15},"props":{"sortOrder":1000}}]}}}}}},"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/survey-template\/{_id}":{"get":{"tags":["Survey"],"summary":"Survey template","operationId":"get.survey-template.id","parameters":[{"name":"_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey Template","description":"Survey Template","type":"object","properties":{"survey":{"allOf":[{"title":"Survey","description":"Survey","type":"object","properties":{"sid":{"type":"integer"},"gsid":{"type":"integer"},"active":{"default":false,"type":"boolean"},"expires":{"type":"boolean"},"startDate":{"type":"boolean"},"anonymized":{"type":"boolean"},"saveTimings":{"type":"boolean"},"datestamp":{"type":"boolean"},"useCookie":{"type":"boolean"},"allowRegister":{"type":"boolean"},"htmlEmail":{"type":"boolean"},"allowSave":{"type":"boolean"},"autoNumberStart":{"default":0,"type":"integer"},"autoRedirect":{"type":"boolean"},"allowPrev":{"type":"boolean"},"printAnswers":{"type":"boolean"},"ipAddr":{"type":"boolean"},"ipAnonymize":{"type":"boolean"},"refUrl":{"type":"boolean"},"dateCreated":{"format":"date-time","type":"string"},"publicStatistics":{"type":"boolean"},"publicGraphs":{"type":"boolean"},"listPublic":{"type":"boolean"},"sendConfirmation":{"type":"boolean"},"tokenAnswersPersistence":{"type":"boolean"},"assessments":{"type":"boolean"},"useCaptcha":{"type":"boolean"},"useTokens":{"type":"boolean"},"bounceEmail":{"type":"string"},"attributeDescriptions":{"type":"string"},"emailResponseTo":{"type":"boolean"},"emailNotificationTo":{"type":"string"},"tokenLength":{"type":"integer","example":15},"showXQuestions":{"type":"boolean"},"showGroupInfo":{"type":"boolean"},"showNoAnswer":{"type":"boolean"},"showQNumCode":{"type":"boolean"},"bounceTime":{"type":"integer"},"bounceProcessing":{"type":"boolean"},"bounceAccountType":{"type":"string"},"bounceAccountHost":{"type":"string"},"bounceAccountPass":{"type":"string"},"bounceAccountEncryption":{"type":"string"},"bounceAccountUser":{"type":"string"},"showWelcome":{"type":"boolean"},"showProgress":{"type":"boolean"},"questionIndex":{"type":"integer"},"navigationDelay":{"type":"integer"},"noKeyboard":{"type":"boolean"},"allowedItAfterCompletion":{"type":"boolean"},"googleAnalyticsStyle":{"type":"integer"},"googleAnalyticsApiKey":{"type":"string"},"showSurveyPolicyNotice":{"type":"integer"},"defaultlanguage":{"type":"object","properties":{"sid":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"welcomeText":{"type":"string"},"endText":{"type":"string"},"policyNotice":{"type":"string"},"policyError":{"type":"string"},"policyNoticeLabel":{"type":"string"},"url":{"type":"string"},"urlDescription":{"type":"string"},"dateFormat":{"type":"integer"},"numberFormat":{"type":"integer"}}},"languages":{"type":"array","items":{"allOf":[{"type":"string"}]}},"questionGroups":{"type":"array","items":{"title":"Question Group","description":"Question Group","type":"object","properties":{"gid":{"type":"integer"},"sid":{"type":"integer"},"groupOrder":{"type":"integer"},"randomizationGroup":{"type":"string"},"gRelevance":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"gid":{"type":"integer"},"group_order":{"type":"integer"},"groupName":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}}}},"questions":{"type":"array","items":{"title":"Question","description":"Question","type":"object","properties":{"qid":{"type":"integer"},"parentQid":{"default":0,"type":"integer"},"sid":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"preg":{"type":"string"},"other":{"type":"boolean"},"mandatory":{"type":"boolean"},"encrypted":{"type":"boolean"},"questionOrder":{"default":0,"type":"integer"},"scaleId":{"type":"integer"},"sameDefault":{"type":"boolean"},"questionThemeName":{"type":"string"},"moduleName":{"type":"string"},"gid":{"default":0,"type":"integer"},"relevance":{"type":"string"},"sameScript":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"qid":{"type":"integer"},"question":{"type":"string"},"script":{"type":"string"},"language":{"type":"string"}}}},"answers":{"type":"array","items":{"allOf":[{"title":"Answer","description":"Answer","type":"object","properties":{"aid":{"type":"integer"},"qid":{"type":"integer"},"code":{"type":"string"},"sortOrder":{"type":"integer"},"assessmentValue":{"type":"integer"},"scaleId":{"type":"integer"}}}]}},"attributes":{"type":"object","properties":{"_attributeName":{"title":"Question Attributes","description":"Question Attributes","type":"object","properties":{"qid":{"type":"integer"},"_lang":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}},"":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}}}}}}}}}}}},"created_at":{"format":"date-time","type":"string"}}}]}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Survey"],"summary":"Survey template","operationId":"post.survey-template.id","parameters":[{"name":"_id","in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"title":"Survey Template","description":"Survey Template","type":"object","properties":{"survey":{"allOf":[{"title":"Survey","description":"Survey","type":"object","properties":{"sid":{"type":"integer"},"gsid":{"type":"integer"},"active":{"default":false,"type":"boolean"},"expires":{"type":"boolean"},"startDate":{"type":"boolean"},"anonymized":{"type":"boolean"},"saveTimings":{"type":"boolean"},"datestamp":{"type":"boolean"},"useCookie":{"type":"boolean"},"allowRegister":{"type":"boolean"},"htmlEmail":{"type":"boolean"},"allowSave":{"type":"boolean"},"autoNumberStart":{"default":0,"type":"integer"},"autoRedirect":{"type":"boolean"},"allowPrev":{"type":"boolean"},"printAnswers":{"type":"boolean"},"ipAddr":{"type":"boolean"},"ipAnonymize":{"type":"boolean"},"refUrl":{"type":"boolean"},"dateCreated":{"format":"date-time","type":"string"},"publicStatistics":{"type":"boolean"},"publicGraphs":{"type":"boolean"},"listPublic":{"type":"boolean"},"sendConfirmation":{"type":"boolean"},"tokenAnswersPersistence":{"type":"boolean"},"assessments":{"type":"boolean"},"useCaptcha":{"type":"boolean"},"useTokens":{"type":"boolean"},"bounceEmail":{"type":"string"},"attributeDescriptions":{"type":"string"},"emailResponseTo":{"type":"boolean"},"emailNotificationTo":{"type":"string"},"tokenLength":{"type":"integer","example":15},"showXQuestions":{"type":"boolean"},"showGroupInfo":{"type":"boolean"},"showNoAnswer":{"type":"boolean"},"showQNumCode":{"type":"boolean"},"bounceTime":{"type":"integer"},"bounceProcessing":{"type":"boolean"},"bounceAccountType":{"type":"string"},"bounceAccountHost":{"type":"string"},"bounceAccountPass":{"type":"string"},"bounceAccountEncryption":{"type":"string"},"bounceAccountUser":{"type":"string"},"showWelcome":{"type":"boolean"},"showProgress":{"type":"boolean"},"questionIndex":{"type":"integer"},"navigationDelay":{"type":"integer"},"noKeyboard":{"type":"boolean"},"allowedItAfterCompletion":{"type":"boolean"},"googleAnalyticsStyle":{"type":"integer"},"googleAnalyticsApiKey":{"type":"string"},"showSurveyPolicyNotice":{"type":"integer"},"defaultlanguage":{"type":"object","properties":{"sid":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"welcomeText":{"type":"string"},"endText":{"type":"string"},"policyNotice":{"type":"string"},"policyError":{"type":"string"},"policyNoticeLabel":{"type":"string"},"url":{"type":"string"},"urlDescription":{"type":"string"},"dateFormat":{"type":"integer"},"numberFormat":{"type":"integer"}}},"languages":{"type":"array","items":{"allOf":[{"type":"string"}]}},"questionGroups":{"type":"array","items":{"title":"Question Group","description":"Question Group","type":"object","properties":{"gid":{"type":"integer"},"sid":{"type":"integer"},"groupOrder":{"type":"integer"},"randomizationGroup":{"type":"string"},"gRelevance":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"gid":{"type":"integer"},"group_order":{"type":"integer"},"groupName":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}}}},"questions":{"type":"array","items":{"title":"Question","description":"Question","type":"object","properties":{"qid":{"type":"integer"},"parentQid":{"default":0,"type":"integer"},"sid":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"preg":{"type":"string"},"other":{"type":"boolean"},"mandatory":{"type":"boolean"},"encrypted":{"type":"boolean"},"questionOrder":{"default":0,"type":"integer"},"scaleId":{"type":"integer"},"sameDefault":{"type":"boolean"},"questionThemeName":{"type":"string"},"moduleName":{"type":"string"},"gid":{"default":0,"type":"integer"},"relevance":{"type":"string"},"sameScript":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"qid":{"type":"integer"},"question":{"type":"string"},"script":{"type":"string"},"language":{"type":"string"}}}},"answers":{"type":"array","items":{"allOf":[{"title":"Answer","description":"Answer","type":"object","properties":{"aid":{"type":"integer"},"qid":{"type":"integer"},"code":{"type":"string"},"sortOrder":{"type":"integer"},"assessmentValue":{"type":"integer"},"scaleId":{"type":"integer"}}}]}},"attributes":{"type":"object","properties":{"_attributeName":{"title":"Question Attributes","description":"Question Attributes","type":"object","properties":{"qid":{"type":"integer"},"_lang":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}},"":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}}}}}}}}}}}},"created_at":{"format":"date-time","type":"string"}}}]}}},"examples":{"Example":{"value":{"language":"en"}}}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey Template","description":"Survey Template","type":"object","properties":{"survey":{"allOf":[{"title":"Survey","description":"Survey","type":"object","properties":{"sid":{"type":"integer"},"gsid":{"type":"integer"},"active":{"default":false,"type":"boolean"},"expires":{"type":"boolean"},"startDate":{"type":"boolean"},"anonymized":{"type":"boolean"},"saveTimings":{"type":"boolean"},"datestamp":{"type":"boolean"},"useCookie":{"type":"boolean"},"allowRegister":{"type":"boolean"},"htmlEmail":{"type":"boolean"},"allowSave":{"type":"boolean"},"autoNumberStart":{"default":0,"type":"integer"},"autoRedirect":{"type":"boolean"},"allowPrev":{"type":"boolean"},"printAnswers":{"type":"boolean"},"ipAddr":{"type":"boolean"},"ipAnonymize":{"type":"boolean"},"refUrl":{"type":"boolean"},"dateCreated":{"format":"date-time","type":"string"},"publicStatistics":{"type":"boolean"},"publicGraphs":{"type":"boolean"},"listPublic":{"type":"boolean"},"sendConfirmation":{"type":"boolean"},"tokenAnswersPersistence":{"type":"boolean"},"assessments":{"type":"boolean"},"useCaptcha":{"type":"boolean"},"useTokens":{"type":"boolean"},"bounceEmail":{"type":"string"},"attributeDescriptions":{"type":"string"},"emailResponseTo":{"type":"boolean"},"emailNotificationTo":{"type":"string"},"tokenLength":{"type":"integer","example":15},"showXQuestions":{"type":"boolean"},"showGroupInfo":{"type":"boolean"},"showNoAnswer":{"type":"boolean"},"showQNumCode":{"type":"boolean"},"bounceTime":{"type":"integer"},"bounceProcessing":{"type":"boolean"},"bounceAccountType":{"type":"string"},"bounceAccountHost":{"type":"string"},"bounceAccountPass":{"type":"string"},"bounceAccountEncryption":{"type":"string"},"bounceAccountUser":{"type":"string"},"showWelcome":{"type":"boolean"},"showProgress":{"type":"boolean"},"questionIndex":{"type":"integer"},"navigationDelay":{"type":"integer"},"noKeyboard":{"type":"boolean"},"allowedItAfterCompletion":{"type":"boolean"},"googleAnalyticsStyle":{"type":"integer"},"googleAnalyticsApiKey":{"type":"string"},"showSurveyPolicyNotice":{"type":"integer"},"defaultlanguage":{"type":"object","properties":{"sid":{"type":"integer"},"language":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"welcomeText":{"type":"string"},"endText":{"type":"string"},"policyNotice":{"type":"string"},"policyError":{"type":"string"},"policyNoticeLabel":{"type":"string"},"url":{"type":"string"},"urlDescription":{"type":"string"},"dateFormat":{"type":"integer"},"numberFormat":{"type":"integer"}}},"languages":{"type":"array","items":{"allOf":[{"type":"string"}]}},"questionGroups":{"type":"array","items":{"title":"Question Group","description":"Question Group","type":"object","properties":{"gid":{"type":"integer"},"sid":{"type":"integer"},"groupOrder":{"type":"integer"},"randomizationGroup":{"type":"string"},"gRelevance":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"gid":{"type":"integer"},"group_order":{"type":"integer"},"groupName":{"type":"string"},"description":{"type":"string"},"language":{"type":"string"}}}},"questions":{"type":"array","items":{"title":"Question","description":"Question","type":"object","properties":{"qid":{"type":"integer"},"parentQid":{"default":0,"type":"integer"},"sid":{"type":"integer"},"type":{"type":"string"},"title":{"type":"string"},"preg":{"type":"string"},"other":{"type":"boolean"},"mandatory":{"type":"boolean"},"encrypted":{"type":"boolean"},"questionOrder":{"default":0,"type":"integer"},"scaleId":{"type":"integer"},"sameDefault":{"type":"boolean"},"questionThemeName":{"type":"string"},"moduleName":{"type":"string"},"gid":{"default":0,"type":"integer"},"relevance":{"type":"string"},"sameScript":{"type":"string"},"l10ns":{"additionalProperties":{"properties":{"id":{"type":"integer"},"qid":{"type":"integer"},"question":{"type":"string"},"script":{"type":"string"},"language":{"type":"string"}}}},"answers":{"type":"array","items":{"allOf":[{"title":"Answer","description":"Answer","type":"object","properties":{"aid":{"type":"integer"},"qid":{"type":"integer"},"code":{"type":"string"},"sortOrder":{"type":"integer"},"assessmentValue":{"type":"integer"},"scaleId":{"type":"integer"}}}]}},"attributes":{"type":"object","properties":{"_attributeName":{"title":"Question Attributes","description":"Question Attributes","type":"object","properties":{"qid":{"type":"integer"},"_lang":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}},"":{"title":"Question Attribute","description":"Question Attribute","type":"object","properties":{"qaid":{"type":"integer"},"attribute":{"default":0,"type":"integer"},"value":{"type":"string"},"language":{"default":"","type":"string"}}}}}}}}}}}}},"created_at":{"format":"date-time","type":"string"}}}]}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/auth":{"post":{"tags":["Auth"],"summary":"Generate new authentication token","operationId":"post.auth","requestBody":{"content":{"application\/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"200":{"description":"Success - returns string access token for use in header \"Authorization: Bearer $token\"","content":{"application\/json":{"schema":{"type":"string","example":"%7&!T%EYd@PnDB49MRfwQ!KjX48J^3x6rDhyB6DK"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}}},"put":{"tags":["Auth"],"summary":"Refresh authentication token","operationId":"put.auth","responses":{"200":{"description":"Success - returns string access token for use in header \"Authorization: Bearer $token\"","content":{"application\/json":{"schema":{"type":"string","example":"%7&!T%EYd@PnDB49MRfwQ!KjX48J^3x6rDhyB6DK"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Auth"],"summary":"Destroy currently used authentication token","operationId":"delete.auth","responses":{"200":{"description":"Success"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/session":{"post":{"tags":["Session"],"summary":"Generate new authentication token","operationId":"post.session","requestBody":{"content":{"application\/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}}},"responses":{"200":{"description":"Success - returns string access token for use in header \"Authorization: Bearer $token\"","content":{"application\/json":{"schema":{"type":"string","example":"%7&!T%EYd@PnDB49MRfwQ!KjX48J^3x6rDhyB6DK"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}}},"put":{"tags":["Session"],"summary":"Refresh authentication token","operationId":"put.session","responses":{"200":{"description":"Success - returns string access token for use in header \"Authorization: Bearer $token\"","content":{"application\/json":{"schema":{"type":"string","example":"%7&!T%EYd@PnDB49MRfwQ!KjX48J^3x6rDhyB6DK"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Session"],"summary":"Destroy currently used authentication token","operationId":"delete.session","responses":{"200":{"description":"Success"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/survey-group-list":{"get":{"tags":["Survey Group"],"summary":"Survey group list","operationId":"get.survey-group-list","parameters":[{"name":"pageSize","in":"query","schema":{"type":"integer"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey Group List","description":"Survey Group List","type":"object","properties":{"surveyGroups":{"type":"array","items":{"allOf":[{"title":"Survey Group","description":"Survey Group","type":"object","properties":{"gsid":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"alwaysAvailable":{"type":"boolean"}}}]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/survey-groups":{"get":{"tags":["Survey Group"],"summary":"Survey groups","operationId":"get.survey-groups","parameters":[{"name":"pageSize","in":"query","schema":{"type":"integer"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Survey Group List","description":"Survey Group List","type":"object","properties":{"surveyGroups":{"type":"array","items":{"allOf":[{"title":"Survey Group","description":"Survey Group","type":"object","properties":{"gsid":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"alwaysAvailable":{"type":"boolean"}}}]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/user":{"get":{"tags":["User"],"summary":"User list","operationId":"get.user","parameters":[{"name":"pageSize","in":"query","schema":{"type":"integer"}},{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"User List","description":"User List","type":"object","properties":{"users":{"type":"array","items":{"allOf":[{"title":"User","description":"User","type":"object","properties":{"uid":{"type":"integer"},"name":{"type":"string"},"fullName":{"type":"string"},"parentId":{"type":"integer"},"lang":{"type":"string"},"email":{"type":"string"},"htmlEditorMode":{"type":"string"},"templateEditorMode":{"type":"string"},"questionSelectorMode":{"type":"string"},"dateFormat":{"type":"integer"},"lastLogin":{"type":"string"},"created":{"type":"string"},"modified":{"type":"string"},"userStatus":{"type":"integer"}}}]}}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/user-detail\/{_id}":{"get":{"tags":["User"],"summary":"User detail","operationId":"get.user-detail.id","parameters":[{"name":"_id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"User","description":"User","type":"object","properties":{"uid":{"type":"integer"},"name":{"type":"string"},"fullName":{"type":"string"},"parentId":{"type":"integer"},"lang":{"type":"string"},"email":{"type":"string"},"htmlEditorMode":{"type":"string"},"templateEditorMode":{"type":"string"},"questionSelectorMode":{"type":"string"},"dateFormat":{"type":"integer"},"lastLogin":{"type":"string"},"created":{"type":"string"},"modified":{"type":"string"},"userStatus":{"type":"integer"}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}},"\/rest\/v1\/site-settings":{"get":{"tags":["Site Settings"],"summary":"Site Settings","operationId":"get.site-settings","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"title":"Site Settings","description":"Site Settings","type":"object","properties":{"siteName":{"type":"string"},"timezone":{"type":"string"}}}}}}}}},"\/rest\/v1\/file-upload-survey-image\/{_id}":{"post":{"tags":["File Upload"],"summary":"File upload via Axios post request (multipart\/form-data)","operationId":"post.file-upload-survey-image.id","parameters":[{"name":"_id","in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload","format":"binary","type":"string"}}}}}},"responses":{"200":{"description":"Success"},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}},"404":{"description":"Not Found","content":{"application\/json":{"schema":{"title":"Error","description":"Error","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"}}}}}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Bearer Auth","scheme":"bearer"}}},"tags":[{"name":"Survey","description":"Survey"},{"name":"Auth","description":"Auth"},{"name":"Session","description":"Session (deprecated - use auth)"},{"name":"Survey Group","description":"Survey Group"},{"name":"User","description":"User"},{"name":"Site Settings","description":"Site Settings"},{"name":"File Upload","description":"File Upload"}]}