FeedApiService
Namespace http://api.hi5.com/feed (wsdl):
This module implements a wide variety of Atom/JSON feeds.
The following methods are available on this endpoint:
addAlbumPhotos
In order to upload photos one must post to this endpoint with multi-part attachment containing photo files. This endpoint will upload photos into specified album for a particular user. Here is an example of how a photo can be uploaded with curl command.
curl -F upload=@filename "api.hi5.com/rest/feed/photos/user/userId/albumid/albumid?Hi5AuthToken=token"
If @mobile is specified as album id, photos will go to a designated album for photos uploaded from mobile devices.
Authorization token is required. It can be obtained using the following endpoint auth/plain
Input Parameters
| name | description |
|---|---|
| photos | list of photos as a multi-part post |
| userId | user who is uploading photos |
| albumId | target album |
Return Value
The updated atom feed of photos after the upload
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |
addPhotos
Add photos to the default album. Like feed/photos/user/userId/.../albumid/... only no albumid required.
Input Parameters
| name | description |
|---|---|
| photos | (no documentation provided) |
| userId | (no documentation provided) |
Return Value
(no documentation provided)
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |
createNewAlbum
Endpoint to create an album. Provide album name with a "name" parameter in the request.
For example: api.hi5.com/rest/feed/albumlist/userId?name=newalbum1&Hi5AuthToken=.....
Input Parameters
| name | description |
|---|---|
| userId | (no documentation provided) |
| lang | (no documentation provided) |
Return Value
(no documentation provided)
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |
readAlbumFeed
Public Albums Feed.
Returns an Atom feed of Albums for a specific user.
Examples:
http://api.hi5.com/rest/feed/album?userId=1000&albumId=XXXXX (Atom XML)
http://api.hi5.com/json/feed/album?userId=1000&albumId=XXXXX (Atom as JSON)
Input Parameters
| name | description |
|---|---|
| albumIdStr | (no documentation provided) |
| userId | A Hi5 User ID value |
| updatedSince | Filters out all photos before provided date. The format is yyyy-MM-dd-HH:mm. |
| lang | The language for the feed, default is the specified users language. |
Return Value
An Atom 1.0 Feed
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | - When the userId does not exist. |
| PermissionDeniedException | - When privacy settings do not allow access. |
readAlbumListFeed
Public List of Albums Feed.
Returns an Atom feed of Albums for a specific user.
Examples:
http://api.hi5.com/rest/feed/albumlist/1000 (Atom XML)
http://api.hi5.com/json/feed/albumlist/1000 (Atom as JSON)
TODO - add Livejournal authentication compatibility (auth tag for digest)
Input Parameters
| name | description |
|---|---|
| userId | A Hi5 User ID value |
| lang | The language for the feed, default is the specified users language. |
Return Value
An Atom 1.0 Feed
Faults
| name | description |
|---|---|
| NotFoundException | - When the userId does not exist. |
| PermissionDeniedException | - When privacy settings do not allow access. |
readAlbums
Retrieve albums of the given user. If the photos are set to private you must provide an authorization token and be either the target user or the friend of the target user.
Input Parameters
| name | description |
|---|---|
| userId | (no documentation provided) |
| lang | (no documentation provided) |
Return Value
atom feed of albums
Faults
| name | description |
|---|---|
| NotFoundException | userid was invalid |
| PermissionDeniedException | authentication failed |
readGroupDiscussions
Recent Discussions/Topics/Replies Feed.
Returns a feed of group topics and replies from the given group.
Examples:
http://api.hi5.com/rest/feed/group/topics/1000 - Atom FeedFlickr Compatibility
http://api.hi5.com/json/feed/group/topics/1000 - JSON
Use a URL conforming to the flickr groups_discuss feed as follows:
http://api.hi5.com/services/feeds/groups_discuss.gne
Supported Parameters: id, lang, format
Input Parameters
| name | description |
|---|---|
| id | The id of the group (Required) |
| lang | web browser or ISO language (Language of specified group id is the default) |
Return Value
Atom 1.0 Feed
Faults
| name | description |
|---|---|
| NotFoundException | - If id does not correspond to a valid group |
readGroupFeed
Returns an Atom feed of groups that specific user has signed up for.
Examples:
http://api.hi5.com/rest/feed/groups/1000 (Atom XML)
http://api.hi5.com/json/feed/groups/1000 (Atom as JSON)
Input Parameters
| name | description |
|---|---|
| userId | Hi5 user id. |
| startIndex | Index to start reading roups from. Default is 0. |
| count | number of groups to return counting from startIndex. Default is 100. |
| lang | (no documentation provided) |
Return Value
(no documentation provided)
Faults
| name | description |
|---|---|
| NotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |
readGroupTopicReplies
Retrieve a list of followup comments for a specific topic. See http://www.ietf.org/rfc/rfc4685.txt for more.
Input Parameters
| name | description |
|---|---|
| groupId | The value of the group containing these comments |
| topicId | The topicId |
| lang | Optional language for formatting content text. |
Return Value
A Feed of comments
Faults
| name | description |
|---|---|
| NotFoundException | (no documentation provided) |
readJournalFeed
Public Journal Entries Feed.
Returns an Atom feed of recent journal entries for a specific userId.
Examples:
http://api.hi5.com/rest/feed/journal/1000 (Atom XML)
http://api.hi5.com/json/feed/journal/1000 (Atom as JSON)
Input Parameters
| name | description |
|---|---|
| userId | A Hi5 User ID value |
| lang | The language for the feed, default is the specified users language. |
Return Value
An Atom 1.0 Feed
Faults
| name | description |
|---|---|
| NotFoundException | - When the userId does not exist. |
| PermissionDeniedException | - When privacy settings do not allow access. |
readPhotos
Retrieve photos of a given user from a given album. If the photos are set to private you must provide an authorization token and be either the target user or the friend of the target user.
Input Parameters
| name | description |
|---|---|
| userId | (no documentation provided) |
| albumId | Either album id, "@all" to retrieve photos from all albums, or "@mobile" to get photos from mobile album |
| updatedSince | Filters out all photos before provided date. The format is yyyy-MM-dd-HH:mm. |
| lang | (no documentation provided) |
Return Value
atom feed of photos from the specified album
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | user id or album id was invalid |
| PermissionDeniedException | Authentication failed |
updatePhotoDescription
Set or update description of a photo. The description text must not be longer than 200 characters.
Input Parameters
| name | description |
|---|---|
| userId | (no documentation provided) |
| albumId | (no documentation provided) |
| photoId | (no documentation provided) |
| description | (no documentation provided) |
Return Value
(no documentation provided)
Faults
| name | description |
|---|---|
| Hi5ApiGeneralException | (no documentation provided) |
| NotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |