Convention Image

Images that you want to display or use in various locations around your Convention. You must have the exhibitors or registration or scheduling or updates ConventionPrivilege to access this. ConventionImages are accessed via /api/conventionimage.

Properties

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

Complete details in ConventionImageProperties. 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.

convention

The Convention this conventionimage belongs to.

Services

The services used to fetch and manipulate convention images.

Search Convention Images

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/conventionimage

Optional Params

query

Searches a partial name.

Returns:

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

Create / Upload Convention Image

 POST /api/conventionimage

Required Params

convention_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 Convention Image

 GET /api/conventionimage/xxx

Returns:

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

Update Convention Image

 PUT /api/conventionimage/xxx

Returns the same as a normal read.

Delete Convention Image

 DELETE /api/conventionimage/xxx

Returns:

 {
   "success" : 1
 }