osapi.jive.corev3.places.Member
A social group member. Represents one Person
's membership to one Group
.
Example:
Example JSON
JSON with the most important data for a Member. See the table below for a list of all fields.
{ "type" : "member", "state" : "owner", "group" : { "type" : "group", "memberCount" : 1, "creator" : { "name" : { "formatted" : "Administrator" }, "type" : "person", "displayName" : "Administrator", "id" : "1" }, "groupType" : "PRIVATE", "name" : "Group created on Fri Jul 20 2012 15:46:56 GMT-0700 (Pacific Daylight Time) using v3 API 135109", "displayName" : "group1342824416138842803", "status" : "Active", "contentTypes" : [ "blog", "documents", "files", "discussions", "polls", "projects" ], "viewCount" : 0, "published" : "2012-07-20T22:42:20.234+0000", "updated" : "2012-07-20T22:42:20.234+0000", "visibleToExternalContributors" : false, "tags" : [ ], "followerCount" : 1 }, "person" : { // Person JSON appears here } }
Properties
Property | Type | Mode † | Description |
---|---|---|---|
group | Group | read-only | ↑ Group to which this member belongs. |
id | String | read-only | ↑ Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs. |
person | Person | read-only | ↑ Jive person that is a member of the specified group. |
published | ISO 8601 Date | read-only | ↑ Date and time this object was originally created. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
state | String | required | ↑ Current state of this membership. Valid values are:
|
type | String | read-only | ↑ The object type of this object ("member"). |
typeCode | Integer | read-only | ↑ |
updated | ISO 8601 Date | read-only | ↑ Date and time this object was most recently updated. |
Methods
get(options)
GET /members/1234
Retrieves
Member
Description
Return an updated version of this membership.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
Retrieves:
toURI()
Retrieves
String