{"id":1369,"date":"2024-03-13T11:22:16","date_gmt":"2024-03-13T10:22:16","guid":{"rendered":"https:\/\/contecon.de\/picapportwiki\/?page_id=1369"},"modified":"2024-05-23T18:34:22","modified_gmt":"2024-05-23T16:34:22","slug":"getthumbnail","status":"publish","type":"page","link":"https:\/\/contecon.de\/picapportwiki\/getthumbnail\/","title":{"rendered":"getThumbnail"},"content":{"rendered":"\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

getThumbnail<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Return the jpg-file of the thumbnail of requested photo.<\/p>

The size of the thumbnail depend on the thumbs.height<\/strong><\/em> parameter in picapport.properties (default=160 pixel)<\/p>

API version<\/h3>

1.0<\/p>

Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getThumbnail?sid=bdV9KFX26z7zcP5Whjbjnw&index=12<\/a><\/p>

Parameter to identify the photo<\/h3>
Name<\/th>Type<\/th>Since
version<\/th>		Required<\/th>Value(s)<\/th><\/tr><\/thead>
Name<\/th>Type<\/th>Since
version<\/th>		Required<\/th>Value(s)<\/th><\/tr><\/thead>

Option1: get photo from a shared gallery<\/p><\/td><\/tr>

sid<\/td>string<\/td>7.4<\/td>yes<\/td>ShareID. Unique sid<\/strong> <\/em>returned by getSharedGallerys <\/em>or by the Web-GUI function share photos<\/em><\/strong><\/td><\/tr>
index<\/td>int<\/td>7.4<\/td>yes<\/td>Zero based index of requested photo in shared gallery.<\/td><\/tr>

Option2: get photo from an already executed runQuery<\/em><\/p><\/td><\/tr>

apisid<\/td>string<\/td>7.4<\/td>yes<\/td>

Based on the setting of webapi.default.uid<\/strong><\/em> in picapport.properties you may provide one of the following values<\/p>

  • Session-ID returned from createWebApiSession<\/em><\/em>

    \u00a0<\/p><\/li>

  • If you do not provide apisid<\/strong> <\/em>and configuration parameter webapi.default.uid<\/strong><\/em> is set to a valid userid (with same password)
    a WebApi-Session will be created implicitly for the defined user.<\/li>
  • If an existing userID is provided (with password set to same value as userID ) a WebApi-Session will be created implicitly
    for the defined userID.<\/li><\/ul><\/td><\/tr>
vid<\/td>int<\/td>7.4<\/td>yes<\/td>ViewID returned from runQuery<\/em><\/td><\/tr>
index<\/td>int<\/td>7.4<\/td>yes<\/td>Zero based index of requested photo in view returned by runQuery<\/em><\/td><\/tr>
Option3: get a single photo from a unique photoID<\/td><\/tr>
apisid<\/td>string<\/td>7.4<\/td>yes<\/td>desciption see above option2<\/td><\/tr>
photoid<\/td>string<\/td>7.4<\/td>yes<\/td>

A valid photo id to uniquely identify a photo. see: PhotoID<\/strong> <\/em>on page Full text search of photos – Supported metadata<\/a><\/p>

If photoid<\/strong> <\/em>is provided as parameter, vid<\/em> <\/strong>and index<\/strong> <\/em>will be ignored even if they are provided<\/p>

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“<\/p>

Because the photoid is a base64 encoded String it may contain ‚+‘ or ‚\/‘ characters. The proper escaping for the URL is:<\/p>

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<\/strong><\/em> or a valid userID for apisid<\/p>

Examples<\/h3>