• Home
• fi.metatavu.edelphi
• edelphi-api-spec
• 1.0.36
• source code
• PanelsApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

fi.metatavu.edelphi.rest.api.PanelsApi Maven / Gradle / Ivy

package fi.metatavu.edelphi.rest.api;

import fi.metatavu.edelphi.rest.model.*;
import java.util.UUID;

import javax.ws.rs.*;
import javax.ws.rs.core.Response;

import io.swagger.annotations.*;

import java.util.Map;
import java.util.List;
import javax.validation.constraints.*;
import javax.validation.Valid;

@Path("/panels")
@Api(description = "the panels API")
@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaJAXRSSpecServerCodegen", date = "2019-09-11T17:40:23.904+03:00[Europe/Helsinki]")
public interface PanelsApi {

    @POST
    @Path("/{panelId}/queryQuestionComments")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Create query question comment", notes = "Creates query question comment", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionComments" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Created query question comment", response = QueryQuestionComment.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response createQueryQuestionComment(@Valid QueryQuestionComment body,@PathParam("panelId")  Long panelId);
    @POST
    @Path("/{panelId}/queryQuestionCommentCategories")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Create query question category", notes = "Creates query question category", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionCommentCategories" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Created query question category", response = QueryQuestionCommentCategory.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response createQueryQuestionCommentCategory(@Valid QueryQuestionCommentCategory body,@PathParam("panelId")  Long panelId);
    @DELETE
    @Path("/{panelId}/queryQuestionAnswers")
    @Produces({ "application/json" })
    @ApiOperation(value = "Delete query question answers", notes = "Deletes query question answers", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionAnswers" })
    @ApiResponses(value = { 
        @ApiResponse(code = 204, message = "Success", response = Void.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response deleteQueryQuestionAnswers(@PathParam("panelId")  Long panelId,@QueryParam("queryId")     Long queryId,@QueryParam("queryPageId")     Long queryPageId,@QueryParam("querySectionId")     Long querySectionId);
    @DELETE
    @Path("/{panelId}/queryQuestionComments/{commentId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Delete query question comment", notes = "Deletes query question comment", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionComments" })
    @ApiResponses(value = { 
        @ApiResponse(code = 204, message = "No content to indicate successful delete", response = Void.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response deleteQueryQuestionComment(@PathParam("panelId")  Long panelId,@PathParam("commentId")  Long commentId);
    @DELETE
    @Path("/{panelId}/queryQuestionCommentCategories/{categoryId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Delete query question category", notes = "Deletes query question category", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionCommentCategories" })
    @ApiResponses(value = { 
        @ApiResponse(code = 204, message = "No content to indicate successful delete", response = Void.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response deleteQueryQuestionCommentCategory(@PathParam("panelId")  Long panelId,@PathParam("categoryId")  Long categoryId);
    @GET
    @Path("/{panelId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Find a panel.", notes = "Finds a panel by id", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "Panels" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A panel", response = Panel.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response findPanel(@PathParam("panelId")  Long panelId);
    @GET
    @Path("/{panelId}/queryPages/{queryPageId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Find query page.", notes = "Finds query page by id", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryPages" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A queryPage", response = QueryPage.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response findQueryPage(@PathParam("panelId")  Long panelId,@PathParam("queryPageId")  Long queryPageId);
    @GET
    @Path("/{panelId}/queryQuestionAnswers/{answerId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Find query question answer.", notes = "Finds query question answer by id", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionAnswers" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A queryQuestionAnswer", response = QueryQuestionAnswer.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response findQueryQuestionAnswer(@PathParam("panelId")  Long panelId,@PathParam("answerId")  String answerId);
    @GET
    @Path("/{panelId}/queryQuestionComments/{commentId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Find query question comment", notes = "Finds query question comment by id", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionComments" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A queryQuestionComment", response = QueryQuestionComment.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response findQueryQuestionComment(@PathParam("panelId")  Long panelId,@PathParam("commentId")  Long commentId);
    @GET
    @Path("/{panelId}/queryQuestionCommentCategories/{categoryId}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Find query question category", notes = "Finds query question category by id", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionCommentCategories" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A queryQuestionCommentCategory", response = QueryQuestionCommentCategory.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response findQueryQuestionCommentCategory(@PathParam("panelId")  Long panelId,@PathParam("categoryId")  Long categoryId);
    @GET
    @Path("/{panelId}/expertiseClasses")
    @Produces({ "application/json" })
    @ApiOperation(value = "List panel expertise classes", notes = "List defined expertise classes from a panel", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "PanelExpertise" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of panel expertise classes", response = PanelExpertiseClass.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listExpertiseClasses(@PathParam("panelId")  Long panelId);
    @GET
    @Path("/{panelId}/expertiseGroups")
    @Produces({ "application/json" })
    @ApiOperation(value = "List panel expertise groups", notes = "List defined expertise groups from a panel", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "PanelExpertise" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of panel expertise groups", response = PanelExpertiseGroup.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listExpertiseGroups(@PathParam("panelId")  Long panelId);
    @GET
    @Path("/{panelId}/interestClasses")
    @Produces({ "application/json" })
    @ApiOperation(value = "List panel interest classes", notes = "List defined interest classes from a panel", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "PanelExpertise" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of panel interest classes", response = PanelInterestClass.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listInterestClasses(@PathParam("panelId")  Long panelId);
    @GET
    @Path("/{panelId}/queries")
    @Produces({ "application/json" })
    @ApiOperation(value = "Lists queries in a panel.", notes = "Lists queries in a panel", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "Queries" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of panel queries", response = Query.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listQueries(@PathParam("panelId")  Long panelId);
    @GET
    @Path("/{panelId}/queryPages")
    @Produces({ "application/json" })
    @ApiOperation(value = "Lists query pages.", notes = "Lists query pages", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryPages" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "A queryPage", response = QueryPage.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listQueryPages(@PathParam("panelId")  Long panelId,@QueryParam("queryId")     Long queryId,@QueryParam("includeHidden")     Boolean includeHidden);
    @GET
    @Path("/{panelId}/queryQuestionAnswers")
    @Produces({ "application/json" })
    @ApiOperation(value = "Lists query question answers", notes = "Lists query question answers", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionAnswers" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of query question answers", response = QueryQuestionAnswer.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listQueryQuestionAnswers(@PathParam("panelId")  Long panelId,@QueryParam("queryId")     Long queryId,@QueryParam("pageId")     Long pageId,@QueryParam("userId")     UUID userId,@QueryParam("stampId")     Long stampId);
    @GET
    @Path("/{panelId}/queryQuestionCommentCategories")
    @Produces({ "application/json" })
    @ApiOperation(value = "Lists query question categories", notes = "Lists query question categories", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionCommentCategories" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of query question categories", response = QueryQuestionCommentCategory.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listQueryQuestionCommentCategories(@PathParam("panelId")  Long panelId,@QueryParam("pageId")     Long pageId,@QueryParam("queryId")     Long queryId);
    @GET
    @Path("/{panelId}/queryQuestionComments")
    @Produces({ "application/json" })
    @ApiOperation(value = "Lists query question comments", notes = "Lists query question comments", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionComments" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "List of query question comments", response = QueryQuestionComment.class, responseContainer = "List"),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class, responseContainer = "List"),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class, responseContainer = "List") })
    Response listQueryQuestionComments(@PathParam("panelId")  Long panelId,@QueryParam("queryId")     Long queryId,@QueryParam("pageId")     Long pageId,@QueryParam("userId")     UUID userId,@QueryParam("stampId")     Long stampId,@QueryParam("parentId")     Long parentId,@QueryParam("categoryId")     Long categoryId);
    @PUT
    @Path("/{panelId}/queryPages/{queryPageId}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Update query page", notes = "Updates query page", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryPages" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Updated query page", response = QueryPage.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response updateQueryPage(@Valid QueryPage body,@PathParam("panelId")  Long panelId,@PathParam("queryPageId")  Long queryPageId);
    @PUT
    @Path("/{panelId}/queryQuestionComments/{commentId}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Update query question comment", notes = "Updates query question comment", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionComments" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Updated query question comment", response = QueryQuestionComment.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response updateQueryQuestionComment(@Valid QueryQuestionComment body,@PathParam("panelId")  Long panelId,@PathParam("commentId")  Long commentId);
    @PUT
    @Path("/{panelId}/queryQuestionCommentCategories/{categoryId}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Update query question category", notes = "Updates query question category", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionCommentCategories" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Updated query question category", response = QueryQuestionCommentCategory.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response updateQueryQuestionCommentCategory(@Valid QueryQuestionCommentCategory body,@PathParam("panelId")  Long panelId,@PathParam("categoryId")  Long categoryId);
    @PUT
    @Path("/{panelId}/queryQuestionAnswers/{answerId}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Creates or updates query question answer", notes = "Creates or updates query question answer", authorizations = {
        @Authorization(value = "bearer")    }, tags={ "QueryQuestionAnswers" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "Updated query question answer", response = QueryQuestionAnswer.class),
        @ApiResponse(code = 400, message = "Invalid request was sent to the server", response = ErrorResponse.class),
        @ApiResponse(code = 403, message = "Attempted to make a call with unauthorized client", response = ErrorResponse.class),
        @ApiResponse(code = 500, message = "Internal server error", response = ErrorResponse.class) })
    Response upsertQueryQuestionAnswer(@Valid QueryQuestionAnswer body,@PathParam("panelId")  Long panelId,@PathParam("answerId")  String answerId);}