Developers API: Image Search Web Service

Developers API: Image Search - XML format

HTTP GET Request:

GET GetImages.asmx/SearchResults?Key=string&Keywords=string&PageNumber=string
&NumberPerPage=string&PagesAhead=string&Type=string

HTTP GET Request without API Key

GET GetImages.asmx/SearchResults1?Keywords=string

GET GetImages.asmx/SearchResults2?Keywords=string&NumberPerPage=string

GET GetImages.asmx/SearchResults3?Keywords=string&NumberPerPage=string&Type=string

Parameters:

Key - API Key.
Optional. Max 100 images will be returned if Empty.
FeaturePics issues you an API Key per your request. When you have one - you will be able to navigate through pages and use our e-Commerce API. You can use this Web service without the API Key. A maximum of 100 images will be returned per your Search request.
Keywords - HTML encoded search string.
Optional. Most recent images will be returned if Empty.
PageNumber - your navigation page number.
Optional. Default value=1 will be set if Empty.
NumberPerPage - number of images on your page.
Optional. Default value=5 will be set if Empty.
PagesAhead - number of pages ahead if you use numeric navigation.
Optional. Default value=0 will be set if Empty.
If you use numeric type of navigation like:

Please set PagesAhead=number of available pages ahead.
In the example above you need to know only if max 5 pages ahead are available.
If you send us this information - the search will be performed faster.
Set PagesAhead=-1 if you use a different type of navigation and need to return a total number of images.
Type - has 2 options. "IMAGE" - search for photos and illustrations, "CLIPART" - search for illustrations only.
Optional. "IMAGE" option will be set if Empty.

Response:

<?xml version="1.0" encoding="utf-8"?>
<SearchResults xmlns="http://tempuri.org/">
<Error>string</Error>
<TotalImages>int</TotalImages>
<PageId>int</PageId>
<PagesAhead>int</PagesAhead> 
<Images>
<Image>
<ImageId>int</ImageId>
<ImageFile>string</ImageFile>
<ImageName>string</ImageName> 
<ImagePage>string</ImagePage> 
<Width>int</Width>
<Height>int</Height>
</Image>
<Image>
<ImageId>int</ImageId>
<ImageFile>string</ImageFile>
<Width>int</Width>
<Height>int</Height>
</Image>
</Images>
</SearchResults>

Response nodes:

Error - check it first, and if empty - read the rest of the nodes
TotalImages - total available images will be returned if you set PagesAhead=0, 0 will be returned if you use a numeric type of navigation.
PageId - current page id
PagesAhead - number of available pages ahead
ImageId - ImageId in FeaturePics collection for further references
ImageFile - URL of image thumbnail
ImageName - Image name
ImagePage - URL of the Image page at FeaturePics.com
Width - thumbnail width
Height - thumbnail height

Example 1:
5 (by default) illustrations that match "cartoon girl" will be returned in XML format

[hostname]/GetImages.asmx/SearchResults3?Keywords=cartoon%20girl&NumberPerPage=5&Type=CLIPART

Example 2:
4 images matching "Dolphins" will be returned in XML format

[hostname]/GetImages.asmx/SearchResults3?Keywords=Dolphins&NumberPerPage=4&Type=Image

Example 3:
When you request an API key from us, you will be able to implement navigation on your site.

[hostname]/GetImages.asmx/SearchResults?Key=[YourKey]&Keywords=cartoon%20girl&PageNumber=11&PagesAhead=6&Type=CLIPART

C# Code Example:

public class MyImage
{
string imageid;
string imagefile;
string imagename;
string imagepage;
string width;
string height;
public MyImage()
{
}
public string ImageId
{
get { return imageid; }
set { imageid = value; }
}
public string ImageFile
{
get { return imagefile; }
set { imagefile = value; }
}
public string ImageName
{
get { return imagename; }
set { imagename = value; }
}
public string ImagePage
{
get { return imagepage; }
set { imagepage = value; }
}

public string Width
{
get { return width; }
set { width = value; }
}
public string Height
{
get { return height; }
set { height = value; }
}
}
...
protected void Page_Load(object sender, EventArgs e)
{
if (!IsPostBack)
{       
GetImages();
}
}
private void GetImages()
{
List<MyImage> myimages = new List<MyImage>();
XmlDocument doc = new XmlDocument();
doc.Load("[hostname]/GetIImages.asmx/SearchResults?Keywords=cartoon%20girl&NumberPerPage=5&Type=clipart");
XmlNode errornode = doc.DocumentElement.FirstChild;
string error = errornode.InnerText;
if (error == "")
{
XmlNodeList imageid = doc.GetElementsByTagName("ImageId");
XmlNodeList imagefile = doc.GetElementsByTagName("ImageFile");
XmlNodeList imagename = doc.GetElementsByTagName("ImageName");
XmlNodeList imagepage = doc.GetElementsByTagName("ImagePage");
XmlNodeList width = doc.GetElementsByTagName("Width");
XmlNodeList height = doc.GetElementsByTagName("Height");
for (int i = 0; i  < imageid.Count; i++)
{
MyImage im = new MyImage();
im.ImageId = imageid[i].InnerText;
im.ImageFile = imagefile[i].InnerText;
im.ImageName = imagename[i].InnerText;
im.ImagePage = imagepage[i].InnerText;
im.Height = height[i].InnerText;
im.Width = width[i].InnerText;
myimages.Add(im);
}
}
r1.DataSource = myimages;
r1.DataBind();
}
...
<style>
.b{ display:inline; float:left; height:120px; }
.im{padding:5px; margin:5px;border:1px solid #cccccc;}
</style>
...

<asp:repeater ID=r1 runat=server EnableViewState=false>
<ItemTemplate>
<div class=b align=center>
<a href=' <%#DataBinder.Eval(Container.DataItem, "ImagePage")%>'>
<img class=im 
width=' <%#DataBinder.Eval(Container.DataItem, "Width")%>' 
height=' <%#DataBinder.Eval(Container.DataItem, "Height")%>' 
src=' <%#DataBinder.Eval(Container.DataItem, "ImageFile")%>' 
border=0  
alt=' <%#DataBinder.Eval(Container.DataItem, "ImageName")%>' >
</a>
</div>
</ItemTemplate>
</asp:repeater>

Sign Up FREE	Contact How Do I Terms Of Use Privacy Policy	Royalty-Free Business Extension, Commercial Goods Business Extension, Publications Business Extension, Logo-Type Purposes "Comp Usage" License Open Image Suite User License	Developers API
	2005-2013, FeaturePics and FeatureImage, Fremont, California. All rights reserved.