com.leonarduk.clearcheckbook.calls

Class UserCall

java.lang.Object

com.leonarduk.clearcheckbook.calls.AbstractCall<UserDataType>

com.leonarduk.clearcheckbook.calls.UserCall

public class UserCall
extends AbstractCall<UserDataType>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
UserCall(ClearCheckBookConnection connection)

Method Summary

Methods

Modifier and Type	Method and Description
UserDataType	get() Gets the details for the current user.
protected String	getUrlSuffix()
String	insert(UserDataType dataType) Creates a new ClearCheckbook.com user account Method: post Call: user

Methods inherited from class com.leonarduk.clearcheckbook.calls.AbstractCall

bulkProcess, delete, edit, get, getAll, getAll, getConnection, getPluralUrl, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

UserCall

public UserCall(ClearCheckBookConnection connection)

Method Detail

getUrlSuffix

protected String getUrlSuffix()

Specified by:

getUrlSuffix in class AbstractCall<UserDataType>

get

public UserDataType get()
                 throws ClearcheckbookException

Gets the details for the current user.
Method: get
Call: user

Example: https://username:password@www.clearcheckbook.com/api/user/

Parameters:
Parameter Required Description
None

Returned Values:
Value Description
id The current users id in the ClearCheckbook system
username The current users username
password MD5 hash of current users password
email Email address of current user

Overrides:

get in class AbstractCall<UserDataType>

Returns:

extends AbstractDataType

Throws:

ClearcheckbookException

insert

public String insert(UserDataType dataType)
              throws ClearcheckbookException

Creates a new ClearCheckbook.com user account
Method: post
Call: user

Example:
https://www.clearcheckbook.com/api/user/

Notes:
You do not pass any authentication information when creating a user. This is the only function that behaves this way. If the username or email address exists in the system, this function returns false.
Parameters:
Parameter Required Description
username Required The desired username for the new user
xpassword Required an unencoded password for the new user
email Required an email address for the new user
app Optional A name for your app (eg: "iPhone App" for an iPhone app). Lets us know where users are coming from.

Returned Values:
Value Description
Multiple Responses* The new users id in the ClearCheckbook system on successfull insert or false if the username or email already exists in system.

Overrides:

insert in class AbstractCall<UserDataType>

Parameters:

-

Returns:

Throws:

ClearcheckbookException