pikeo.photos.search

Search photos which title or associated tags contains a given text, or that match with all different criteria sent in parameters.

Authentication is not required but the results may vary if the call is made with logged access.

Parameters

Type Parameter Required Description
Integer num_items
 No
 Maximum number of items to return. Default 100, maximum 500.
Integer offset
 No
 Number of the first element to return.
String text No the text to search in photo title or tag name, must contain at least 3 characters
Integer user_id No Select photos for this user Id
Integer album_id
 No Select photos for this album Id
Integer group_id
 No Select photos for this group Id
List<Integer>
 tag_id_list
 No Select photos for this list of tag Id
Date
 high_date
 No Select photos which date is before hiDate
Date
 low_date
 No Select photos which date is after loDate
Boolean
 include_contact_photos
 No Include photos from contacts too
Boolean
 only_public
 No Filter to public photos only
Boolean order_asc
 No Acsendant or descendant order
Integer order_type
 No Order Type : 0 by default, 1 by date taken,
                       2 by upload date, 3 by most viewed,
                       4 by comment date, 5 by group add date.

Returns

A list of photos. The function returns a maximum of 500 photos.

REST

Call

The following code represents the parameters of the HTTP POST request:

text=test&nonce=LTI2NzgzNjMwNzQxMzcyODQ5MDg%3D&timestamp=2007-11-01T15%3A40%3A53Z&api_key=your_api_key&api_sig=SQYonI7lz90cZOiBiUDo6PKAu94%3D&method=pikeo.photos.search
(decoded : text=test&nonce=LTI2NzgzNjMwNzQxMzcyODQ5MDg=&timestamp=2007-11-01T15:40:53Z&api_key=your_api_key&api_sig=SQYonI7lz90cZOiBiUDo6PKAu94=&method=pikeo.photos.search)

Response

 

view plain
  1. <response>  
  2.   <value>  
  3.     <array>  
  4.       <photo>  
  5.         <id>23908</id>  
  6.         <owner_id>700</owner_id>  
  7.         <owner_username>npolive</owner_username>  
  8.         <owner_location>Paris - France</owner_location>  
  9.         <owner_avatar_url>http://media1.pikeo.com/images/server28/avatar/E3DXYF2J24HR8CBZTJHVLRKR5TMMOT5J.jpg</owner_avatar_url>  
  10.         <url_prefix>http://test.pikeo.com/images/imgrep2/</url_prefix>  
  11.         <secret>QUI756QOND7W6WCQWT2FKPR1P7CV8X50</secret>  
  12.         <original>AV8BC6E5ZPWLOAH37MUS348UGJ1KOD02.JPG</original><title>DSC00376.JPG</title>  
  13.         <description></description>  
  14.         <date_posted>null</date_posted>  
  15.         <date_taken>2007-09-09 07:27:51.0</date_taken>  
  16.         <is_contact>true</is_contact>  
  17.         <is_friend>true</is_friend>  
  18.         <is_family>true</is_family>  
  19.         <value>  
  20.           <array>  
  21.             <tag>  
  22.               <id>3085</id>  
  23.               <category>what</category>  
  24.               <name>test2</name>  
  25.             </tag>  
  26.           </array>  
  27.         </value>  
  28.       </photo>  
  29.       <photo>  
  30.         <id>24086</id>  
  31.         <owner_id>503</owner_id>  
  32.         <owner_username>shravanthi</owner_username>  
  33.         <owner_location>Paris - France</owner_location>  
  34.         <owner_avatar_url>http://media1.pikeo.com/images/server28/avatar/E3DXYF2J24HR8CBZTJHVLRKR5TMMOT5J.jpg</owner_avatar_url>  
  35.         <url_prefix>http://test.pikeo.com/images/imgrep2/</url_prefix>  
  36.         <secret>5B0OXE6MYEC6T1YN086CC9LOWULCGH3G</secret>  
  37.         <original>KVDJ1I4A0LGENY0ZTK8TXWCVDK7WS0KH.JPG</original><title>Candel for peace.JPG</title>  
  38.         <description></description>  
  39.         <date_posted>2007-10-30 15:48:22.0</date_posted>  
  40.         <date_taken>null</date_taken>  
  41.         <is_contact>true</is_contact>  
  42.         <is_friend>true</is_friend>  
  43.         <is_family>true</is_family>  
  44.         <value>  
  45.           <array>  
  46.             <tag>  
  47.               <id>2748</id>  
  48.               <category>what</category>  
  49.               <name>Test1</name>  
  50.             </tag>  
  51.           </array>  
  52.         </value>  
  53.       </photo>  
  54.     </array>  
  55.   </value>  
  56. </response>  
<response>
  <value>
    <array>
      <photo>
        <id>23908</id>
        <owner_id>700</owner_id>
        <owner_username>npolive</owner_username>
        <owner_location>Paris - France</owner_location>
        <owner_avatar_url>http://media1.pikeo.com/images/server28/avatar/E3DXYF2J24HR8CBZTJHVLRKR5TMMOT5J.jpg</owner_avatar_url>
        <url_prefix>http://test.pikeo.com/images/imgrep2/</url_prefix>
        <secret>QUI756QOND7W6WCQWT2FKPR1P7CV8X50</secret>
        <original>AV8BC6E5ZPWLOAH37MUS348UGJ1KOD02.JPG</original><title>DSC00376.JPG</title>
        <description></description>
        <date_posted>null</date_posted>
        <date_taken>2007-09-09 07:27:51.0</date_taken>
        <is_contact>true</is_contact>
        <is_friend>true</is_friend>
        <is_family>true</is_family>
        <value>
          <array>
            <tag>
              <id>3085</id>
              <category>what</category>
              <name>test2</name>
            </tag>
          </array>
        </value>
      </photo>
      <photo>
        <id>24086</id>
        <owner_id>503</owner_id>
        <owner_username>shravanthi</owner_username>
        <owner_location>Paris - France</owner_location>
        <owner_avatar_url>http://media1.pikeo.com/images/server28/avatar/E3DXYF2J24HR8CBZTJHVLRKR5TMMOT5J.jpg</owner_avatar_url>
        <url_prefix>http://test.pikeo.com/images/imgrep2/</url_prefix>
        <secret>5B0OXE6MYEC6T1YN086CC9LOWULCGH3G</secret>
        <original>KVDJ1I4A0LGENY0ZTK8TXWCVDK7WS0KH.JPG</original><title>Candel for peace.JPG</title>
        <description></description>
        <date_posted>2007-10-30 15:48:22.0</date_posted>
        <date_taken>null</date_taken>
        <is_contact>true</is_contact>
        <is_friend>true</is_friend>
        <is_family>true</is_family>
        <value>
          <array>
            <tag>
              <id>2748</id>
              <category>what</category>
              <name>Test1</name>
            </tag>
          </array>
        </value>
      </photo>
    </array>
  </value>
</response>

XMLRPC

Call

view plaincopy to clipboardprint?
  1. <methodCall>  
  2.   <methodName>pikeo.photos.search</methodName>  
  3.   <params>  
  4.     <param>  
  5.       <value>  
  6.         <struct>  
  7.           <member>  
  8.             <name>text</name>  
  9.             <value>test</value>  
  10.           </member>  
  11.           <member>  
  12.             <name>nonce</name>  
  13.             <value>LTQ0MTkyMzgwMzcxMjA5MjI5MjY=</value>  
  14.           </member>  
  15.           <member>  
  16.             <name>timestamp</name>  
  17.             <value>2007-11-01T11:34:50Z</value>  
  18.           </member>  
  19.           <member>  
  20.             <name>api_key</name>  
  21.             <value>your_api_key</value>  
  22.           </member>  
  23.           <member>  
  24.             <name>api_sig</name>  
  25.             <value>9gFe9mLVU5m+5zPqIZo0K5o+8x4=</value>  
  26.           </member>  
  27.         </struct>  
  28.       </value>  
  29.   </params>  
  30. </methodCall>  

Response

 

view plain
  1. <methodResponse>  
  2.   <params>  
  3.     <param>  
  4.       <value>  
  5.         <array>  
  6.           <data>  
  7.             <value>  
  8.               <struct>  
  9.                 <member>  
  10.                   <name>objectType</name>  
  11.                   <value>  
  12.                     <string>photo</string>  
  13.                   </value>  
  14.                 </member>  
  15.                 <member>  
  16.                   <name>id</name>  
  17.                   <value>  
  18.                     <i4>23456</i4>  
  19.                   </value>  
  20.                 </member>  
  21.                 <member>  
  22.                   <name>ownerId</name>  
  23.                     <i4>675</i4>  
  24.                   </value>  
  25.                   <value>  
  26.                 </member>  
  27.                 <member>  
  28.                   <name>ownerUsername</name>  
  29.                   <value>  
  30.                     <string>jattali</string>  
  31.                   </value>  
  32.                 </member>  
  33.                 <member>  
  34.                   <name>ownerLocation</name>  
  35.                   <value>  
  36.                     <string>Paris- France</string>  
  37.                   </value>  
  38.                 </member>  
  39.                 <member>  
  40.                   <name>ownerAvatarUrl</name>  
  41.                   <value>  
  42.                     <string>http://media1.pikeo.com/images/server23/avatar/DUQQSP42WGWLKZ6EJCZ7MJMC06EMWWR0.jpg</string>  
  43.                   </value>  
  44.                 </member>  
  45.                 <member>  
  46.                   <name>urlPrefix</name>  
  47.                   <value>  
  48.                     <string>http://test.pikeo.com/images/imgrep2/</string>  
  49.                   </value>  
  50.                 </member>  
  51.                 <member>  
  52.                   <name>secret</name>  
  53.                   <value>  
  54.                     <string>WWHQ7IB1RX7CSA3XE8RYW4UQ8EXMOXPT</string>  
  55.                   </value>  
  56.                 </member>  
  57.                 <member>  
  58.                   <name>original</name>  
  59.                   <value>  
  60.                     <string>9YGB2XJMA2DD84QXMNZBVKNRTLK82DQQ</string>  
  61.                   </value>  
  62.                 </member>  
  63.                 <member>  
  64.                   <name>title</name>  
  65.                   <value>  
  66.                     <string>TEST</string>  
  67.                   </value>  
  68.                 </member>  
  69.                 <member>  
  70.                   <name>description</name>  
  71.                   <value>  
  72.                     <string></string>  
  73.                   </value>  
  74.                 </member>  
  75.                 <member>  
  76.                   <name>datePosted</name>  
  77.                   <value>  
  78.                     <dateTime.iso8601>20070810T13:47:27</dateTime.iso8601>  
  79.                   </value>  
  80.                 </member>  
  81.                 <member>  
  82.                   <name>dateTaken</name>  
  83.                 </member>  
  84.                 <member>  
  85.                   <name>contact</name>  
  86.                   <value>  
  87.                     <boolean>1</boolean>  
  88.                   </value>  
  89.                 </member>  
  90.                 <member>  
  91.                   <name>friend</name>  
  92.                   <value>  
  93.                     <boolean>1</boolean>  
  94.                   </value>  
  95.                 </member>  
  96.                 <member>  
  97.                   <name>family</name>  
  98.                   <value>  
  99.                     <boolean>1</boolean>  
  100.                   </value>  
  101.                 </member>  
  102.                 <member>  
  103.                   <name>tags</name>  
  104.                   <value>  
  105.                     <array>  
  106.                       <data>  
  107.                         <value>  
  108.                           <struct>  
  109.                             <member>  
  110.                               <name>objectType</name>  
  111.                               <value>  
  112.                                 <string>tag</string>  
  113.                               </value>  
  114.                             </member>  
  115.                             <member>  
  116.                               <name>id</name>  
  117.                               <value>  
  118.                                 <i4>3123</i4>  
  119.                               </value>  
  120.                             </member>  
  121.                             <member>  
  122.                               <name>categoryId</name>  
  123.                               <value>  
  124.                                 <i4>3</i4>  
  125.                               </value>  
  126.                             </member>  
  127.                             <member>  
  128.                               <name>name</name>  
  129.                               <value>  
  130.                                 <string>Location</string>  
  131.                               </value>  
  132.                             </member>  
  133.                           </struct>  
  134.                         </value>  
  135.                         <value>  
  136.                           <struct>  
  137.                             <member>  
  138.                               <name>objectType</name>  
  139.                               <value>  
  140.                                 <string>tag</string>  
  141.                               </value>  
  142.                             </member>  
  143.                             <member>  
  144.                               <name>id</name>  
  145.                               <value>  
  146.                                 <i4>3283</i4>  
  147.                               </value>  
  148.                             </member>  
  149.                             <member>  
  150.                               <name>categoryId</name>  
  151.                               <value>  
  152.                                 <i4>1</i4>  
  153.                               </value>  
  154.                             </member>  
  155.                             <member>  
  156.                               <name>name</name>  
  157.                               <value>  
  158.                                 <string>test-jattali</string>    
  159.                               </value>    
  160.                             </member>    
  161.                           </struct>    
  162.                         </value>    
  163.                       </data>    
  164.                     </array>    
  165.                   </value>  
  166.                 </member>  
  167.               </struct>  
  168.             </value>  
  169.           </data>  
  170.         </array>  
  171.       </value>  
  172.     </param>  
  173.   </params>  
  174. </methodResponse>  
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>objectType</name>
                  <value>
                    <string>photo</string>
                  </value>
                </member>
                <member>
                  <name>id</name>
                  <value>
                    <i4>23456</i4>
                  </value>
                </member>
                <member>
                  <name>ownerId</name>
                    <i4>675</i4>
                  </value>
                  <value>
                </member>
                <member>
                  <name>ownerUsername</name>
                  <value>
                    <string>jattali</string>
                  </value>
                </member>
                <member>
                  <name>ownerLocation</name>
                  <value>
                    <string>Paris- France</string>
                  </value>
                </member>
                <member>
                  <name>ownerAvatarUrl</name>
                  <value>
                    <string>http://media1.pikeo.com/images/server23/avatar/DUQQSP42WGWLKZ6EJCZ7MJMC06EMWWR0.jpg</string>
                  </value>
                </member>
                <member>
                  <name>urlPrefix</name>
                  <value>
                    <string>http://test.pikeo.com/images/imgrep2/</string>
                  </value>
                </member>
                <member>
                  <name>secret</name>
                  <value>
                    <string>WWHQ7IB1RX7CSA3XE8RYW4UQ8EXMOXPT</string>
                  </value>
                </member>
                <member>
                  <name>original</name>
                  <value>
                    <string>9YGB2XJMA2DD84QXMNZBVKNRTLK82DQQ</string>
                  </value>
                </member>
                <member>
                  <name>title</name>
                  <value>
                    <string>TEST</string>
                  </value>
                </member>
                <member>
                  <name>description</name>
                  <value>
                    <string></string>
                  </value>
                </member>
                <member>
                  <name>datePosted</name>
                  <value>
                    <dateTime.iso8601>20070810T13:47:27</dateTime.iso8601>
                  </value>
                </member>
                <member>
                  <name>dateTaken</name>
                </member>
                <member>
                  <name>contact</name>
                  <value>
                    <boolean>1</boolean>
                  </value>
                </member>
                <member>
                  <name>friend</name>
                  <value>
                    <boolean>1</boolean>
                  </value>
                </member>
                <member>
                  <name>family</name>
                  <value>
                    <boolean>1</boolean>
                  </value>
                </member>
                <member>
                  <name>tags</name>
                  <value>
                    <array>
                      <data>
                        <value>
                          <struct>
                            <member>
                              <name>objectType</name>
                              <value>
                                <string>tag</string>
                              </value>
                            </member>
                            <member>
                              <name>id</name>
                              <value>
                                <i4>3123</i4>
                              </value>
                            </member>
                            <member>
                              <name>categoryId</name>
                              <value>
                                <i4>3</i4>
                              </value>
                            </member>
                            <member>
                              <name>name</name>
                              <value>
                                <string>Location</string>
                              </value>
                            </member>
                          </struct>
                        </value>
                        <value>
                          <struct>
                            <member>
                              <name>objectType</name>
                              <value>
                                <string>tag</string>
                              </value>
                            </member>
                            <member>
                              <name>id</name>
                              <value>
                                <i4>3283</i4>
                              </value>
                            </member>
                            <member>
                              <name>categoryId</name>
                              <value>
                                <i4>1</i4>
                              </value>
                            </member>
                            <member>
                              <name>name</name>
                              <value>
                                <string>test-jattali</string>  
                              </value>  
                            </member>  
                          </struct>  
                        </value>  
                      </data>  
                    </array>  
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

 

version 13 as of 12 months ago by jeremy

Comments

New comments are not being accepted at this time.