org.zanata.rest.client

Interface IAccountResource

All Superinterfaces:

AccountResource

public interface IAccountResource
extends AccountResource

Field Summary

Fields inherited from interface org.zanata.rest.service.AccountResource

SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<Account>	get() Retrieves a user account.
org.jboss.resteasy.client.ClientResponse	put(Account account) Creates or updates a user account.

Method Detail

get

@GET
 @Produces(value={"application/vnd.zanata.account+xml","application/vnd.zanata.account+json"})
org.jboss.resteasy.client.ClientResponse<Account> get()

Description copied from interface: AccountResource

Retrieves a user account.

Specified by:

get in interface AccountResource

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"})
org.jboss.resteasy.client.ClientResponse put(Account account)

Description copied from interface: AccountResource

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.

Specified by:

put in interface AccountResource

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.