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

Interface UsersSPI

@Path("/wp")
public interface UsersSPI

Describes the Users Wordpress API

Since:

0.0.1

See Also:

Users API Reference

Method Summary

Modifier and Type	Method	Description
User	create(String apiVersion, User user)
DeletedModel<User>	delete(String apiVersion, Integer id, boolean force, Integer reassignId)
List<User>	list(String apiVersion, Context context, Integer page, Integer perPage, String search, List<Integer> exclude, List<Integer> include, List<Integer> offset, Order order, UserOrderBy orderBy, List<String> slug, List<String> roles)
User	retrieve(String apiVersion, Integer id, Context context)
User	update(String apiVersion, Integer id, User tag)

Method Detail

list

@GET
@Path("/v{apiVersion}/users")
@Produces("application/json")
List<User> list(@PathParam("apiVersion")
                String apiVersion,
                @QueryParam("context")
                Context context,
                @QueryParam("page")
                Integer page,
                @QueryParam("per_page")
                Integer perPage,
                @QueryParam("search")
                String search,
                @QueryParam("exclude")
                List<Integer> exclude,
                @QueryParam("include")
                List<Integer> include,
                @QueryParam("offset")
                List<Integer> offset,
                @QueryParam("order")
                Order order,
                @QueryParam("orderby")
                UserOrderBy orderBy,
                @QueryParam("slug")
                List<String> slug,
                @QueryParam("roles")
                List<String> roles)

retrieve

@GET
@Path("/v{apiVersion}/users/{id}")
@Produces("application/json")
User retrieve(@PathParam("apiVersion")
              String apiVersion,
              @PathParam("id")
              Integer id,
              @QueryParam("context")
              Context context)

create

@POST
@Path("/v{apiVersion}/users")
User create(@PathParam("apiVersion")
            String apiVersion,
            User user)

update

@POST
@Path("/v{apiVersion}/users/{id}")
User update(@PathParam("apiVersion")
            String apiVersion,
            @PathParam("id")
            Integer id,
            User tag)

delete

@DELETE
@Path("/v{apiVersion}/users/{id}")
DeletedModel<User> delete(@PathParam("apiVersion")
                          String apiVersion,
                          @PathParam("id")
                          Integer id,
                          @QueryParam("force")
                          boolean force,
                          @QueryParam("reassign")
                          Integer reassignId)

Parameters:

apiVersion -

id - Unique identifier for the user.

force - Required to be true, as users do not support trashing.

reassignId - Reassign the deleted user's posts and links to this user ID.