pikeo.groups.search

Search groups 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.

Additional 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

Public information about the group.

REST

Call

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

incl_banned_groups=true&photo_id=19877&num_items=2&login=jattali&nonce=MjYwMjk3NTYwOTk2MjQ5NTQ0Ng%3D%3D&timestamp=2007-11-01T15%3A40%3A54Z&api_key=your_api_key&force_quit_group=true&api_sig=XF9qQ9iGZskSVdzxM21tGGXWiLE=&method=pikeo.groups.searc
(decoded : incl_banned_groups=true&photo_id=19877&num_items=2&login=jattali&nonce=MjYwMjk3NTYwOTk2MjQ5NTQ0Ng==&timestamp=2007-11-01T15:40:54Z&api_key=your_api_key&force_quit_group=true&api_sig=XF9qQ9iGZskSVdzxM21tGGXWiLE=&method=pikeo.groups.searc)

Response

view plain
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <response>  
  3.     <value>  
  4.         <array>  
  5.             <group>  
  6.                 <id>7</id>  
  7.                 <creator_id>503</creator_id>  
  8.                 <name>david_group</name>  
  9.                 <description></description>  
  10.                 <url>null</url>  
  11.                 <avatar_url>null</avatar_url>  
  12.                 <last_change>null</last_change>  
  13.                 <creation_date>2007-07-18 16:44:34.0</creation_date>  
  14.                 <members>1</members>  
  15.                 <closed>false</closed>  
  16.             </group>  
  17.             <group>  
  18.                 <id>9</id>  
  19.                 <creator_id>503</creator_id>  
  20.                 <name>aone</name>  
  21.                 <description></description>  
  22.                 <url>null</url>  
  23.                 <avatar_url>null</avatar_url>  
  24.                 <last_change>2007-09-18 02:20:36.0</last_change>  
  25.                 <creation_date>2007-07-19 00:07:07.0</creation_date>  
  26.                 <members>5</members>  
  27.                 <closed>false</closed>  
  28.             </group>  
  29.         </array>  
  30.     </value>  
  31. </response>  
<?xml version="1.0" encoding="UTF-8"?>
<response>
        <value>
                <array>
                        <group>
                                <id>7</id>
                                <creator_id>503</creator_id>
                                <name>david_group</name>
                                <description></description>
                                <url>null</url>
                                <avatar_url>null</avatar_url>
                                <last_change>null</last_change>
                                <creation_date>2007-07-18 16:44:34.0</creation_date>
                                <members>1</members>
                                <closed>false</closed>
                        </group>
                        <group>
                                <id>9</id>
                                <creator_id>503</creator_id>
                                <name>aone</name>
                                <description></description>
                                <url>null</url>
                                <avatar_url>null</avatar_url>
                                <last_change>2007-09-18 02:20:36.0</last_change>
                                <creation_date>2007-07-19 00:07:07.0</creation_date>
                                <members>5</members>
                                <closed>false</closed>
                        </group>
                </array>
        </value>
</response>

XMLRPC

Call

 

view plain
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <methodCall>  
  3.     <methodName>pikeo.groups.search</methodName>  
  4.     <params>  
  5.         <param>  
  6.             <value>  
  7.                 <struct>  
  8.                     <member>  
  9.                         <name>incl_banned_groups</name>  
  10.                         <value>  
  11.                             <boolean>1</boolean>  
  12.                         </value>  
  13.                     </member>  
  14.                     <member>  
  15.                         <name>login</name>  
  16.                         <value>jattali</value>  
  17.                     </member>  
  18.                     <member>  
  19.                         <name>photo_id</name>  
  20.                         <value>  
  21.                             <i4>19877</i4>  
  22.                         </value>  
  23.                     </member>  
  24.                     <member>  
  25.                         <name>num_items</name>  
  26.                         <value>  
  27.                             <i4>2</i4>  
  28.                         </value>  
  29.                     </member>  
  30.                     <member>  
  31.                         <name>nonce</name>  
  32.                         <value>LTM3MzIxNTc0MDY3NDQ1MzEzNzM=</value>  
  33.                     </member>  
  34.                     <member>  
  35.                         <name>timestamp</name>  
  36.                         <value>2008-10-15T14:39:41Z</value>  
  37.                     </member>  
  38.                     <member>  
  39.                         <name>api_key</name>  
  40.                         <value>your_api_key</value>  
  41.                     </member>  
  42.                     <member>  
  43.                         <name>api_sig</name>  
  44.                         <value>KncGvH7FaBKBS1sV4sVyzY3hZNE=</value>  
  45.                     </member>  
  46.                 </struct>  
  47.             </value>  
  48.         </param>  
  49.     </params>  
  50. </methodCall>  
<?xml version="1.0" encoding="UTF-8"?>
<methodCall
        xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
        <methodName>pikeo.groups.search</methodName>
        <params>
                <param>
                        <value>
                                <struct>
                                        <member>
                                                <name>incl_banned_groups</name>
                                                <value>
                                                        <boolean>1</boolean>
                                                </value>
                                        </member>
                                        <member>
                                                <name>login</name>
                                                <value>shravanthi</value>
                                        </member>
                                        <member>
                                                <name>photo_id</name>
                                                <value>
                                                        <i4>19877</i4>
                                                </value>
                                        </member>
                                        <member>
                                                <name>num_items</name>
                                                <value>
                                                        <i4>2</i4>
                                                </value>
                                        </member>
                                        <member>
                                                <name>nonce</name>
                                                <value>LTM3MzIxNTc0MDY3NDQ1MzEzNzM=</value>
                                        </member>
                                        <member>
                                                <name>timestamp</name>
                                                <value>2008-10-15T14:39:41Z</value>
                                        </member>
                                        <member>
                                                <name>api_key</name>
                                                <value>89e2b6457f20b8845213a8900644c0b1</value>
                                        </member>
                                        <member>
                                                <name>api_sig</name>
                                                <value>KncGvH7FaBKBS1sV4sVyzY3hZNE=</value>
                                        </member>
                                </struct>
                        </value>
                </param>
        </params>
</methodCall>

Response

view plain
  1. <?xml version="1.0"?>  
  2. <methodResponse>  
  3.     <params>  
  4.         <param>  
  5.             <value>  
  6.                 <array>  
  7.                     <data>  
  8.                         <value>  
  9.                             <struct>  
  10.                                 <member>  
  11.                                     <name>objectType</name>  
  12.                                     <value>  
  13.                                         <string>group</string>  
  14.                                     </value>  
  15.                                 </member>  
  16.                                 <member>  
  17.                                     <name>id</name>  
  18.                                     <value>  
  19.                                         <i4>7</i4>  
  20.                                     </value>  
  21.                                 </member>  
  22.                                 <member>  
  23.                                     <name>creatorId</name>  
  24.                                     <value>  
  25.                                         <i4>503</i4>  
  26.                                     </value>  
  27.                                 </member>  
  28.                                 <member>  
  29.                                     <name>name</name>  
  30.                                     <value>  
  31.                                         <string>david_group</string>  
  32.                                     </value>  
  33.                                 </member>  
  34.                                 <member>  
  35.                                     <name>description</name>  
  36.                                     <value>  
  37.                                         <string></string>  
  38.                                     </value>  
  39.                                 </member>  
  40.                                 <member>  
  41.                                     <name>url</name>  
  42.                                 </member>  
  43.                                 <member>  
  44.                                     <name>avatarUrl</name>  
  45.                                 </member>  
  46.                                 <member>  
  47.                                     <name>lastChange</name>  
  48.                                 </member>  
  49.                                 <member>  
  50.                                     <name>creationDate</name>  
  51.                                     <value>  
  52.                                         <dateTime.iso8601>  
  53.                                             20070718T16:44:34  
  54.                                         </dateTime.iso8601>  
  55.                                     </value>  
  56.                                 </member>  
  57.                                 <member>  
  58.                                     <name>members</name>  
  59.                                     <value>  
  60.                                         <i4>1</i4>  
  61.                                     </value>  
  62.                                 </member>  
  63.                                 <member>  
  64.                                     <name>closed</name>  
  65.                                     <value>  
  66.                                         <boolean>0</boolean>  
  67.                                     </value>  
  68.                                 </member>  
  69.                             </struct>  
  70.                         </value>  
  71.                         <value>  
  72.                             <struct>  
  73.                                 <member>  
  74.                                     <name>objectType</name>  
  75.                                     <value>  
  76.                                         <string>group</string>  
  77.                                     </value>  
  78.                                 </member>  
  79.                                 <member>  
  80.                                     <name>id</name>  
  81.                                     <value>  
  82.                                         <i4>9</i4>  
  83.                                     </value>  
  84.                                 </member>  
  85.                                 <member>  
  86.                                     <name>creatorId</name>  
  87.                                     <value>  
  88.                                         <i4>503</i4>  
  89.                                     </value>  
  90.                                 </member>  
  91.                                 <member>  
  92.                                     <name>name</name>  
  93.                                     <value>  
  94.                                         <string>aone</string>  
  95.                                     </value>  
  96.                                 </member>  
  97.                                 <member>  
  98.                                     <name>description</name>  
  99.                                     <value>  
  100.                                         <string></string>  
  101.                                     </value>  
  102.                                 </member>  
  103.                                 <member>  
  104.                                     <name>url</name>  
  105.                                 </member>  
  106.                                 <member>  
  107.                                     <name>avatarUrl</name>  
  108.                                 </member>  
  109.                                 <member>  
  110.                                     <name>lastChange</name>  
  111.                                     <value>  
  112.                                         <dateTime.iso8601>  
  113.                                             20070918T02:20:36  
  114.                                         </dateTime.iso8601>  
  115.                                     </value>  
  116.                                 </member>  
  117.                                 <member>  
  118.                                     <name>creationDate</name>  
  119.                                     <value>  
  120.                                         <dateTime.iso8601>  
  121.                                             20070719T00:07:07  
  122.                                         </dateTime.iso8601>  
  123.                                     </value>  
  124.                                 </member>  
  125.                                 <member>  
  126.                                     <name>members</name>  
  127.                                     <value>  
  128.                                         <i4>5</i4>  
  129.                                     </value>  
  130.                                 </member>  
  131.                                 <member>  
  132.                                     <name>closed</name>  
  133.                                     <value>  
  134.                                         <boolean>0</boolean>  
  135.                                     </value>  
  136.                                 </member>  
  137.                             </struct>  
  138.                         </value>  
  139.                     </data>  
  140.                 </array>  
  141.             </value>  
  142.         </param>  
  143.     </params>  
  144. </methodResponse>  
<?xml version="1.0"?>
<methodResponse>
        <params>
                <param>
                        <value>
                                <array>
                                        <data>
                                                <value>
                                                        <struct>
                                                                <member>
                                                                        <name>objectType</name>
                                                                        <value>
                                                                                <string>group</string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>id</name>
                                                                        <value>
                                                                                <i4>7</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>creatorId</name>
                                                                        <value>
                                                                                <i4>503</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>name</name>
                                                                        <value>
                                                                                <string>david_group</string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>description</name>
                                                                        <value>
                                                                                <string></string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>url</name>
                                                                </member>
                                                                <member>
                                                                        <name>avatarUrl</name>
                                                                </member>
                                                                <member>
                                                                        <name>lastChange</name>
                                                                </member>
                                                                <member>
                                                                        <name>creationDate</name>
                                                                        <value>
                                                                                <dateTime.iso8601>
                                                                                        20070718T16:44:34
                                                                                </dateTime.iso8601>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>members</name>
                                                                        <value>
                                                                                <i4>1</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>closed</name>
                                                                        <value>
                                                                                <boolean>0</boolean>
                                                                        </value>
                                                                </member>
                                                        </struct>
                                                </value>
                                                <value>
                                                        <struct>
                                                                <member>
                                                                        <name>objectType</name>
                                                                        <value>
                                                                                <string>group</string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>id</name>
                                                                        <value>
                                                                                <i4>9</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>creatorId</name>
                                                                        <value>
                                                                                <i4>503</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>name</name>
                                                                        <value>
                                                                                <string>aone</string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>description</name>
                                                                        <value>
                                                                                <string></string>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>url</name>
                                                                </member>
                                                                <member>
                                                                        <name>avatarUrl</name>
                                                                </member>
                                                                <member>
                                                                        <name>lastChange</name>
                                                                        <value>
                                                                                <dateTime.iso8601>
                                                                                        20070918T02:20:36
                                                                                </dateTime.iso8601>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>creationDate</name>
                                                                        <value>
                                                                                <dateTime.iso8601>
                                                                                        20070719T00:07:07
                                                                                </dateTime.iso8601>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>members</name>
                                                                        <value>
                                                                                <i4>5</i4>
                                                                        </value>
                                                                </member>
                                                                <member>
                                                                        <name>closed</name>
                                                                        <value>
                                                                                <boolean>0</boolean>
                                                                        </value>
                                                                </member>
                                                        </struct>
                                                </value>
                                        </data>
                                </array>
                        </value>
                </param>
        </params>
</methodResponse>

version 3 as of 1 year ago by jeremy

Comments

New comments are not being accepted at this time.