| 
  • If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Stop wasting time looking for files and revisions! Dokkio, a new product from the PBworks team, integrates and organizes your Drive, Dropbox, Box, Slack and Gmail files. Sign up for free.

View
 

Partigi API Documentation

Page history last edited by Fernando Blat 9 years, 9 months ago

Go back to the main page

 

Overview

 

This is an Atom based API, that offers almost all the functionality and data from the web version. All the requests have to be done using the appropriate HTTP methods, and they respond with the appropriate HTTP response codes.

 

OAuth is the authentication method implemented in Partigi. OAuth is required in all API requests but in two different modes: the common OAuth specification for read-write access and OAuth with a slightly modification for read-only access, which just consists of skiping the oauth_token when signing the requests.

 

The API is versionated, as can be seen in the base URI: http://partigi.com/api/v1/.

 

Element overview

 

The main information element in Partigi is the Item. There are different types of items: film, serie, videogame... (Partigi API - Item Types). Every item is related with many people (the cast members, directors, writers, and so on). Every time that an User rates an Item, a Review is created. A review contains a numerical rating (between 0 to 5), a text, and a status. Also, users are related with other users through relationships. Finally, we have the lists. A list is composed by list from users. Every list of a user is a version of the main list.

 

Navigating through collections

 

When you get as a result of a method invocation a collection of elements (such a collection of films, users, etc), the API offers you the value of the next and the previous page of the collection in both elements next_page and previous_page. This will make you easier to iterate over all pages of results.

 

For example, in a response in Atom format, the elements look like:

 
<partigi:previous_page>1</partigi:previous_page> 
<partigi:next_page>3</partigi:next_page>
 

 

If the value of the element is empty, there will be no more pages available.

 

Partigi Atom Reference

 

Elements

 

Item

ItemType

Genre

Person

Review

User

List

ListUser

Relationship

Edition

 

 

Methods

 

Items methods

 

items/show

items/index

 

ItemTypes methods

 

item_types/index

 

Genres methods

 

genres/index

 

Releases methods

 

releases/index

 

 

Recommendations methods

 

recommendations/index

 

Reviews methods

 

reviews/index

reviews/show

reviews/create

reviews/update

reviews/friends

 

People methods

 

people/show

 

Users methods

 

users/show

 

Friendships methods

 

friendships/index

friendships/create

friendships/destroy

friendships/show

 

Lists Methods

 

lists/index

lists/show

lists/create

 

ListUsers Methods

 

list_users/index

list_users/show

list_users/create

list_users/update

list_users/destroy

 

Account Methods

 

account/verify_credentials

 

General reference

 

API Authentication

HTTP Response Codes and Errors

Available locales

Available status values

Item types

 

 

 

 

Go back to the main page

Comments (0)

You don't have permission to comment on this page.