Small World Labs

The Small World Labs API is a programming interface that exposes community data points to an application developer using web services.

The SWL API uses OAuth for authentication and a REST-like interface for the request and response mechanisms, though the response format can be changed at request time. Calls are made over the web using standard HTTP GET or POST requests. A wide variety of data points are accessible.

---

Using the API

• Authentication
• Making the request
• Global request parameters
• Handling the response
• Response formats
• API libraries

---

Single Sign On

• users.createUser - Creates a new user.
• users.login - Authenticates the user.
• users.logout - logs the user out.
• users.isLoggedIn - Returns whether the user is currently logged into the SWL system.

---

Authentication

• auth.getRequestToken - Get an OAuth Request Token
• auth.getUserAuthorization - Get OAuth Authorization
• auth.getAccessToken - Get an OAuth Access Token

---

API Methods

Audio

• audio.getList - Returns a list of audio gallery items

---

Blogs

• blogs.getList - Returns a list of blogs
• blogs.getPosts - Returns a list of posts within a specified blog
• blogs.getComments - Returns a list of blog comments from a specified blog, date or user
• blogs.editPost - Add or edit a post within a blog
• blogs.deletePost -Removes a specified post within a blog

---

Events

• events.addInvitees - Returns a list of invitees to a specified event
• events.removeInvitees - Removes invitees from a specified event
• events.deleteEvent - Removes a specified event
• events.editEvent - Create an event or modify a specified event's information
• events.getList - Returns a list of events

---

Files

• files.getList - Returns a list of files or a specific file
• files.getComments - Returns a list of file comments from a specified file, date or user
• files.editFile - Upload a file or modify a specified file's information

---

Forums

• forums.getList - Returns a list of forums
• forums.editForum - Create a forum or modify a specified forum's information
• forums.editPost - Create a forum post or modify a specified post's information
• forums.deletePost - Delete a specified forum post
• forums.getPosts - Returns posts within a forum

---

Groups

• groups.editGroup - Create a group or modify a specified group's information
• groups.getList - Returns a list of groups on the site
• groups.getMembers - Returns a list of members in a specified group
• groups.editPost - Create a group post or modify a specified post's information
• groups.deletePost - Delete a specified group post
• groups.getPosts - Returns posts within a group
• groups.editMembers - Add members to a group or edit the status of existing members
• groups.deleteMembers - Delete members from a group

---

Photos

• photos.editPhoto - Upload a photo or modify a specified photo's information
• photos.deletePhoto - Remove a specified photo
• photos.getList - Returns a list of photos in a site gallery or user's profile gallery
• photos.getComments - Returns a list of photo comments from a specified photo, date or user

---

Polls

• polls.getList - Retrieves a list the poll questions, including possible answers
• polls.saveAnswer - Saves an answer for the specified poll

---

Reviews

• reviews.getCategories - Returns a list of review categories
• reviews.getItems - Returns a list of review items for a specific category or returns a specific review item
• reviews.getReviews - Returns a list of reviews for a specific review item, review category, user, top reviewers or review
• reviews.editCategory - Edit a category or a categories fields
• reviews.Item - Edit a review item
• reviews.editReview - Edit a review

---

Tags

• tags.getList - Returns a list of tags for site content

---

Users

• users.editProfileBlock - Saves user responses for a specified profile block and field
• users.getProfileBlock - Returns a list of profile blocks and their fields, or if called appropriately, returns a user's responses for a given profile block
• users.editProfileComments - Edits or creates a profile comment for a user
• users.editUser - Edits the default information for a user
• users.getFiles - Returns a list of files in the given user's 'Files' module
• users.getList - Returns a list of users on the site
• users.getNetwork - Returns the specified user's network, or friends list
• users.getProfileComments - Returns a list of comments on a user's profile page

---

Videos

• videos.editVideo - Upload a video or modify a specified video's information
• videos.deleteVideo - Delete a specified video
• videos.getList - Returns a list of videos in the video gallery
• videos.getComments - Returns a list of video comments from a specified video, date or user