gs.group.groups.json

Author:Michael JasonSmith
Contact:Michael JasonSmith <mpj17@onlinegroups.net>
Date:2015-06-12
Organization:GroupServer.org
Copyright:This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by OnlineGroups.net.

This product provides a web hook to retrieve the list of groups on a GroupServer site.

Contents:

Web hook

Synopsis

/gs-group-groups.json? token =<t> & get

Description

The hook, gs-group-groups.json in the site context, lists all the groups on a site.

Warning

The hook returns all groups, including the secret ones, and the existence of some groups may be controversial. That is why secret group-privacy exists. Be cautious about disclosing the list of all groups.

Required arguments

token=<token>

The authentication token [1].

get

The “form” action (no value needs to be set, but the argument must be present).

Returns

A list of JSON objects is returned. Each object within the list represents a group, and has the following fields set.

class GroupsReturn()
id

The unique identifier for the group.

name

The name of the group (the title).

url

The URL for the group.

email

The email address for the group,

type

The type of group.

privacy

The group privacy.

Example

Get a list of groups on groups.example.com using wget:

$ wget --post-data="token=Fake&get" \
  http://groups.example.com/gs-group-groups.json

The return-value for GroupServer.org:

[
    {
        "id": "groupserver_announcements",
        "name": "GroupServer Announcements",
        "url": "http://groupserver.org/groups/groupserver_announcements",
        "email": "groupserver_announcements@groupserver.org",
        "type": "Announcement group",
        "privacy": "public"
    },
    {
        "id": "groupserver_team",
        "name": "GroupServer Team",
        "url": "http://groupserver.org/groups/groupserver_team",
        "email": "groupserver_team@groupserver.org",
        "type": "Discussion group",
        "privacy": "private"
    },
    {
        "id": "development",
        "name": "GroupServer Development",
        "url": "http://groupserver.org/groups/development",
        "email": "development@groupserver.org",
        "type": "Discussion group",
        "privacy": "public"
    },
]
[1]See gs.auth.token for more information <https://github.com/groupserver/gs.auth.token>

Changelog

1.0.1 (2015-06-19)

1.0.0 (2015-06-12)

Initial version. Before the creation of this product there was no list of groups in JSON format.

Indices and tables