API Reference

Groups.getGroup

Returns group information for a specific group ID.


Syntax

array groups.getGroup ( int groupId )

Arguments

NameTypeRequiredDefault valueDescription
groupIdintRequirednoneThe ID of the group that you want information about.

Response

The response items returned in a groups.getGroups service call.

NameTypeDescriptionPossible Values
idINTThe ID of the group.INT
nameSTRINGThe name of the group.STRING
descriptionSTRINGA brief blurb about the group. History, purpose, location, ideas, awards, etc. The description is searchable.STRING
noteSTRINGSome text about the group. The note is not searchable.STRING
logoINTThe media ID that is used as the group logo.INT
logo_heightINTThe original height of the media being used for the logo.INT
logo_widthINTThe original width of the media being used for the logo.INT
publicUrlSTRINGThe url to access the group logo. The public url will log a hit against the media item when ever loaded. This would be best used on a group details page.STRING
thumbUrlSTRINGThe url to access the group logo. The thumb url will _NOT_ log a hit against the media item when loaded. This is best used in group galleries or plotting groups on a map.STRING
urlSTRINGThe url of the group. This is used best if the group is for a company, an event with a unique url they wish to also direct traffic to.STRING
createdYYYY-MM-DD HH:mm:SSThe date the group was created.YYYY-MM-DD HH:mm:SS
createdByINTThe user ID of the user who created the group.INT
memberCountINTThe number of members in the group.INT
mediaCountINTThe number of media items in the group.INT
approvedMediaCountINTThe number of approved media items in the group.INT
notDeniedMediaCountINTThe number of not denied media items in the group.INT
commentCountINTThe number of comments in the group.INT
approvedCommentCountINTThe number of approved comments in the group.INT
notDeniedCommentCountINTThe number of not denied comments in the group.INT
geo_longitudeLNGThe longitude of the group. This would be specified by the creator of the group.NUMBER (-52.44)
geo_latitudeLATThe latitude of the group. This would be specified by the creator of the group.NUMBER (62.86)
moderationStatusSTRINGThe moderation status of the group which has just been created. By default if this is not passed the groups moderationstatus will be unmoderated.accepted, denied, unmoderated, moderated, notdenied, all
parentGroupINTThe ID of the parent group if the current group is a child.INT
addressSTRINGThe address of the group.STRING
citySTRINGThe city that the group is located in.INT
countrySTRINGThe country that the group is located in. This will be a 2-letter country code.STRING
stateSTRINGThis will be the state/province that the group is located in. It will be a 2-letter state/province code.STRING
postalcodeSTRINGA valid postal code to contact the group by.STRING
newMediaEmailTemplateIDINTThis is the ID of the email template that is sent out when a user uploads media into the group.INT
hostSTRINGThe name of the host who created the group or who is in charge of the group.STRING
groupTypeINTThis specifies if the group is a group or an event. 1 represents a group, 2 represents an event and 3 represents an assignment.1, 2, 3
vhostINTThe vhost ID that the group belongs to.INT
otherARRAYAn associated array that is used to store any additional information about the group that does not fit in any previous fields. This field is _NOT_ searchable or filterable. This is equivalent to the metadata field for media.ARRAY
custom1STRINGA searchable and filterable field for any additional information that does not fit into any previous field.STRING
treeleftINTUsed internally for the sorting and ordering groups.INT
treerightINTUsed internally for the sorting and ordering groups.INT
emailSTRINGThe email address to use to allow users to email content to this email address and have it uploaded and entered into the group.STRING
totalCountINTIf the includeTotalCount argument is set to true the total count of groups returned will be included in the response.INT

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/media/getGroup?groupId=[MID]&APIKEY=[APIKEY]
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <id>GROUP_ID</id>
  <name>GROUP_NAME</name>
  <description>This is a description field to briefly describe what exactly the API Reference is for and how it should be used.</description>
  <note/>
  <logo>0</logo>
  <logo_height>0</logo_height>
  <logo_width>0</logo_width>
  <publicUrl/>
  <thumbUrl/>
  <url/>
  <created>2012-01-20 12:12:46</created>
  <createdBy>USER_ID</createdBy>
  <memberCount>0</memberCount>
  <mediaCount>0</mediaCount>
  <approvedMediaCount>0</approvedMediaCount>
  <notDeniedMediaCount>0</notDeniedMediaCount>
  <geo_longitude>0</geo_longitude>
  <geo_latitude>0</geo_latitude>
  <moderationStatus>unmoderated</moderationStatus>
  <parentGroup>PARENT_GROUP</parentGroup>
  <address/>
  <city/>
  <country/>
  <state/>
  <postalcode/>
  <newMediaEmailTemplateID>0</newMediaEmailTemplateID>
  <host/>
  <groupType>1</groupType>
  <vhost>VHOSTID</vhost>
  <other>
    <key>value</key>
  <other/>
  <custom1>api</custom1>
  <treeleft>12</treeleft>
  <treeright>39</treeright>
  <email/>
</result>

Sample JSON Response
{
    "status": true,
    "result": {
        "id": "GROUP_ID",
        "name": "GROUP_NAME",
        "description": "This is a description field to briefly describe what exactly the API Reference is for and how it should be used.",
        "note": "",
        "logo": "0",
        "logo_height": "0",
        "logo_width": "0",
        "publicUrl": "",
        "thumbUrl": "",
        "url": "",
        "created": "2012-01-20 12:12:46",
        "createdBy": "USER_ID",
        "memberCount": "0",
        "mediaCount": "0",
        "approvedMediaCount": "0",
        "notDeniedMediaCount": "0",
        "geo_longitude": "0",
        "geo_latitude": "0",
        "moderationStatus": "unmoderated",
        "parentGroup": "PARENT_GROUP_ID",
        "address": "",
        "city": "",
        "country": "",
        "state": "",
        "postalcode": "",
        "newMediaEmailTemplateID": "0",
        "host": "",
        "groupType": "1",
        "vhost": "VHOSTID",
        "other": {
            "key": "value"
        },
        "custom1": "api",
        "treeleft": "12",
        "treeright": "39",
        "email": ""
    }
}

Code examples

0 comments

Be the first to comment on getGroup.

Add a Comment

  • captcha