Prototype Image

Upload images that are tied to a specific Prototype. You must have the prototypes ConventionPrivilege to manage this, or control an Prototype to manage images specific to that prototype. Prototype Images are accessed via /api/prototypeimage.

Properties

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

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

prototype

The Prototype this prototype image belongs to.

Services

The services used to fetch and manipulate prototype images.

Search Prototype Images

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

 GET /api/prototypeimage
Optional Params
query

Searches a partial name.

Returns:

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

Create / Upload Prototype Image

 POST /api/prototypeimage
Required Params
prototype_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 Prototype Image

 GET /api/prototypeimage/xxx

Returns:

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

Update Prototype Image

 PUT /api/prototypeimage/xxx

Returns the same as a normal read.

Delete Prototype Image

 DELETE /api/prototypeimage/xxx

Returns:

 {
   "success" : 1
 }