API documentation

Message methods

Public

Returns 20 latest public messages written by any user in the desired format

URL:

http://christianchirp.com/api/messages/public.[format].[api_key]

Formats: xml, json, rss

Friends

Returns specified user's friends' messages in the desired format.

URL:

http://christianchirp.com/api/messages/friends/[user].[format].[api_key]

Formats: xml, json, rss

User

Returns all public messages of the specified user in the desired format.

URL:

http://christianchirp.com/api/messages/user/[user].[format].[api_key]

Formats: xml, json, rss

Latest

Returns specified user's latest public message in the desired format.

URL:

http://christianchirp.com/api/messages/latest/[user].[format].[api_key]

Formats: xml, json, rss

Send

Posts a public message. Returns its details or an error message in the desired format.

URL:

http://christianchirp.com/api/messages/send.[format].[api_key]

Method:

POST

Required parameters:

• username

  (authenticating user's username or ID)

• password

  (authenticating user's password)

• message

  (message content)

Formats: xml, json

Delete

Removes authenticating user's message. Returns deleted message's details or an error message in the desired format.

URL:

http://christianchirp.com/api/messages/delete.[format].[api_key]

Method:

POST

Required parameters:

• username

  (authenticating user's username or ID)

• password

  (authenticating user's password)

• message_id

  (message ID)

Formats: xml, json

Direct message methods

Messages

Returns all direct messages that are in the authenticating user's inbox in the desired format.

URL:

http://christianchirp.com/api/direct_messages/messages.[format].[api_key]

Method:

POST

Required parameters:

• username

  (authenticating user's username)

• password

  (authenticating user's password)

Formats: xml, json, rss

Send

Posts a direct message to a user specified by their username or ID. Returns the sent message's details in the desired format or an error message in case of an error.

URL:

http://christianchirp.com/api/direct_messages/send.[format].[api_key]

Method:

POST

Required parameters:

• username

  (authenticating user's username)

• password

  (authenticating user's password)

• message

  (username or ID of the recipient of the direct message)

Optional parameters:

• reply

  (ID of a message, to which the current message is a reply)

• direct

  (recipient username or id)

Formats: xml, json

Delete

Removes a direct message from the authenticating user's inbox and returns removed message's details in the desired format or an error message in case of an error.

URL:

http://christianchirp.com/api/direct_messages/delete.[format].[api_key]

Method:

POST

Required parameters:

• username

  (authenticating user's username)

• password

  (authenticating user's password)

• message_id

  (ID of the message to be deleted)

Formats: xml, json

User methods

Friends

Returns specified user's friends in the desired format.

• URL:

  http://christianchirp.com/api/users/friends/[user].[format].[api_key]

• Formats: xml, json
• Usage example:

   http://christianchirp.com/api/users/friends/johnny.xml

  ou

  http://christianchirp.com/api/users/friends/12345.json

Followers

Returns specified user's followers in the desired format.

URL:

http://christianchirp.com/api/users/followers/[user].[format].[api_key]

Formats: xml, json
Usage example:

http://christianchirp.com/api/users/followers/diana.json

ou

http://christianchirp.com/api/users/followers/584.xml

User details

Returns user's details in the desired format.

URL:

http://christianchirp.com/api/users/details/[user].[format].[api_key]

Formats: xml, json
Usage example:

http://christianchirp.com/api/users/details/diana.json.f9cv8d97c90d8c6f2cab37bb6d1f1335

ou

http://christianchirp.com/api/users/details/584.xml.f9f16d97c90d8c6f23sb37bb6d1f1992

Friendship methods

Create

Adds a specified user to the authenticating user's friends. Returns the befriended user's details in the desired format or an error message in case of an error.

Method:

POST

Required parameters:

• username

  (authenticating user's username)

• password

  (authenticating user's password)

• friend

  (befriended user's username or ID)

URL:

http://christianchirp.com/api/friendships/create.[format].[api_key]

Formats: xml, json

Destroy

Removes a specified (leaves) user from the authenticating user's friend list. Returns the removed user's details in the desired format ro an error message in case of an error.

Method:

POST

Required parameters:

• username

  (authenticating user's username)

• password

  (authenticating user's password)

• friend

  (left user's username or ID)

URL:

http://christianchirp.com/api/friendships/destroy.[format].[api_key]

Formats: xml, json