Package io.dialob.questionnaire.service.rest

Interface QuestionnairesRestService

All Known Implementing Classes:

QuestionnairesRestServiceController

@RequestMapping("${dialob.api.context-path:}/questionnaires")
public interface QuestionnairesRestService

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<io.dialob.api.rest.Response>	deleteQuestionnaire(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	deleteQuestionnaireAnswer(String questionnaireId, String answerId)
org.springframework.http.ResponseEntity<List<String>>	deleteQuestionnaireItemRow(String questionnaireId, String itemId, String rowId)
org.springframework.http.ResponseEntity<String>	getCsv(Optional<String> formId, Optional<String> formName, Optional<String> formTag, Optional<List<String>> questionnaires, Optional<String> language, Optional<LocalDateTime> startDate, Optional<LocalDateTime> endDate)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire>	getQuestionnaire(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Answer>>	getQuestionnaireAnswers(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	getQuestionnaireErrors(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.proto.ActionItem>	getQuestionnaireItem(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<List<String>>	getQuestionnaireItemRows(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ActionItem>>	getQuestionnaireItems(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items>	getQuestionnairePages(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.QuestionnaireListItem>>	getQuestionnaires(String owner, String formId, String formName, String formTag, io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status>	getQuestionnaireStatus(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.proto.ValueSet>	getQuestionnaireValueSet(String questionnaireId, String valueSetId)
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ValueSet>>	getQuestionnaireValueSets(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.rest.IdAndRevision>	postQuestionnaire(io.dialob.api.questionnaire.Questionnaire questionnaire)
org.springframework.http.ResponseEntity<List<String>>	postQuestionnaireItemRow(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire>	putQuestionnaire(String questionnaireId, io.dialob.api.questionnaire.Questionnaire questionnaire)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	putQuestionnaireAnswer(String questionnaireId, String answerId, Object answer)	Updates answer
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	putQuestionnaireAnswers(String questionnaireId, List<io.dialob.api.questionnaire.Answer> answers)
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items>	putQuestionnairePages(String questionnaireId, io.dialob.api.rest.Items pages)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status>	putQuestionnaireStatus(String questionnaireId, io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)

Method Detail

postQuestionnaire

@PostMapping(produces="application/json",
             consumes="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.rest.IdAndRevision> postQuestionnaire(@NonNull @RequestBody @Validated
                                                                                            io.dialob.api.questionnaire.Questionnaire questionnaire)

getQuestionnaires

@GetMapping(produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.QuestionnaireListItem>> getQuestionnaires(@RequestParam(name="owner",required=false)
                                                                                                                   String owner,
                                                                                                                   @RequestParam(name="formId",required=false)
                                                                                                                   String formId,
                                                                                                                   @RequestParam(name="formName",required=false)
                                                                                                                   String formName,
                                                                                                                   @RequestParam(name="formTag",required=false)
                                                                                                                   String formTag,
                                                                                                                   @RequestParam(name="status",required=false)
                                                                                                                   io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)

getCsv

@GetMapping(produces="text/csv")
org.springframework.http.ResponseEntity<String> getCsv(@RequestParam(name="formId")
                                                       Optional<String> formId,
                                                       @RequestParam(name="formName")
                                                       Optional<String> formName,
                                                       @RequestParam(name="formTag")
                                                       Optional<String> formTag,
                                                       @RequestParam(name="questionnaire")
                                                       Optional<List<String>> questionnaires,
                                                       @RequestParam(name="language")
                                                       Optional<String> language,
                                                       @RequestParam(name="from") @DateTimeFormat(iso=DATE_TIME)
                                                       Optional<LocalDateTime> startDate,
                                                       @RequestParam(name="to") @DateTimeFormat(iso=DATE_TIME)
                                                       Optional<LocalDateTime> endDate)

getQuestionnaire

@GetMapping(path="{questionnaireId}",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire> getQuestionnaire(@PathVariable("questionnaireId")
                                                                                                    String questionnaireId)

deleteQuestionnaire

@DeleteMapping(path="{questionnaireId}")
org.springframework.http.ResponseEntity<io.dialob.api.rest.Response> deleteQuestionnaire(@PathVariable("questionnaireId")
                                                                                         String questionnaireId)

putQuestionnaire

@PutMapping(path="{questionnaireId}",
            produces="application/json",
            consumes="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire> putQuestionnaire(@PathVariable("questionnaireId")
                                                                                                    String questionnaireId,
                                                                                                    @RequestBody @Validated
                                                                                                    io.dialob.api.questionnaire.Questionnaire questionnaire)

getQuestionnaireStatus

@GetMapping(path="{questionnaireId}/status",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status> getQuestionnaireStatus(@PathVariable("questionnaireId")
                                                                                                                          String questionnaireId)

putQuestionnaireStatus

@PutMapping(path="{questionnaireId}/status",
            produces="application/json",
            consumes="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status> putQuestionnaireStatus(@PathVariable("questionnaireId")
                                                                                                                          String questionnaireId,
                                                                                                                          @RequestBody
                                                                                                                          io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)

getQuestionnaireAnswers

@GetMapping(path="{questionnaireId}/answers",
            produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Answer>> getQuestionnaireAnswers(@PathVariable("questionnaireId")
                                                                                                          String questionnaireId)

getQuestionnaireErrors

@GetMapping(path="{questionnaireId}/errors",
            produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> getQuestionnaireErrors(@PathVariable("questionnaireId")
                                                                                                        String questionnaireId)

putQuestionnaireAnswers

@PostMapping(path="{questionnaireId}/answers",
             produces="application/json",
             consumes="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> putQuestionnaireAnswers(@PathVariable("questionnaireId")
                                                                                                         String questionnaireId,
                                                                                                         @RequestBody
                                                                                                         List<io.dialob.api.questionnaire.Answer> answers)

putQuestionnaireAnswer

@PutMapping(path="{questionnaireId}/answers/{answerId}",
            produces="application/json",
            consumes="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> putQuestionnaireAnswer(@PathVariable("questionnaireId")
                                                                                                        String questionnaireId,
                                                                                                        @PathVariable("answerId")
                                                                                                        String answerId,
                                                                                                        @RequestBody
                                                                                                        Object answer)

Updates answer

Parameters:

questionnaireId - target questionnaire id

answerId - answer id

answer - new answer value

Returns:

deleteQuestionnaireAnswer

@DeleteMapping(path="{questionnaireId}/answers/{answerId}",
               produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> deleteQuestionnaireAnswer(@PathVariable("questionnaireId")
                                                                                                           String questionnaireId,
                                                                                                           @PathVariable("answerId")
                                                                                                           String answerId)

getQuestionnairePages

@GetMapping(path="{questionnaireId}/pages",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items> getQuestionnairePages(@PathVariable("questionnaireId")
                                                                                        String questionnaireId)

putQuestionnairePages

@PutMapping(path="{questionnaireId}/pages",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items> putQuestionnairePages(@NonNull @PathVariable("questionnaireId")
                                                                                        String questionnaireId,
                                                                                        @RequestBody
                                                                                        io.dialob.api.rest.Items pages)

getQuestionnaireItems

@GetMapping(path="{questionnaireId}/items",
            produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ActionItem>> getQuestionnaireItems(@PathVariable("questionnaireId")
                                                                                                    String questionnaireId)

getQuestionnaireItem

@GetMapping(path="{questionnaireId}/items/{itemId}",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.proto.ActionItem> getQuestionnaireItem(@PathVariable("questionnaireId")
                                                                                             String questionnaireId,
                                                                                             @PathVariable("itemId")
                                                                                             String itemId)

getQuestionnaireItemRows

@GetMapping(path="{questionnaireId}/items/{itemId}/rows",
            produces="application/json")
org.springframework.http.ResponseEntity<List<String>> getQuestionnaireItemRows(@PathVariable("questionnaireId")
                                                                               String questionnaireId,
                                                                               @PathVariable("itemId")
                                                                               String itemId)

postQuestionnaireItemRow

@PostMapping(path="{questionnaireId}/items/{itemId}/rows",
             produces="application/json")
org.springframework.http.ResponseEntity<List<String>> postQuestionnaireItemRow(@PathVariable("questionnaireId")
                                                                               String questionnaireId,
                                                                               @PathVariable("itemId")
                                                                               String itemId)

deleteQuestionnaireItemRow

@DeleteMapping(path="{questionnaireId}/items/{itemId}/rows/{rowId}",
               produces="application/json")
org.springframework.http.ResponseEntity<List<String>> deleteQuestionnaireItemRow(@PathVariable("questionnaireId")
                                                                                 String questionnaireId,
                                                                                 @PathVariable("itemId")
                                                                                 String itemId,
                                                                                 @PathVariable("rowId")
                                                                                 String rowId)

getQuestionnaireValueSets

@GetMapping(path="{questionnaireId}/valueSets",
            produces="application/json")
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ValueSet>> getQuestionnaireValueSets(@PathVariable("questionnaireId")
                                                                                                      String questionnaireId)

getQuestionnaireValueSet

@GetMapping(path="{questionnaireId}/valueSets/{valueSetId}",
            produces="application/json")
org.springframework.http.ResponseEntity<io.dialob.api.proto.ValueSet> getQuestionnaireValueSet(@PathVariable("questionnaireId")
                                                                                               String questionnaireId,
                                                                                               @PathVariable("valueSetId")
                                                                                               String valueSetId)