Package io.dialob.api.client

Interface DialobQuestionnaireServiceApi

All Superinterfaces:
ApiClient.Api
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen", date="2023-09-29T12:45:39.934004759Z[Etc/UTC]") public interface DialobQuestionnaireServiceApi extends ApiClient.Api

  • Method Details

    • deleteQuestionnaire

      Response deleteQuestionnaire(String questionnaireId)
      deleteQuestionnaire
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      Response

    • deleteQuestionnaireAnswer

      List<Error> deleteQuestionnaireAnswer(String answerId, String questionnaireId)
      deleteQuestionnaireAnswer
      Parameters:
      answerId - answerId (required)
      questionnaireId - questionnaireId (required)
      Returns:
      List<Error>

    • deleteQuestionnaireItemRow

      List<String> deleteQuestionnaireItemRow(String itemId, String questionnaireId, String rowId)
      deleteQuestionnaireItemRow
      Parameters:
      itemId - itemId (required)
      questionnaireId - questionnaireId (required)
      rowId - rowId (required)
      Returns:
      List<String>

    • getQuestionnaire

      Questionnaire getQuestionnaire(String questionnaireId)
      getQuestionnaire
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      Questionnaire

    • getQuestionnaireAnswers

      List<Answer> getQuestionnaireAnswers(String questionnaireId)
      getQuestionnaireAnswers
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      List<Answer>

    • getQuestionnaireErrors

      List<Error> getQuestionnaireErrors(String questionnaireId)
      getQuestionnaireErrors
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      List<Error>

    • getQuestionnaireItem

      ActionItem getQuestionnaireItem(String itemId, String questionnaireId)
      getQuestionnaireItem
      Parameters:
      itemId - itemId (required)
      questionnaireId - questionnaireId (required)
      Returns:
      ActionItem

    • getQuestionnaireItemRows

      List<String> getQuestionnaireItemRows(String itemId, String questionnaireId)
      getQuestionnaireItemRows
      Parameters:
      itemId - itemId (required)
      questionnaireId - questionnaireId (required)
      Returns:
      List<String>

    • getQuestionnaireItems

      List<ActionItem> getQuestionnaireItems(String questionnaireId)
      getQuestionnaireItems
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      List<ActionItem>

    • getQuestionnairePages

      Items getQuestionnairePages(String questionnaireId)
      getQuestionnairePages
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      Items

    • getQuestionnaireStatus

      String getQuestionnaireStatus(String questionnaireId)
      getQuestionnaireStatus
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      String

    • getQuestionnaireValueSet

      ValueSet getQuestionnaireValueSet(String questionnaireId, String valueSetId)
      getQuestionnaireValueSet
      Parameters:
      questionnaireId - questionnaireId (required)
      valueSetId - valueSetId (required)
      Returns:
      ValueSet

    • getQuestionnaireValueSets

      List<ValueSet> getQuestionnaireValueSets(String questionnaireId)
      getQuestionnaireValueSets
      Parameters:
      questionnaireId - questionnaireId (required)
      Returns:
      List<ValueSet>

    • getQuestionnaires

      List<QuestionnaireListItem> getQuestionnaires(String formId, String formName, String formTag, String owner, String status)
      getQuestionnaires
      Parameters:
      formId - formId (optional)
      formName - Search questionnaires by formName. Should not be used together with formId. (optional)
      formTag - Search questionnaires by formTag. This is ignored, if formName is not set. (optional)
      owner - owner (optional)
      status - status (optional)
      Returns:
      List<QuestionnaireListItem>

    • getQuestionnaires

      List<QuestionnaireListItem> getQuestionnaires(Map<String,Object> queryParams)
      getQuestionnaires Note, this is equivalent to the other getQuestionnaires method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the DialobQuestionnaireServiceApi.GetQuestionnairesQueryParams class that allows for building up this map in a fluent style.
      Parameters:
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • formId - formId (optional)
      • formName - Search questionnaires by formName. Should not be used together with formId. (optional)
      • formTag - Search questionnaires by formTag. This is ignored, if formName is not set. (optional)
      • owner - owner (optional)
      • status - status (optional)
      Returns:
      List<QuestionnaireListItem>

    • postQuestionnaire

      IdAndRevision postQuestionnaire(Questionnaire body)
      postQuestionnaire
      Parameters:
      body - New questionnaire object (required)
      Returns:
      IdAndRevision

    • postQuestionnaireItemRow

      List<String> postQuestionnaireItemRow(String itemId, String questionnaireId)
      postQuestionnaireItemRow
      Parameters:
      itemId - itemId (required)
      questionnaireId - questionnaireId (required)
      Returns:
      List<String>

    • putQuestionnaire

      Questionnaire putQuestionnaire(Questionnaire body, String questionnaireId)
      putQuestionnaire
      Parameters:
      body - Questionnaire object to replace existing state (required)
      questionnaireId - questionnaireId (required)
      Returns:
      Questionnaire

    • putQuestionnaireAnswer

      List<Error> putQuestionnaireAnswer(Object body, String answerId, String questionnaireId)
      putQuestionnaireAnswer
      Parameters:
      body - New answer for single question (required)
      answerId - answerId (required)
      questionnaireId - questionnaireId (required)
      Returns:
      List<Error>

    • putQuestionnaireAnswers

      List<Error> putQuestionnaireAnswers(List<Answer> body, String questionnaireId)
      putQuestionnaireAnswers
      Parameters:
      body - New answers for questionnaire (required)
      questionnaireId - questionnaireId (required)
      Returns:
      List<Error>

    • putQuestionnairePages

      Items putQuestionnairePages(Items body, String questionnaireId)
      putQuestionnairePages
      Parameters:
      body - Updates questionnaire active page (required)
      questionnaireId - questionnaireId (required)
      Returns:
      Items

    • putQuestionnaireStatus

      String putQuestionnaireStatus(String body, String questionnaireId)
      putQuestionnaireStatus
      Parameters:
      body - A new status for questionnaire (required)
      questionnaireId - questionnaireId (required)
      Returns:
      String