nl.vpro.rs.pages.update

Interface PageUpdateRestService

@Path(value="/pages/updates")
 @Consumes(value="application/xml")
 @Produces(value="application/xml")
 @Description(value="Services on https://publish.pages.omroep.nl/pages/updates")
public interface PageUpdateRestService

The Rest Interface is implemented by PageUpdateRestServiceImpl, but can also be used to generate clients.

Since:

3.0

Author:

Roelof Jan Koekoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MATCH
static String	PATH
static String	URL
static String	WAIT

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(@NotNull String url, Boolean batch, Integer max, Boolean wait, PageIdMatch match, javax.servlet.http.HttpServletResponse response)
PageUpdate	load(@NotNull String url, boolean loadDeleted, PageIdMatch match)
javax.ws.rs.core.Response	save(@NotNull @Valid PageUpdate update, Boolean wait)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

WAIT

static final String WAIT

See Also:

Constant Field Values

MATCH

static final String MATCH

See Also:

Constant Field Values

URL

static final String URL

See Also:

Constant Field Values

Method Detail

save

@POST
 @Path(value="")
javax.ws.rs.core.Response save(@NotNull @Valid
                                                      @NotNull @Valid PageUpdate update,
                                                      @QueryParam(value="wait")
                                                      Boolean wait)

delete

@DELETE
 @Produces(value={"application/xml","application/json"})
 @Path(value="")
javax.ws.rs.core.Response delete(@QueryParam(value="url") @NotNull
                                                                                                                   @NotNull String url,
                                                                                                                   @QueryParam(value="batch")
                                                                                                                   Boolean batch,
                                                                                                                   @QueryParam(value="max")
                                                                                                                   Integer max,
                                                                                                                   @QueryParam(value="wait")
                                                                                                                   Boolean wait,
                                                                                                                   @QueryParam(value="match") @DefaultValue(value="BOTH")
                                                                                                                   PageIdMatch match,
                                                                                                                   @Context
                                                                                                                   javax.servlet.http.HttpServletResponse response)

load

@GET
 @Produces(value={"application/xml","application/json"})
 @Path(value="")
PageUpdate load(@QueryParam(value="url") @NotNull
                                                                                               @NotNull String url,
                                                                                               @QueryParam(value="loadDeleted")
                                                                                               boolean loadDeleted,
                                                                                               @QueryParam(value="match") @DefaultValue(value="BOTH")
                                                                                               PageIdMatch match)