30.03.2014 Views

Database.com Chatter REST API Developer's Guide - Salesforce.com

Database.com Chatter REST API Developer's Guide - Salesforce.com

Database.com Chatter REST API Developer's Guide - Salesforce.com

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Introducing <strong>Chatter</strong> <strong>REST</strong> <strong>API</strong><br />

Understanding <strong>Chatter</strong> <strong>API</strong> Resources<br />

2. The system authenticates the user and client app.<br />

3. Request <strong>Chatter</strong> <strong>API</strong> resources using an HTTP request.<br />

4. The system returns an HTTP return code. Additional information (such as a <strong>Chatter</strong> <strong>API</strong> response body) is optionally<br />

included in the response.<br />

Each resource in <strong>Chatter</strong> <strong>API</strong> is a URI used with an HTTP method (such as GET, POST, DELETE, or HEAD). Each<br />

resource represents something in <strong>Chatter</strong>, such as a user's news feed, or the <strong>com</strong>ments on a post.<br />

Many of the resources use either a specified userId or the keyword me to indicate the current, logged-in user. For example, to<br />

return the user-profile information for the current, logged-in user, use the following resource:<br />

/chatter/users/me<br />

You could also specify a particular user by user Id:<br />

/chatter/users/005D0000001GLoh<br />

When you successfully access a resource, a response body is returned in JSON or XML. By default, JSON is returned. Each<br />

response body may contain one or more response bodies. For example, the following is the response body of the above resource<br />

(users). Note that it includes other response bodies as well, such as address, current status, and phone numbers:<br />

Property<br />

Type<br />

Description<br />

Since Version<br />

aboutMe<br />

String<br />

Text from user's profile<br />

23.0<br />

address<br />

Address<br />

Address<br />

23.0<br />

chatterActivity<br />

<strong>Chatter</strong> Activity<br />

<strong>Chatter</strong> activity statistics<br />

23.0<br />

chatterInfluence<br />

<strong>Chatter</strong> Influence<br />

User’s influence rank<br />

23.0<br />

<strong>com</strong>panyName<br />

String<br />

Company name<br />

23.0<br />

currentStatus<br />

User Status<br />

Note: This property is no longer available<br />

as of version 25.0.<br />

23.0–25.0<br />

User's current status<br />

email<br />

String<br />

User's email address<br />

23.0<br />

firstName<br />

String<br />

User's first name<br />

23.0<br />

followersCount<br />

Integer<br />

Number of users following this user<br />

23.0<br />

followingCounts<br />

Following Counts<br />

Information about items the user is following<br />

23.0<br />

groupCount<br />

Integer<br />

Number of groups user is following<br />

23.0<br />

id<br />

String<br />

18-character Id of the user<br />

23.0<br />

isActive<br />

Boolean<br />

true if user is active, false otherwise<br />

23.0<br />

is<strong>Chatter</strong>Guest<br />

Boolean<br />

Note: This property is no longer available<br />

as of version 26.0. Use the userType<br />

property instead.<br />

23.0–25.0<br />

3

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!