Package de.xima.fc.api.rest.services

Class FormRecordMessageService

java.lang.Object

de.xima.fc.api.rest.services.FormRecordMessageService

@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Path("/form-record-messages")
@FcSecurity(authorizers="isFullyAuthenticated")
public class FormRecordMessageService
extends Object

Service for accessing FormRecordMessage entities via the REST API.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
FormRecordMessageService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	downloadFormRecordAttachments(UUID messageUuid, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getFormRecordAttachments(UUID messageUuid, int pageSize, int page, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getMessages(int pageSize, int page, boolean unread, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getSingleMessage(UUID messageUuid, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getUploadRequests(UUID messageUuid, int pageSize, int page, boolean unread, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	uploadAttachment(UUID messageUuid, UUID uploadRequestUuid, org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input, org.pac4j.core.profile.CommonProfile profile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormRecordMessageService

public FormRecordMessageService()

Method Detail

getMessages

@GET
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getMessages(@QueryParam("size") @DefaultValue("10")
                                             int pageSize,
                                             @QueryParam("page") @DefaultValue("1")
                                             int page,
                                             @QueryParam("unread") @DefaultValue("false")
                                             boolean unread,
                                             @Pac4JProfile
                                             org.pac4j.core.profile.CommonProfile profile)

getSingleMessage

@GET
@Path("/{messageUuid}")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getSingleMessage(@PathParam("messageUuid")
                                                  UUID messageUuid,
                                                  @Pac4JProfile
                                                  org.pac4j.core.profile.CommonProfile profile)

getUploadRequests

@GET
@Path("/{messageUuid}/upload-requests")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getUploadRequests(@PathParam("messageUuid")
                                                   UUID messageUuid,
                                                   @QueryParam("size") @DefaultValue("10")
                                                   int pageSize,
                                                   @QueryParam("page") @DefaultValue("1")
                                                   int page,
                                                   @QueryParam("unread") @DefaultValue("false")
                                                   boolean unread,
                                                   @Pac4JProfile
                                                   org.pac4j.core.profile.CommonProfile profile)

getFormRecordAttachments

@GET
@Path("/{messageUuid}/attachments")
public javax.ws.rs.core.Response getFormRecordAttachments(@PathParam("messageUuid")
                                                          UUID messageUuid,
                                                          @QueryParam("size") @DefaultValue("10")
                                                          int pageSize,
                                                          @QueryParam("page") @DefaultValue("1")
                                                          int page,
                                                          @Pac4JProfile
                                                          org.pac4j.core.profile.CommonProfile profile)

downloadFormRecordAttachments

@GET
@Path("/{messageUuid}/attachments/download")
@Produces({"application/vnd.xima.fc.api.rest.public+octet-stream; version=1.0; charset=utf-8","application/octet-stream; charset=utf-8"})
public javax.ws.rs.core.Response downloadFormRecordAttachments(@PathParam("messageUuid")
                                                               UUID messageUuid,
                                                               @Pac4JProfile
                                                               org.pac4j.core.profile.CommonProfile profile)

uploadAttachment

@POST
@Path("/{messageUuid}/attachments")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("multipart/form-data")
public javax.ws.rs.core.Response uploadAttachment(@PathParam("messageUuid")
                                                  UUID messageUuid,
                                                  @QueryParam("upload-request-uuid")
                                                  UUID uploadRequestUuid,
                                                  org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input,
                                                  @Pac4JProfile
                                                  org.pac4j.core.profile.CommonProfile profile)