Retrieve a List or Inbox

To retrieve links to a section's lists and/or inboxes, first retrieve the section as described in Retrieve a Section, and then follow one of these link types:

http://www.vizrt.com/types/relation/lists for a list feed, for example:

<link rel="http://www.vizrt.com/types/relation/lists" 
      href="http://host-ip-address/webservice/escenic/section/22/lists" 
      type="application/atom+xml"/>

http://www.vizrt.com/types/relation/inboxes for an inbox feed, for example:

<link rel="http://www.vizrt.com/types/relation/inboxes" 
      href="http://host-ip-address/webservice/escenic/section/22/inboxes" 
      type="application/atom+xml"/>

To retrieve a list feed using the first of the above links, for example, you would submit the following request:

curl -u user:password -X GET http://host-ip-address/webservice/escenic/section/22/lists

This will return an Atom feed containing entries for all the section's lists that looks something like this:

<feed xmlns="http://www.w3.org/2005/Atom">
  <author>
    <name>Escenic Content Engine</name>
  </author>
  <id>http://host-ip-address/webservice/escenic/section/22/lists</id>
  <link href="http://host-ip-address/webservice/escenic/section/22/lists"
        rel="self" type="application/atom+xml" />
  <updated>2015-05-04T13:23:49.958Z</updated>
  <entry>
    <id>http://host-ip-address/webservice/content/com.escenic.list/423</id>
    <title type="text">Editor's Choice</title>
    <link href="http://host-ip-address/webservice/escenic/list-pool/423"
          rel="http://www.vizrt.com/types/relation/list-pool"
          type="application/atom+xml" />
    <link href="http://host-ip-address/webservice/escenic/changelog/list/423"
          rel="http://www.vizrt.com/types/relation/changelog"
          type="application/atom+xml" />
    <link href="http://host-ip-address/webservice/content/com.escenic.list/423"
          rel="edit-media" title="Editor's Choice"
          type="application/vnd.escenic.content+xml; type=com.escenic.list" />
    <link href="http://upload.wikimedia.org/wikipedia/commons/6/64/Cebus_albifrons_edit.jpg"
          rel="monkey" title="Mr. Monkey" type="image/jpeg" />
  </entry>
  <entry>
    ...
  </entry>
  ...
</feed>

Following the section's http://www.vizrt.com/types/relation/inboxes link produces a very similar feed, containing entries for all the section's inboxes.

To retrieve a specific list, follow the appropriate entry's http://www.vizrt.com/types/relation/list-pool link. To retrieve the "Editor's Choice" list shown above, for example, you would submit the following request:

curl -u user:password -X GET http://host-ip-address/webservice/escenic/list-pool/423

This will return a list pool Atom feed, containing entries for all the items in the selected list:

<feed xmlns="http://www.w3.org/2005/Atom">
  <author>
    <name>Escenic Content Engine</name>
  </author>
  <id>http://host-ip-address/webservice/escenic/list-pool/423</id>
  <link rel="self" 
        href="http://host-ip-address/webservice/escenic/list-pool/423" 
        type="application/atom+xml"/>
  <updated>2015-04-22T12:52:11.311Z</updated>
  <link 
    rel="http://www.vizrt.com/types/relation/changelog" 
    href="http://host-ip-address/webservice/escenic/changelog/list/423" 
    type="application/atom+xml"/>
  <entry>
    <id>http://host-ip-address/webservice/escenic/list-pool/handle/583347</id>
    <title type="text">(type=1 ,id=204697 ,pubId=-1)</title>
    <link
      rel="edit"
      href="http://host-ip-address/webservice/escenic/list-pool/handle/583347"
      type="application/atom+xml"/>
    <link
      rel="self"
      href="http://host-ip-address/webservice/escenic/list-pool/handle/583347"
      type="application/atom+xml"/>
    <link
      rel="about"
      href="http://host-ip-address/webservice/escenic/content/204697"
      type="application/atom+xml"/>
    <content type="application/vnd.vizrt.payload+xml">
      <vdf:payload 
        xmlns:vdf="http://www.vizrt.com/types"
        model="http://host-ip-address/webservice/escenic/publication/dev.nightly/model/com.escenic.poolentry">
      <vdf:field name="com.escenic.priority">
        <vdf:value>-1</vdf:value>
      </vdf:field>
      <vdf:field name="com.escenic.pinned">
        <vdf:value>false</vdf:value>
      </vdf:field>
    </vdf:payload>
    </content>
  </entry>
  <entry>
    ...
  </entry>
  ...
</feed>

Each entry in the feed references a list pool handle, which you can retrieve by following the entry's self or edit link. For example:

curl -u user:password -X GET http://host-ip-address/webservice/escenic/list-pool/handle/583347

This returns a single Atom entry containing the handle for one list item:

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>http://host-ip-address/webservice/escenic/list-pool/handle/583347</id>
  <title type="text">(type=1 ,id=204697 ,pubId=-1)</title>
  <link 
    rel="edit"
    href="http://host-ip-address/webservice/escenic/list-pool/handle/583347"
    type="application/atom+xml"/>
  <link 
    rel="self"
    href="http://host-ip-address/webservice/escenic/list-pool/handle/583347"
    type="application/atom+xml"/>
  <link 
    rel="about"
    href="http://host-ip-address/webservice/escenic/content/204697"
    type="application/atom+xml"/>
  <content type="application/vnd.vizrt.payload+xml">
    <vdf:payload 
      xmlns:vdf="http://www.vizrt.com/types"
      model="http://host-ip-address/webservice/escenic/publication/dev.nightly/model/com.escenic.poolentry">
      <vdf:field name="com.escenic.priority">
        <vdf:value>-1</vdf:value>
      </vdf:field>
      <vdf:field name="com.escenic.pinned">
        <vdf:value>false</vdf:value>
      </vdf:field>
    </vdf:payload>
  </content>
  <link 
    rel="collection"
    href="http://host-ip-address/webservice/escenic/list-pool/423"
    type="text/uri-list"/>
</entry>

From such a handle entry you can retrieve the content item the handle represents by following the about link, or return to the parent list/inbox by following the collection link.

The process of retrieving in-boxes and in-box entries is exactly the same as retrieving lists and list entries. Both structures are represented in the web service by list pool Atom feeds and handle entries.

The payload of a handle Atom entry always contains two fields, com.escenic.priority (default value -1) and com.escenic.pinned (default value false). These fields are present in both list and in-box entry handles, but they are only actually used in lists, for pinning items to specific positions (see Using A List Editor for a description of this functionality in Content Studio). An item is pinned to a specific position in a list by setting com.escenic.priority to the required position and setting com.escenic.pinned to true.