org.apache.camel.component.wordpress.api.service.spi

Interface CategoriesSPI

@Path(value="/wp")
public interface CategoriesSPI

Describes the Categories Wordpress API

Since:

0.0.1

See Also:

Categories API Reference

Method Summary

Modifier and Type	Method and Description
Category	create(String apiVersion, Category category)
Category	delete(String apiVersion, int categoryId, boolean force)
List<Category>	list(String apiVersion, Context context, Integer page, Integer perPage, String search, List<Integer> exclude, List<Integer> include, Order order, CategoryOrderBy orderBy, Boolean hideEmpty, Integer parent, Integer post, String slug)
Category	retrieve(String apiVersion, int categoryId, Context context)
Category	update(String apiVersion, int categoryId, Category category)

Method Detail

list

@GET
 @Path(value="/v{apiVersion}/categories")
 @Produces(value="application/json")
List<Category> list(@PathParam(value="apiVersion")
                                                                                                        String apiVersion,
                                                                                                        @QueryParam(value="context")
                                                                                                        Context context,
                                                                                                        @QueryParam(value="page")
                                                                                                        Integer page,
                                                                                                        @QueryParam(value="per_page")
                                                                                                        Integer perPage,
                                                                                                        @QueryParam(value="search")
                                                                                                        String search,
                                                                                                        @QueryParam(value="exclude")
                                                                                                        List<Integer> exclude,
                                                                                                        @QueryParam(value="include")
                                                                                                        List<Integer> include,
                                                                                                        @QueryParam(value="order")
                                                                                                        Order order,
                                                                                                        @QueryParam(value="orderby")
                                                                                                        CategoryOrderBy orderBy,
                                                                                                        @QueryParam(value="hide_empty")
                                                                                                        Boolean hideEmpty,
                                                                                                        @QueryParam(value="parent")
                                                                                                        Integer parent,
                                                                                                        @QueryParam(value="post")
                                                                                                        Integer post,
                                                                                                        @QueryParam(value="slug")
                                                                                                        String slug)

retrieve

@GET
 @Path(value="/v{apiVersion}/categories/{id}")
 @Produces(value="application/json")
Category retrieve(@PathParam(value="apiVersion")
                                                                                                           String apiVersion,
                                                                                                           @PathParam(value="id")
                                                                                                           int categoryId,
                                                                                                           @QueryParam(value="context")
                                                                                                           Context context)

create

@POST
 @Path(value="/v{apiVersion}/categories/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
Category create(@PathParam(value="apiVersion")
                                                                                                                                           String apiVersion,
                                                                                                                                           Category category)

update

@POST
 @Path(value="/v{apiVersion}/categories/{id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
Category update(@PathParam(value="apiVersion")
                                                                                                                                               String apiVersion,
                                                                                                                                               @PathParam(value="id")
                                                                                                                                               int categoryId,
                                                                                                                                               Category category)

delete

@DELETE
 @Path(value="/v{apiVersion}/categories/{id}")
Category delete(@PathParam(value="apiVersion")
                                                                       String apiVersion,
                                                                       @PathParam(value="id")
                                                                       int categoryId,
                                                                       @QueryParam(value="force")
                                                                       boolean force)