pikeo.groups.findByName

Find groups with a search based on a textual search.

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

Additional Parameters

Type Parameter Required Description
String text Yes The text to search in group names
Integer
 num_items
 No
 Maximum number of items to return. Default 100, maximum 500.
Integer
 offset
 No
 Number of the first element to return.

Returns

A list of groups that contain the text searched.

REST

Call

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

text=crabe&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.findByName
(decoded : text=crabe&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.findByName)

Response

view plain
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <response>  
  3.     <group>  
  4.        <id>19</id>  
  5.         <creator_id>133</creator_id>  
  6.         <name>crabe group</name>  
  7.         <description>group description</description>  
  8.         <url>null</url>  
  9.         <avatar_url>null</avatar_url>  
  10.         <last_change>2008-10-07 18:25:30.0</last_change>  
  11.         <creation_date>2007-07-26 19:22:38.0</creation_date>  
  12.         <members>3</members>  
  13.        <closed>false</closed>  
  14.     </group>  
  15. </response> 

XMLRPC

Call

view plaincopy to clipboardprint?
  1. <methodCall>  
  2.     <methodName>pikeo.groups.findByName</methodName>  
  3.     <params>  
  4.         <param>  
  5.             <value>  
  6.                 <struct>  
  7.                     <member>  
  8.                         <name>text</name>  
  9.                         <value>crabe</value>  
  10.                     </member>  
  11.                     <member>  
  12.                         <name>nonce</name>  
  13.                         <value>LTQ0OTIxMDgwOTk1MDY2OTIxMzM=</value>  
  14.                     </member>
  15.                     <member>  
  16.                         <name>timestamp</name>  
  17.                         <value>2008-07-23T18:58:19Z</value>  
  18.                     </member>  
  19.                     <member>  
  20.                         <name>api_key</name>  
  21.                         <value>89e2b6457f20b8845213a8900644c0b1</value>  
  22.                     </member>  
  23.                     <member>  
  24.                         <name>api_sig</name>  
  25.                         <value>ZnvuZNO7B/SyXFjUcP/rI2kPLdA=</value>  
  26.                     </member>  
  27.                 </struct>  
  28.             </value> 
  29.         </param>
  30.     </params>  
  31. </methodCall> 

Response

view plain
  1. <?xml version="1.0"?>  
  2. <methodResponse>  
  3.     <params>  
  4.         <param>
  5.             <value>
  6.                 <struct>  
  7.                     <member>  
  8.                        <name>objectType</name>  
  9.                        <value>  
  10.                             <string>group</string>  
  11.                        </value>  
  12.                     </member>  
  13.                     <member>  
  14.                        <name>id</name>  
  15.                         <value>  
  16.                             <i4>19</i4>  
  17.                         </value>  
  18.                     </member>  
  19.                     <member>  
  20.                         <name>creatorId</name>  
  21.                         <value>  
  22.                             <i4>133</i4>  
  23.                         </value>  
  24.                     </member>  
  25.                     <member>  
  26.                         <name>name</name>  
  27.                         <value>  
  28.                             <string>crabe group</string>  
  29.                         </value>  
  30.                     </member>  
  31.                     <member>  
  32.                         <name>description</name>  
  33.                         <value>  
  34.                         <string>group description</string>  
  35.                     </value>  
  36.                     </member>  
  37.                     <member>  
  38.                         <name>url</name>  
  39.                     </member>  
  40.                     <member>  
  41.                        <name>avatarUrl</name>  
  42.                     </member>  
  43.                     <member>  
  44.                         <name>lastChange</name>  
  45.                         <value>  
  46.                             <dateTime.iso8601>20081007T18:25:30</dateTime.iso8601>  
  47.                         </value>  
  48.                     </member>  
  49.                     <member>  
  50.                        <name>creationDate</name>  
  51.                         <value>  
  52.                            <dateTime.iso8601>20070726T19:22:38</dateTime.iso8601>  
  53.                         </value>  
  54.                     </member>  
  55.                     <member>  
  56.                         <name>members</name>  
  57.                         <value>  
  58.                             <i4>3</i4>  
  59.                         </value>  
  60.                     </member>  
  61.                     <member>  
  62.                         <name>closed</name>  
  63.                         <value>  
  64.                             <boolean>0</boolean>  
  65.                         </value>  
  66.                     </member>  
  67.                 </struct>  
  68.             </value>  
  69.         </param>  
  70.     </params>  
  71. </methodResponse> 

version 11 as of 12 months ago by jeremy

Comments

New comments are not being accepted at this time.