Return the jpg-file of the thumbnail of requested photo.
The size of the thumbnail depend on the thumbs.height parameter in picapport.properties (default=160 pixel)
API version
1.0
Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/getThumbnail?sid=bdV9KFX26z7zcP5Whjbjnw&index=12
Parameter to identify the photo
| Name | Type | Since version | Required | Value(s) |
|---|---|---|---|---|
Option1: get photo from a shared gallery | ||||
| sid | string | 7.4 | yes | ShareID. Unique sid returned by getSharedGallerys or by the Web-GUI function share photos |
| index | int | 7.4 | yes | Zero based index of requested photo in shared gallery. |
Option2: get photo from an already executed runQuery | ||||
| apisid | string | 7.4 | yes |
Based on the setting of webapi.default.uid in picapport.properties you may provide one of the following values
|
| vid | int | 7.4 | yes | ViewID returned from runQuery |
| index | int | 7.4 | yes | Zero based index of requested photo in view returned by runQuery |
| Option3: get a single photo from a unique photoID | ||||
| apisid | string | 7.4 | yes | desciption see above option2 |
| photoid | string | 7.4 | yes | A valid photo id to uniquely identify a photo. see: PhotoID on page Full text search of photos - Supported metadata If photoid is provided as parameter, vid and index will be ignored even if they are provided Since version 7.4 you can query the photoid in the thumbnail view. Select one or more photos and then menu: tags -> "show metadata details" Because the photoid is a base64 encoded String it may contain '+' or '/' characters. The proper escaping for the URL is:
You can also use JavaScripts encodeURIComponent() function. See examples below |
With this option3 it is now possible to directly link to a photo in PicApport without having to deal with sessions etc. if you provide a webapi.default.uid or a valid userID for apisid Examples
| ||||
Result
| mime type | image/jpeg |
|---|---|
| content | requested image |
| http status codes |
|