getGroupInfo

Returns detailed information about a single user group.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRGroupAPI	SRGroupAPI	GET, POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRGroupAPI?method=getGroupInfo &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &group_id=value [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRGroupAPI?method=getGroupInfo & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & group_id =value

Usage Notes

This method requires a valid group_id parameter and returns detailed information about the specified group.

Client API callers must be logged in and must be administrator users with appropriate Group Management rights. Server API callers must have "Group Management/Use Luminate Online Groups API" permission.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

group_id

Required. The unique identifier of the group to retrieve.

Type xsd:nonNegativeInteger.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

group_id

Required. The unique identifier of the group to retrieve.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getGroupInfoResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <groupInfo>
    <id>0</id>
    <name>Sample Group 1 Name</name>
    <description>Sample Group 1 Description</description>
    <createTimestamp>2016-02-01T09:43:53.882-06:00</createTimestamp>
    <modifyTimestamp>2016-02-01T09:43:53.882-06:00</modifyTimestamp>
    <lastBuildTimestamp>2016-02-01T09:43:53.882-06:00</lastBuildTimestamp>
    <statsUpdateTimestamp>2016-02-01T09:43:53.882-06:00</statsUpdateTimestamp>
    <groupMode>STATIC_REBUILDABLE</groupMode>
    <securityMode>ADMINISTRATOR</securityMode>
    <numMembers>2831</numMembers>
    <numActiveMembers>2279</numActiveMembers>
    <emailStats>
      <numHardBounce>0</numHardBounce>
      <numSoftBounce>0</numSoftBounce>
      <numOptedOut>0</numOptedOut>
      <numSendable>0</numSendable>
    </emailStats>
    <securityCategory>
      <id>1</id>
      <label>Sample Security Category</label>
    </securityCategory>
    <groupType>
      <id>334</id>
      <name>Sample Group Type</name>
    </groupType>
  </groupInfo>
</getGroupInfoResponse>

JSON response

{"getGroupInfoResponse":{"groupInfo":{"groupType":{"id":"334","name":"Sample Group Type"},"emailStats":{"numOptedOut":"0","numSendable":"0","numSoftBounce":"0","numHardBounce":"0"},"lastBuildTimestamp":"2016-02-01T09:43:53.882-06:00","securityCategory":{"id":"1","label":"Sample Security Category"},"modifyTimestamp":"2016-02-01T09:43:53.882-06:00","id":"0","createTimestamp":"2016-02-01T09:43:53.882-06:00","statsUpdateTimestamp":"2016-02-01T09:43:53.882-06:00","groupMode":"STATIC_REBUILDABLE","description":"Sample Group 1 Description","numActiveMembers":"2279","name":"Sample Group 1 Name","numMembers":"2831","securityMode":"ADMINISTRATOR"}}}

Comments

Submitted by BPM at 12:15 PM on March 27, 2014

This call relies on the Group Summary. This means that your data can be quite stale when polling non-rebuilding groups. I mean like MONTHS old.

Luminate Online