Groups of gamers get together and put on Gatherings and Conventions.
Groups are accessed via /api/group.
See "Object Properties" in Introduction for basic shared properties.
Complete details in GroupProperties.
See "Related Objects" in Introduction for how to use them.
The GeoLocation where this group hails from.
The User that has absolute authority over this group.
See "Relationships" in Introduction for how to use them.
The list of Conventions created by this group.
The list of GroupImages uploaded by this group.
InvitedMembers maintains the list of email addresses that have been invited to join this group.
The list of LedgerEntrys for transactions created by this group. See LedgerEntry for available search options.
Member relates Users to this group.
PendingMember relates Users that have applied to be a Member of this group.
See "Includes" in Introduction for how to use them.
Returns the count of pending applications to the Group.
Note that once an application is approved or denied, the PendingMember record is deleted, so this is always the current number, not a historical total.
Deprecated; use invited_count instead.
Returns the count of invitations to the Group.
Note that once an invitation is accepted, the InvitedMember record is deleted, so this is always the current number, not a historical total.
Returns the count of times the Group been added to users' "Liked" lists.
Deprecated; use applied_count instead.
Returns ame of the current User's authoritative position in the Group,
either leader or director; and either is_leader or is_director set to 1,
if the current User has the position in question.
(Members have no specific position designation.)
Whether the current User has liked the Group.
The services used to fetch and manipulate groups.
GET /api/group
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"name" : "Madison Area Game Designers",
...
},
...
]
}
POST /api/group
Returns the same as a normal read.
GET /api/group/xxx
Returns:
{
"id" : "xxx",
"name" : "Madison Area Game Designers",
...
}
PUT /api/group/xxx
Returns the same as a normal read.
DELETE /api/group/xxx
Returns:
{
"success" : 1
}
Disassociates the Group's current header image from the Group.
DELETE /api/group/xxx/header-image
Returns the same as a normal read.
For a Group with open enrollment, the request user becomes a Member of the Group.
POST /api/group/xxx/join
Returns the a normal read of the new Member.
For a Group with enrollment set to apply, the request user applies to become a Member of the Group.
POST /api/group/xxx/apply
Returns:
{
"success" : 1
}