...
The user feed represents each user that is visible to the currently logged in user. For all non-administrator users, this feed will always show one user: the current user; for the administrator users it will show all the users in frevvo allowing them to manage user settings.
Getting the UserFeed
In order to get a list of all visible users, send the following request to the frevvo Server:
...
| Note |
|---|
Note that since the current logged in user is johndoe the feed contains only his entry. If the currenty logged in user was the administrator then a full list of all users would be returned by the server. Also note that for this release user feeds are read-only, and so new users cannot be created using the Data API. |
Getting a UserEntry
It is also possible to directly get a specific User entry as long as you know the id for that user. In order to do that send the following request to the server:
...
Since at this point User entries are also read-only for this release, they can only be used to traverse to related feeds such as the users application and theme feeds (see the two link elements with a rel attribute with value apps and themes, respectively, in the entry above)=====
Inserting a new UserEntry
...
Inserting (creating) new users using the Data API is not supported at this time.=====
Updating a UserEntry
...
Updating the user profile using the Data API is not supported at this point.=====
Deleting a UserEntry
...
Deleting a user using the Data API is not supported at this point.====
ThemeFeed
...
The theme feed lists all themes visible to the currently logged-in user. This includes enabled themes that were uploaded by the current user and all enabled themes that are global, i.e. owned by the admin user.=====
Getting the ThemeFeed
...
In order to get a list of all themes, send the following request to the frevvo server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/themes |
</pre>The server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
<feed xmlns="http://www.w3.org/2005/Atom" xml:base="http://localhost:8080"> |
...
<title>Themes</title> |
...
<updated>2010-04-28T18:01:00.838-04:00</updated> |
...
<link rel="self" type="application/atom+xml" href="/frevvo/web/tn/d/api/themes"/> |
...
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_Q6pJIagiEdyrUJr3HP_61Q!admin</id> |
...
<title type="text">Clear</title> |
...
<updated>2010-04-28T18:01:00.838-04:00</updated> |
...
<link type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<link rel="self" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<fd:owner id="admin"/> |
...
</entry> |
...
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_w218Ecm4EdyRdaUav2cgrg!admin</id> |
...
<title type="text">Professional Blue</title> |
...
<updated>2010-04-28T18:01:00.838-04:00</updated> |
...
<link type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<link rel="self" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<fd:owner id="admin"/> |
...
</entry> |
...
</feed> |
...
The returned feed above shows two theme entries named '''Clear''' and '''Blue Professional''' that Clear and Blue Professional that happen to be the two global themes provided by default by the frevvo installation.=====
Getting a ThemeEntry
...
It is also possible to directly get a specific Theme entry as long as you know the theme id. In order to do that send the following request to the server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/theme/{id} |
</pre>And the server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_w218Ecm4EdyRdaUav2cgrg!admin</id> |
...
<title type="text">Professional Blue</title> |
...
<updated>2010-04-28T18:01:00.838-04:00</updated> |
...
<link type="application/atom |
...
+xml" href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<link rel="self" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> |
...
<fd:owner id="admin"/> |
...
</entry> |
...
| Note |
|---|
Note that for this release it is not possible to download the theme using the Data API: support for that will be added in a subsequent release. |
...
Inserting a new ThemeEntry
...
Inserting a new theme using the Data API is not supported at this point.===== Updating a ThemeEntry =====
Updating a ThemeEntry
Updating a theme is not supported at this point.=====
Deleting a ThemeEntry
...
Deleting a theme can be done by sending an HTTP DELETE request to the theme entry url.<pre>
| Code Block |
|---|
DELETE /frevvo/web/tn/{tenantId}/api/theme/{id} |
...
And the server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
<entry xmlns="http://www.w3.org/2005/Atom" |
...
xmlns:fd="http://schemas.frevvo.com/fdata/2008" |
...
xml:base="http://localhost:8080"> |
...
<id>_Q6pJIagiEdyrUJr3HP_61Q!admin</id> |
...
<title type="text">Clear</title> |
...
<updated>2010-04-28T18:02:16.364-04:00</updated> |
...
<link type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<link rel="self" type="application/atom |
...
+xml" href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/tn/d/api/theme/_Q6pJIagiEdyrUJr3HP_61Q!admin"/> |
...
<fd:owner id="admin"/> |
...
</entry> |
</pre>
...
ApplicationFeed
...
The application feed lists all applications owned by the currently logged-in user.=====
Getting the ApplicationFeed
...
In order to get a list of all applications, send the following request to the frevvo server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/apps |
</pre>The server will respond with:<pre>
| Code Block |
|---|
200 OK |
...
<feed xmlns="http://www.w3.org/2005/Atom" xml:base="http://localhost:8082"> |
...
<title>Applications</title> |
...
<updated>2009-05-12T11:55:56.984-04:00</updated> |
...
<link rel="self" type="application/atom+xml" href="/frevvo/web/api/apps"/> |
...
<link rel="post" type="application/atom+xml" href="/frevvo/web/api/apps?ownerId=johndoe"/> |
...
<link rel="post-media" type="application/zip" href="/frevvo/web/api/apps?ownerId=johndoe"/> |
...
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_nv8uAT8KEd6yc_ZDP21S1Q!johndoe</id> |
...
<title type="text">Expense Reports</title> |
...
<summary type="text"/> |
...
<updated>2009-05-12T11:55:56.984-04:00</updated> |
...
<link type="application/atom+xml" href="/frevvo/web/api/app/_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> |
...
<link rel="self" type="application/atom+xml" href="/frevvo/web/api/app/_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> |
...
<link rel="edit" type="application/atom+xml" href="/frevvo/web/api/app/_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> |
...
<link rel="formtypes" type="application/atom+xml" href="/frevvo/web/api/formtypes?ownerId=_nv8uAT8KEd6yc_ZDP21S1Q!johndoe" title="Expense Reports's Form Types"/> |
...
<link rel="schemas" type="application/atom+xml"href="/frevvo/web/api/schemas?ownerId=_nv8uAT8KEd6yc_ZDP21S1Q!johndoe" title="Expense Reports's Schemas"/> |
...
<link rel="forms" type="application/atom+xml" href="/frevvo/web/api/forms?ownerId=_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> |
...
<fd:owner id="johndoe"/> |
...
<content type="application/zip" src="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/file/content.zip"/> |
...
</entry> |
...
</feed> |
</pre>The returned feed above shows one application entry named "Expense Reports" owned by the current user 'johndoe'.=====
Getting an ApplicationEntry
...
It is also possible to directly get a specific application entry as long as you know the application id. In order to do that send the following request to the server:<pre>
| Code Block |
|---|
GET /frevvo/web/tn/{tenantId}/api/app/{id} |
...
And the server will respond with:
...