org.zanata.rest.service

Interface ProjectResource

All Known Subinterfaces:

IProjectResource

@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
public interface ProjectResource

projectSlug: Project Identifier.

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROJECT_SLUG_TEMPLATE
static String	SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get() Returns data for a single Project.
javax.ws.rs.core.Response	head() Returns header information for a project.
javax.ws.rs.core.Response	put(Project project) Creates or modifies a Project.

Field Detail

PROJECT_SLUG_TEMPLATE

static final String PROJECT_SLUG_TEMPLATE

See Also:

Constant Field Values

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

head

@HEAD
@Produces(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
javax.ws.rs.core.Response head()

Returns header information for a project.

Returns:

The following response status codes will be returned from this operation:
OK(200) - An "Etag" header for the requested project.
NOT FOUND(404) - If a project could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

get

@GET
@Produces(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
javax.ws.rs.core.Response get()

Returns data for a single Project.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Containing the Project data.
NOT FOUND(404) - If a Project could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

put

@PUT
@Consumes(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
javax.ws.rs.core.Response put(Project project)

Creates or modifies a Project.

Parameters:

project - The project's information.

Returns:

The following response status codes will be returned from this method:
OK(200) - If an already existing project was updated as a result of this operation.
CREATED(201) - If a new project was added.
FORBIDDEN(403) - If the user was not allowed to create/modify the project. In this case an error message is contained in the response.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.