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

Class UserPortalService

java.lang.Object

de.xima.fc.api.rest.services.UserPortalService

@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Path("/user-portals")
public class UserPortalService
extends Object

REST service providing endpoints for user profiles.

Since:

8.2.0

Author:

XIMA Media GmbH

Constructor Summary

Constructors

Constructor	Description
UserPortalService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	downloadUserPortalFile(UUID userPortalUuid, UUID fileUuid)
javax.ws.rs.core.Response	downloadUserPortalFiles(UUID userPortalUuid)
javax.ws.rs.core.Response	getSingleUserPortal(UUID userPortalUuid)
javax.ws.rs.core.Response	getSingleUserPortalByAlias(String userPortalAlias)
javax.ws.rs.core.Response	getUserPortalAuthenticators(UUID userPortalUuid, int pageSize, int page)
javax.ws.rs.core.Response	getUserPortalFiles(UUID userPortalUuid, int pageSize, int page)
javax.ws.rs.core.Response	getUserPortalFiles(UUID userPortalUuid, UUID fileUuid)
javax.ws.rs.core.Response	getUserPortalForms(UUID userPortalUuid, int pageSize, int page)
javax.ws.rs.core.Response	getUserPortals(int pageSize, int page)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPortalService

public UserPortalService()

Method Detail

getUserPortals

@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 getUserPortals(@QueryParam("size") @DefaultValue("10")
                                                int pageSize,
                                                @QueryParam("page") @DefaultValue("1")
                                                int page)

getSingleUserPortal

@GET
@Path("/{userPortalUuid}")
@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 getSingleUserPortal(@PathParam("userPortalUuid")
                                                     UUID userPortalUuid)

getSingleUserPortalByAlias

@GET
@Path("/alias/{userPortalAlias}")
@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 getSingleUserPortalByAlias(@PathParam("userPortalAlias")
                                                            String userPortalAlias)

getUserPortalAuthenticators

@GET
@Path("/{userPortalUuid}/authenticators")
@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 getUserPortalAuthenticators(@PathParam("userPortalUuid")
                                                             UUID userPortalUuid,
                                                             @QueryParam("size") @DefaultValue("10")
                                                             int pageSize,
                                                             @QueryParam("page") @DefaultValue("1")
                                                             int page)

getUserPortalForms

@GET
@Path("/{userPortalUuid}/forms")
@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 getUserPortalForms(@PathParam("userPortalUuid")
                                                    UUID userPortalUuid,
                                                    @QueryParam("size") @DefaultValue("10")
                                                    int pageSize,
                                                    @QueryParam("page") @DefaultValue("1")
                                                    int page)

getUserPortalFiles

@GET
@Path("/{userPortalUuid}/files")
@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 getUserPortalFiles(@PathParam("userPortalUuid")
                                                    UUID userPortalUuid,
                                                    @QueryParam("size") @DefaultValue("10")
                                                    int pageSize,
                                                    @QueryParam("page") @DefaultValue("1")
                                                    int page)

downloadUserPortalFiles

@GET
@Path("/{userPortalUuid}/files/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 downloadUserPortalFiles(@PathParam("userPortalUuid")
                                                         UUID userPortalUuid)

getUserPortalFiles

@GET
@Path("/{userPortalUuid}/files/{fileUuid}")
@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 getUserPortalFiles(@PathParam("userPortalUuid")
                                                    UUID userPortalUuid,
                                                    @PathParam("fileUuid")
                                                    UUID fileUuid)

downloadUserPortalFile

@GET
@Path("/{userPortalUuid}/files/{fileUuid}/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 downloadUserPortalFile(@PathParam("userPortalUuid")
                                                        UUID userPortalUuid,
                                                        @PathParam("fileUuid")
                                                        UUID fileUuid)