Upload banner | Free banner maker | Sign up for free

Frequently Asked Questions 

b. Get Search Results

getSearchResult()


This methods makes possible to search all banners in abracadaban. Full search capabilities are available through the API.


Authentication


This method does not require authentication.


Encoding

The Abracadaban API requires all data to be UTF-8 encoded. More information about UTF-8 encoding

Argument Type Element (array) Valid Values Default Value Detail
api_key string   valid values required you need a valid api key to use the API
language_id Int  
  • 1
  • 2
  • 3
 1
  • English
  • French
  • Spanish
words string   list of words none Keyword search
creator_id int   valid creator id none Search by creator
cat_id int   valid category id none Search by category
get valid categories ids width getCategories
country_id int   valid country id none Search by country
get valid country id's with getCountries
size_id int   existing size id none Search by size (other size available)
similar_id int   existing similar id none Search by similar banner
filters array
  • content_type:flash
  • content_type:gif
  • content_type:all
  • 0 - 1
  • 0 - 1
  • 0 - 1
  • 0
  • 0
  • 1
  • Search for flash bannerss
  • Search for gif banners
  • Search for both gif and flash
order string  
  • relevance
  • last_1
  • most_viewed
  • nb_votes
  • nb_used
 relevance
  • Relevance
  • Last added DESC
  • Most viewed DESC
  • number of votes DESC
  • number of use DESC
limit Int   1 to 50 25 maximum number of banner returned
offset int   0 to max results 0 Start position in query
detail_level int  
  • 1
 none When this parameter is sent and set to 1, the method will return for each content :
  • template_ID
  • Template_author
  • nb_votes

Returned Values

Element (path) Name Type Description
/[n]/ TotalRecords int total number of records found during search
/[n]/ id int banner unique ID
/[n]/ title string banner title (used for title tag)
/[n]/ creator_id int banner creator unique id
/[n]/ creator_name string banner creator name
/[n]/ thumbnail_url string banner thumbnail url
/[n]/ thumbnail_html_tag string banner thumbnail html tag
/[n]/ thumbnail_width int banner thumbnail width (px)
/[n]/ thumbnail_height int banner thumbnail height(px)
/[n]/prices/[n]/ price string banner price
When detail_level=1 only :
/[n]/ nb_views int banner views number
/[n]/ nb_votes int banner votes number
/[n]/ keywords string banner keywords, comma separated


Example Query

  

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
	<methodName>getSearchResults()</methodName>
	<params>
		<param>
			<value><string></string></value>
		</param>

		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><string></string></value>
		</param>
		
		<param>
			<value><int>109</int></value>
		</param>

		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><int></int></value>
		</param>

		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><array></array></value>
		</param>
		
		<param>
			<value><string></string></value>
		</param>

		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><int></int></value>
		</param>
		
		<param>
			<value><int></int></value>
		</param>
	</params>
</methodCall>
   

Example Response


    

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
     <param>
          <value>
               <array>
                    <data>
                         <value>
                              <struct>
                                    <member>
                                         <name>TotalRecords</name>
                                         <value><int>25</int></value>
                                    </member>
                              </struct>
                         </value>							  
                         <value>
                              <struct>
                                    <member>
                                         <name>id</name>
                                         <value><int>1</int></value>
                                    </member>
                                    <member>
                                         <name>title</name>
                                         <value><string>Butterfly</string></value>
                                    </member>
                                    <member>
                                         <name>creator_id</name>
                                         <value><int>109</int></value>
                                    </member>
                                    <member>
                                         <name>creator_name</name>	
                                         <value><string>rigolman</string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_url</name>
                                         <value><string>http://192.168.1.12/phpsvn/abracadaban/banners/200906150170aa3d6f1227ee50c6b1aca24498fe81.swf</string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_html_tag</name>
                                         <value><string>
                                         &lt;a href=&quot;http://192.168.1.12/phpsvn/abracadaban/Banner/Details/1/Butterfly.html&quot; 
                                         title=&quot;Butterfly&quot; alt=&quot;Butterfly&quot; &gt; Butterfly-120x600 &lt;/a&gt;
                                         </string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_width</name>
                                         <value><string>120</string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_height</name>
                                         <value><string>600</string></value>
                                    </member>
                                    <member>
                                         <name>price</name>
                                         <value><string></string></value>
                                    </member>
                                    <member>
                                         <name>nb_views</name>
                                         <value><string>22</string></value>
                                    </member>
                                    <member>
                                         <name>nb_votes</name>
                                         <value><string>0</string></value>
                                    </member>
                                    <member>
                                         <name>keywords</name>
                                         <value><string>butterfly,bird,animal,color,heaven,peace,peaceful,love</string></value>
                                    </member>
                               </struct>
                          </value>

                         <value>
                              <struct>
                                    <member>
                                         <name>id</name>
                                         <value><int>2</int></value>
                                    </member>
                                    <member>
                                         <name>title</name>
                                         <value><string>Butterfly</string></value>
                                    </member>
                                    <member>
                                         <name>creator_id</name>
                                         <value><int>109</int></value>
                                    </member>
                                    <member>
                                         <name>creator_name</name>	
                                         <value><string>rigolman</string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_url</name>
                                         <value><string>                                        		
                                       http://192.168.1.12/phpsvn/abracadaban/banners/200906154394f850a760827d9864258e7d8f423210.swf
                                         </string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_html_tag</name>
                                         <value><string>
                                         &lt;a href=&quot;http://192.168.1.12/phpsvn/abracadaban/Banner/Details/2/Butterfly.html&quot; 
                                         title=&quot;Butterfly&quot; alt=&quot;Butterfly&quot; &gt; Butterfly-125x125 &lt;/a&gt;
                                         </string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_width</name>
                                         <value><string>125</string></value>
                                    </member>
                                    <member>
                                         <name>thumbnail_height</name>
                                         <value><string>125</string></value>
                                    </member>
                                    <member>
                                         <name>price</name>
                                         <value><string></string></value>
                                    </member>
                                    <member>
                                         <name>nb_views</name>
                                         <value><string>8</string></value>
                                    </member>
                                    <member>
                                         <name>nb_votes</name>
                                         <value><string>0</string></value>
                                    </member>
                                    <member>
                                         <name>keywords</name>
                                         <value><string>butterfly,bird,animal,color,heaven,peace,peaceful,love</string></value>
                                    </member>
                               </struct>
                          </value>
                     </data>
                </array>
           </value>
      </param>
</params>
</methodResponse>
 
     



Error Codes


1025: API Key Missing
You might have forgot to enter API Key.

1001: Invalid API Key
The API key passed is not valid or has expired.

1024: Search result not available.
The search result is not available for this API Key.



<< Year >>
Su Mo Tu We Th Fr Sa