org.zanata.rest.service

Interface AccountResource

All Known Subinterfaces:

IAccountResource

public interface AccountResource

username: User name that identifies an account

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get() Retrieves a user account.
javax.ws.rs.core.Response	put(Account account) Creates or updates a user account.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

get

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

Retrieves a user account.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing information for the user account.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

put

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

Creates or updates a user account. If an account with the given user name already exists, said account will be overwritten with the provided data. Otherwise, a new account will be created.

Parameters:

account - The account information to create/update.

Returns:

The following response status codes will be returned from this operation:
OK(200) - If an existing account was modified.
CREATED(201) - If a new account was created.
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.