Partigi API - ListUser Atom Element

Page history last edited by Fernando Blat 15 years, 2 months ago

ListUser is a version of a List by a User. For more information visit the List Element page.

Schema

ptListUser = element atom:entry {
  atomCategory,
  atomUpdated,
  atomTitle,
  ptListUser:id,
  ptListUser:name,
  ptListUser:items_type,
  element ptList:id,
  element ptUser:id,
  ptListUser:items*
}

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
	`ptListUser:id`	The identfier of the list in Partigi
	`ptListUser:name`	The name of the list
	`ptListUser:nicename`	The sanitized name of the list
	`ptListUser:items_type`	The type of the items that contains the list. The available types are: `film`
	`ptUser:id`	The ID of the user that created the list
	`ptList:id`	The id of the list from which has been created
	`ptListUser:items`	A list of the items that contains the list, in `ptListUserItem` format
	`ptListUserItem:position`	The position in the list
	`ptListUserItem:item_id`	The ID of the item in Partigi
	`ptListUserItem:item_type`	The type of the item in Partigi

An example

  <entry xmlns:ptListUser="http://schemas.partigi.com/v1.0/ptListUser" xmlns:ptUser="http://schemas.partigi.com/v1.0/ptUser" xmlns:ptList="http://schemas.partigi.com/v1.0/ptList" xmlns:ptListUserItem="http://schemas.partigi.com/v1.0/ptListUserItem">
    <category term="http://schemas.partigi.com/v1.0#list_user" scheme="http://schemas.partigi.com/v1.0#kind"/>
    <id>http://www.partigi.com/api/v1/list_users/show.atom?id=2</id>
    <title>Best westerns ever</title>
    <updated>2009-06-19T11:25:18Z</updated>
    <published>2009-06-19T11:25:18Z</published>
    <link type="text/html" rel="alternate" href="http://www.partigi.com/list_users/2"/>
    <link type="application/atom+xml" rel="self" href="http://www.partigi.com/api/v1/list_users/show.atom?id=2"/>
    <ptListUser:id>2</ptListUser:id>
    <ptListUser:name>Best westerns ever</ptListUser:name>
    <ptListUser:nicename>best-westerns-ever</ptListUser:nicename>
    <ptListUser:items_type>Film</ptListUser:items_type>
    <ptUser:id>1</ptUser:id>
    <ptList:id>4</ptList:id>
    <ptListUser:items type="collection">
      <ptListUserItem:entry>
        <ptListUserItem:position>0</ptListUserItem:position>
        <ptListUserItem:item_type>Film</ptListUserItem:item_type>
        <ptListUserItem:item_id>4</ptListUserItem:item_id>
      </ptListUserItem:entry>
      <ptListUserItem:entry>
        <ptListUserItem:position>1</ptListUserItem:position>
        <ptListUserItem:item_type>Film</ptListUserItem:item_type>
        <ptListUserItem:item_id>5</ptListUserItem:item_id>
      </ptListUserItem:entry>
    </ptListUser:items>
  </entry>

Go back to Partigi API Documentation