User Invitation

Description

An individual invitation to join a given group. The user can accept the invitation or decline the invitation.

Invitations are currently only to join groups but may be extended in the future to allow for other targetTypes. Developers should design their applications so that targetTypes is checked and unknown targetTypes are ignored.

Invitations are also currently only sent to usernames. This is determined by the type property of the invitation. In the future, other types of invitations may be introduced. Developers should design their applications to make sure they check type and ignore unknown types.

Request Parameters

Parameter

Details

[Common Parameters]

For a complete listing, see Common parameters.

Response Properties

Property

Details

invitation id

The ID of the invitation.

targetType

The type of invitation. For now, this will only be set to group, but other types may be added in the future.

targetId

The ID of the group (if targetType is set to group) that the user is invited to join.

received

The date received. Shown in UNIX time in milliseconds.

role

The role that the invitee will have in the group, either group_member or group_admin.

expiration

Expiration of the invitation. Shown in UNIX time in milliseconds.

type

For now, always set to "user." In the future, the type may include other types of invitations.

created

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

username

The name of the user receiving the invitation if the type is set to "user."

fromUsername

A JSON object about the user who sent the invitation. This includes their username and fullname.

group

The JSON object for the group the user is being invited to join. See the group properties for more details. On returned if the targetType is set to group.

Example Usage

URL for User Invitation

http://www.arcgis.com/sharing/rest/community/users/jsmith/invitations/G275a108c7d09472f93917d64bbf37d94

JSON Response Syntax

{
 "id": "<invitation id>",
  "targetType": "group",
  "targetId": "<group  id>",
  "received": date received shown in UNIX time,
  "accepted": true | false,
  "email": <invitee email>,
  "role": "group_member | group_admin",
  "type": "email | user",
  "expiration": <expiration date> shown in UNIX time,
  "created": <date created> shown in UNIX time,  "username": "<recipient username>",  "fromUsername": {
     "username": "<group owner username>"},"
     "full name": "<group owner full name>"
  },
  "group": {
    "id": "<group id>",
    "title": "<group title>",
    "isInvitationOnly": true | false,
    "owner": "<group owner username>",
    "description": "<description>",
    "snippet": "<summary>",
    "tags": [
      "<tag1>",
      "<tag2>",
      "<tag3>"
 ],
    "phone": "<contact>",

    "thumbnail": file name,
    "created": date created shown in UNIX time,
    "modified": date modified shown in UNIX time,
	 "access": "private | org |  public" 
  }
}

JSON Response Example

{
  "id": "G275a108c7d09472f93917d64bbf37d94",
  "targetType": "group",
  "targetId": "6cd148dffe0f44c69aa39a787a2357db",
  "received":1330126012000,
  "accepted": false,
  "email": jsmith@esri.com,
  "role": "group_member",
  "type": "user",
  "expiration": 1331335612000,
  "created": 1330126012000,  "username": "jsmith",  "fromUsername": {
    "username": "mjohnson"},
    "fullname": "Michelle Johnson"
  },
  "group": {
    "id": "6cd148dffe0f44c69aa39a787a2357db",
    "title": "Metro routes",
    "isInvitationOnly": false,
    "owner": "mjohnson",
    "description": "View the Metro transportation routes for Southern California.",
    "snippet": "Metro maps",
    "tags": [
      "Metro routes",
      "public transportation",
      "Southern California"
 ],
    "phone": "http://www.esri.com",
    "thumbnail": metro.jpg,
    "created": 1251142226000,
    "modified": 1268626808000,
	 "access": "public"

  }
}

7/5/2017