Get Started

No matter what your client program's purpose, the first thing it must always do is send an HTTP GET request to the web service's "start" URL. For most purposes this is:

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

(However, if your client program needs to access your tag hierarchy, then a different start URL must be used, see Navigate The Tag Hierarchy.)

The client program must then parse the Atom feed returned by the web service and extract the URLs it needs:

<feed xmlns="http://www.w3.org/2005/Atom">
  <author>
    <name>Escenic Content Engine</name>
  </author>   
  <category term="1234" scheme="http://myTaggingBackend/myTagStructure/" label="MyTag"/>
  <id>http://host-ip-address/webservice/escenic/section/ROOT/subsections</id>   
  <link rel="self" 
        href="http://host-ip-address/webservice/escenic/section/ROOT/subsections" 
        type="application/atom+xml"/>  
  <updated>2010-06-23T16:51:06.721Z</updated> 
  <title type="text">Publication root sections you are authorized to.</title> 
  <link rel="changelog" 
        href="http://host-ip-address/webservice/escenic/changelog" 
        type="application/atom+xml"/>
  <entry> 
    <id>http://host-ip-address/webservice/escenic/section/1</id>
    <title type="text">frontpage</title>  
    <updated>2010-06-22T10:16:46.309Z</updated>   
    <category term="directory" scheme="http://www.escenic.com/types"/>  
    <link rel="edit-media"
          type="application/vnd.escenic.content+xml;type=com.escenic.section" 
          href="http://host-ip-address/webservice/escenic/section/1"/> 
    <link rel="down" 
          href="http://host-ip-address/webservice/escenic/section/1/subsections" 
          type="application/atom+xml"/>   
    <link rel="http://www.escenic.com/types/relation/inboxes" 
          href="http://host-ip-address/webservice/escenic/section/1/inboxes" 
          type="application/atom+xml"/>   
    <link rel="http://www.escenic.com/types/relation/lists" 
          href="http://host-ip-address/webservice/escenic/section/1/lists" 
          type="application/atom+xml"/>   
    <link rel="http://www.escenic.com/types/relation/pages" 
          href="http://host-ip-address/webservice/escenic/section/1/pages" 
          type="application/atom+xml"/>   
    <link rel="http://www.escenic.com/types/relation/content-items" 
          href="http://host-ip-address/webservice/escenic/section/1/content-items" 
          type="application/atom+xml"/> 
    <link rel="http://www.escenic.com/types/relation/changelog" 
          href="http://host-ip-address/webservice/escenic/changelog/section/1" 
          type="application/atom+xml"/>
  </entry>
</feed>

Each entry represents the root section of a publication, and the links in each entry represent the operations available for that publication. (There is only one entry in the example feed above: this means that the user submitting the request only has access to one publication at this installation.)