Go back to Partigi API Documentation
List element are collections of items, grouped by a common name. It is very related with ListUser, which is a version of a list, by a user.
The idea es very simple: a user creates a list of items with a name, i.e. "My 10 favourite westerns". Then, another user copies that list and does his own version. Both lists are different ListUser instances, but with the same parent List.
Schema
ptList = element atom:entry {
atomCategory,
atomUpdated,
atomTitle,
ptList:id,
ptList:name,
ptList:nicename,
ptList:saved_count
}
The table below details list schema:
Element |
Property |
Description |
entry |
atom:category |
Scheme: http://schemas.partigi.com/v1.0#kind
Term: http://schemas.partigi.com/v1.0#list |
|
atom:updated |
The last modification time of the list. Notice that a list is updated when a ListUser related with it is created. |
|
atom:title |
The original name of the list |
|
ptList:id |
The identfier of the list in Partigi |
|
ptList:name |
The name of the list |
|
ptList:nicename |
The sanitized name of the list |
|
ptList:saved_count |
How many users has created a list from it |
An example
<entry xmlns:ptList="http://schemas.partigi.com/v1.0/ptList">
<category term="http://schemas.partigi.com/v1.0#list" scheme="http://schemas.partigi.com/v1.0#kind"/>
<id>http://www.partigi.com/api/v1/lists/show.atom?id=6</id>
<title>Best westerns ever</title>
<updated>2009-06-18T15:09:20Z</updated>
<published>2009-06-18T15:09:20Z</published>
<link type="text/html" rel="alternate" href="http://www.partigi.com/lists/6"/>
<link type="application/atom+xml" rel="self" href="http://www.partigi.com/api/v1/lists/show.atom?id=6"/>
<ptList:id>6</ptList:id>
<ptList:name>Best westerns ever</ptList:name>
<ptList:nicename>best-westerns-ever</ptList:nicename>
<ptList:saved_count>33</ptList:saved_count>
</entry>
Go back to Partigi API Documentation
Comments (0)
You don't have permission to comment on this page.