GroupsService

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Created page with "=Introduction= OpenSimulator both has a core groups service which is not yet enabled by default and an external XmlRpc/Flotsam groups service. This ...")
 
Line 2: Line 2:
  
 
OpenSimulator both has a [[V2 Groups|core groups service]] which is not yet enabled by default and an external [[Groups|XmlRpc/Flotsam groups service]].  This page describes the service level interface to the core groups.
 
OpenSimulator both has a [[V2 Groups|core groups service]] which is not yet enabled by default and an external [[Groups|XmlRpc/Flotsam groups service]].  This page describes the service level interface to the core groups.
 +
 +
=API=
 +
 +
==Calls==
 +
 +
===FINDGROUPS===
 +
 +
This returns groups which match a given pattern.  If the pattern is an empty string then all groups are returned.
 +
The POST field is a urlencoded string like so
 +
 +
RequestingAgentID=00000000-0000-0000-0000-000000000000&Query=abc&METHOD=FINDGROUPS
 +
 +
where
 +
 +
* RequestingAgentID is always 00000000-0000-0000-0000-000000000000 for external calls
 +
* Query is the query string
 +
 +
If successful, you will see a server response such as
 +
 +
<source lang="xml">
 +
<?xml version="1.0"?>
 +
<ServerResponse>
 +
  <RESULT type="List">
 +
    <n-0 type="List">
 +
      <GroupID>6ed52fa7-d910-4b6f-a2a6-8c121c0561dd</GroupID>
 +
      <Name>abc1</Name>
 +
      <NMembers>1</NMembers>
 +
      <SearchOrder>0</SearchOrder>
 +
    </n-0>
 +
    <n-1 type="List">
 +
      <GroupID>c5cd5ae2-6b06-4118-b0ed-41556c8c2fac</GroupID>
 +
      <Name>fooabcbar</Name>
 +
      <NMembers>1</NMembers>
 +
      <SearchOrder>0</SearchOrder>
 +
    </n-1>
 +
  </RESULT>
 +
</ServerResponse>
 +
</source>
 +
 +
If no matching group is found, then
 +
 +
<source lang="xml">
 +
<?xml version="1.0"?>
 +
<ServerResponse>
 +
  <RESULT>NULL</RESULT>
 +
  <REASON>No hits</REASON>
 +
</ServerResponse>
 +
</source>
  
 
'''WIP'''
 
'''WIP'''

Revision as of 14:59, 15 May 2014

Contents

Introduction

OpenSimulator both has a core groups service which is not yet enabled by default and an external XmlRpc/Flotsam groups service. This page describes the service level interface to the core groups.

API

Calls

FINDGROUPS

This returns groups which match a given pattern. If the pattern is an empty string then all groups are returned. The POST field is a urlencoded string like so

RequestingAgentID=00000000-0000-0000-0000-000000000000&Query=abc&METHOD=FINDGROUPS

where

  • RequestingAgentID is always 00000000-0000-0000-0000-000000000000 for external calls
  • Query is the query string

If successful, you will see a server response such as 

<?xml version="1.0"?>
<ServerResponse>
  <RESULT type="List">
    <n-0 type="List">
      <GroupID>6ed52fa7-d910-4b6f-a2a6-8c121c0561dd</GroupID>
      <Name>abc1</Name>
      <NMembers>1</NMembers>
      <SearchOrder>0</SearchOrder>
    </n-0>
    <n-1 type="List">
      <GroupID>c5cd5ae2-6b06-4118-b0ed-41556c8c2fac</GroupID>
      <Name>fooabcbar</Name>
      <NMembers>1</NMembers>
      <SearchOrder>0</SearchOrder>
    </n-1>
  </RESULT>
</ServerResponse>

If no matching group is found, then 

<?xml version="1.0"?>
<ServerResponse>
  <RESULT>NULL</RESULT>
  <REASON>No hits</REASON>
</ServerResponse>

WIP

Retrieved from "http://opensimulator.org/index.php?title=GroupsService&oldid=38956"
Personal tools
General
About This Wiki