Welcome to Scribd, the world's digital library. Read, publish, and share books and documents. See more
Download
Standard view
Full view
of .
Look up keyword
Like this
0Activity
0 of .
Results for:
No results containing your search query
P. 1
Endeca Search API - Web Service Developer Guide

Endeca Search API - Web Service Developer Guide

Ratings: (0)|Views: 9|Likes:

More info:

Published by: Ever Daniel Barreto Rojas on Jul 11, 2012
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as DOC, PDF, TXT or read online from Scribd
See more
See less

05/13/2014

pdf

text

original

 
Friday-AdEndeca Search API
Endeca Search API
Web Service Developer Guide
Introduction
The Endeca search API provides a web services interface to search and browsethe FridayAd Endeca index. The following protocols are supported:
SOAP 1.1
SOAP 1.2
HTTP GET
HTTP POSTThe URLs for calling the API are:Devhttp://api.friday-ad.co.uk/EndecaDev/Search.asmxLivehttp://api.friday-ad.co.uk/Endeca/Search.asmxThe API supports the following functionality:
Searching and browsing adverts
Filtering results on Latitude/Longitude, Town and Range
Filtering results on selected Endeca dimension values
Sorting by Latest, Nearest, and Price
Paging results (with variable page size)
Specifying returned attributes in search results
Searching by ad ref (for retrieving saved ads)
Retrieving full ad details
Returns selected and refinement dimension values (with dynamic rankingand bin counts)
Expanding single dimensionsLocation data (Lat/Long, County and Town browse lists) can be obtained throughthe Location API athttp://api.friday-ad.co.uk/Location/Location.asmxPaul YoungPage 117/02/2011
 
Friday-AdEndeca Search API
Search Method
Use the Search method to initiate a search or browse, to filter results and retrieveadditional pages of results.
Parameter Description
TargetSiteR
Friday-Ad.co.uk
or 
Friday-Ad.es
or 
Friday-Ad.gi
LatLongOA decimal Latitude/Longitude value (required when Sort= Nearest or Range > 0)e.g.
50.954537,-0.193168
TownOA valid Post Town (only required when user opted tosearch based on Town). If populated a range searchwill always include ads from this town irrespective of range setting.RangeRAn integer value indicating the range to search within.
0
will execute a national search.RangeUnitsR
Miles
or 
Kilometers
SearchTermsOTerms to search for. If empty a browse is performed.SelectedDimensionValueIDsOA comma separated list of Dimension Value IDs used tofilter results.SortR
Latest
or 
Nearest
or 
PriceAscending
or 
PriceDescending
RecordsPerPageRInteger value to set maximum number of recordsreturned in results.PageRInteger value >=1 specifying page number to return. AttributeListOComma separated list of Attribute names to be returnedin results set. If blank, all populated attributes will bereturned.R = Required, O = OptionalThis method returns a
SearchResult
object.
Property Description
TotalRecordsTotal number of records matching the search/browserequest.RecordsA collection of EndecaRecord objects.DimensionsA collection of EndecaDimension objects. Empty if Page > 1in request.
EndecaRecord
object
Property Description
IdUnique AdRef of advert AttributesA collection of Attribute objectsPaul YoungPage 217/02/2011
 
Friday-AdEndeca Search API
Attribute
object
Property Description
KeyAttribute name<Value>Value of the attributeMultiple Attribute values can exist with the same Key. They will be returned asseparate Attribute objects. Example attributes with multiple values are ImageURLand AdvertFlags.
EndecaDimension
object
Property Description
IdThe Endeca DimensionID. Use this value with the
ExpandDimension
method.DisplayNameThe display name for the Dimension.MultiSelect
None
= Only one dimension value can be selected
And
= Multiple dimension values must both match results
Or 
= Any one or more dimension values must match resultsHasMoreI
true
, more dimension values are available by calling the
ExpandDimension
method.SelectedA collection of EndecaRefinement objects identifyingdimension values selected in the request.RefinementsA collection of EndecaRefinement objects identifyingdimension values which can be selected.
EndecaRefinement
object
Property Description
IdThe Dimension Value ID. Use this value in the
SelectedDimensionValueIDs
parameter.DisplayNameThe display name for the dimension value.RecordCountThe number of records in the current total results setmatching this dimension value.Paul YoungPage 317/02/2011

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->