Group

Description

The Group resource represents a group (for example, San Bernardino Fires) within the portal.

The owner is automatically an administrator and is returned in the list of admins. Administrators can invite, add to, or remove members from a group as well as update or delete the group. The administrator for an organization can also reassign the group to another member of the organization.

Group members can leave the group. Authenticated users can apply to join a group unless the group is by invitation only.

The visibility of the group by other users is determined by the access property. If the group is private, no one other than the administrators and members of the group will be able to see it. If the group is shared with an organization, all members of the organization will be able to find it.

Request Parameters

Parameter

Details

[Common Parameters]

For a complete listing, see Common parameters.

Response Properties

Property

Details

id

The given group ID.

title

The title of the group. This is the name that is displayed to users and by which they refer to the group. Every group must have a title, and it must be unique for a user.

isInvitationOnly

If this is set to true, users will not be able to apply to join the group.

owner

The owner username of the group.

description

The group description.

snippet

The group summary.

tags

User-defined tags that describe the group.

phone

The contact information for the group.

sortField

The sorted field.

sortOrder

The sort order, either descending or ascending.

isViewOnly

Boolean value indicating whether the results are only for viewing.

isFav

Boolean value indicating whether marked in favorites.

thumbnail

The URL to the thumbnail used for the group. All group thumbnails are relative to the URL: http://<community-url>/groups/<groupId>/info.

created

The date the group was created. Shown in UNIX time in milliseconds.

modified

The date the group was last modified. Shown in UNIX time in milliseconds.

access

The access privileges of the group that determine who can see and access the group. Can be: private, org, or public.

userMembership

If the request is made by an authenticated user, a JSON object is returned containing information about the user's access to the group. This includes the username of the calling user, the memberType, which specifies the type of membership the user has in the group (owner, member, admin, none), and the applications (number of requests to join the group) count available to admins and owners.

protected

Indicates if the group is protected from deletion. Default value is false.

autoJoin

Only applies to org accounts. Indicates if the group allows to be joined without requesting membership approval. Default value is false.

Example Usage

URL for Group

http://www.arcgis.com/sharing/rest/community/groups/2ecb37a8c8fb4051af9c086c25503bb0

JSON Response Syntax

{
  "id": "<group id>",
  "title": "<group title>",
  "isInvitationOnly": true |false,
  "owner": "<group owner username>",
  "description": "<description>",
  "snippet": <summary>,
  "tags": [
    "<tag1>",
    "<tag2>",
    "<tag3>"
  ],
  "phone": <contact>, 
  "sortField": "title",
  "sortOrder": "asc",
  "isViewOnly": false,
  "isFav": false,
  "thumbnail": file name,
  "created": date created shown in UNIX time,
  "modified": date modified shown in UNIX time,  
  "access": private | org | public
  "userMembership": {   //available only if request is made by an authenticated user
    "username": "<requestor username>",
    "memberType": "owner | member |admin | none",
    "applications": number of applications  //available only to admins and owners
  },
  "protected": true | false,
  "autoJoin": true | false
}

JSON Response Example

{
  "id": "2ecb37a8c8fb4051af9c086c25503bb0",
  "title": "Street Maps",
  "isInvitationOnly": false,
  "owner": "jsmith",
  "description": "The street maps group provides street maps for the city of Redlands.",
  "snippet": null,
  "tags": [
    "Redlands",
    "Street",
    "Maps"
  ],
  "phone": "jsmith@esri.com", 
  "sortField": "title",
  "sortOrder": "asc",
  "isViewOnly": false,
  "isFav": false,
  "thumbnail": streets.jpg,
  "created": 1247082196000,
  "modified": 1276793808000,
  "access": public
  "userMembership": {
    "username": "jsmith",
    "memberType": "owner",
    "applications": 1
  },
  "protected": true,
  "autoJoin": false
}

10/6/2017