photo-documentation/docs/api/GetGroup.markdown

Get Group

---

1. Purpose
2. Endpoint
3. Parameters
4. Examples

• Command line
• PHP

1. Response

• Sample

---

Purpose of the Get Group API

Use this API to get a user's group.

---

Endpoint

Authentication: required

GET /group/:id/view.json

Parameters

None

---

Examples

Command Line (using openphoto-php)

source secrets.sh
./openphoto -p -h current.openphoto.me -e /group/d/view.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->get("/group/d/view.json");

---

Response

The response is in a standard response envelope.

• message, A string describing the result. Don't use this for anything but reading.
• code, 200 on success
• result, A Group object

Sample

{
  "message" : "Your group",
  "code" : 200,
  "result" : {
    "id" : "d",
    "Name" : "d",
    "name" : "Rachel and Jaisen",
    "members" : [
      "rachel.mathai@yahoo.com",
      "jaisen@jmathai.com"
    ],
    "appId" : "openphoto-frontend"
  }
}