Search for Persons

The web service's "start" feed resource (http://host-ip-address/webservice/escenic/section/ROOT/subsections, see Get Started) contains a link of type http://www.vizrt.com/types/relation/person. This is the only start-point for person lookup. If the client application follow this link:

curl -u user:password http://host-ip-address/webservice/escenic/person

then an empty Atom feed (that is, a feed containing no entries) is returned. This empty feed, however, does contain a link of type http://www.vizrt.com/types/relation/person-lookup:

<feed xmlns="http://www.w3.org/2005/Atom">
  ...
  <link rel="http://www.vizrt.com/types/relation/person-lookup" 
        href="http://host-ip-address/webservice/open-search/person-lookup-description.xml" 
        type="application/opensearchdescription+xml"/>
  ...
</feed>

Following this link in turn:

curl -u user:password http://host-ip-address/webservice/open-search/person-lookup-description.xml

returns an OpenSearch document describing the describing the URL format required to search for persons:

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>Person Lookup</ShortName>
  <Description>Lookup for persons</Description>
  <Url type="application/atom+xml" template="http://host-ip-address/webservice/escenic/person/lookup?email={emailAddress}"/>
  <LongName/>
  <Developer/>
  <Attribution/>
  <SyndicationRight/>
  <AdultContent>false</AdultContent>
  <OutputEncoding>UTF-8</OutputEncoding>
  <InputEncoding>UTF-8</InputEncoding>
</OpenSearchDescription>

From this information the client can construct a URL that submits a person look-up request. Note that:

• Unlike content search, only one URL template is provided here, and it returns results in the form of an Atom feed.

• The only search criterion that can be used for person look-up is email address.

For example:

curl -u user:password http://host-ip-address/webservice/escenic/person/lookup?email=mail@example.com

This returns an Atom feed containing entries for all persons with the email address mail@example.com.