Group Image

Upload images that are tied to a specific Group. Group Images are accessed via /api/groupimage.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in GroupImageProperties. It also has these extra read-only properties:

image_uri

A link to the location where the image is stored, minus the protocol (ie https).

thumbnail_uri

A link to the location where a thumnail of the image is stored, minus the protocol (ie https).

Related Objects

See "Related Objects" in Introduction for how to use them.

group

The Group this group image belongs to.

Services

The services used to fetch and manipulate group images.

Search Group Images

 GET /api/groupimage

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "filename" : "pic.jpg",
          ...
        },
        ...
    ]
 }

Create / Upload Group Image

 POST /api/groupimage

Required Params

group_id

file

This is a special field that only exists for uploading the image. It should be an encoded image in the POST body as multipart/form-data as specified in RFC-2388 (https://tools.ietf.org/html/rfc2388).

Optional Params

noresize

When you upload the image it will automatically be resized to 700px wide maintaining its aspect ratio. If you don't want a resize to occur then set this field to 1.

Returns the same as a normal read.

Read Group Image

 GET /api/groupimage/xxx

Returns:

 {
   "id" : "xxx",
   "filename" : "pic.jpg",
   ...
 }

Update Group Image

 PUT /api/groupimage/xxx

Returns the same as a normal read.

Delete Group Image

 DELETE /api/groupimage/xxx

Returns:

 {
   "success" : 1
 }