{"id":1344,"date":"2024-03-13T11:13:42","date_gmt":"2024-03-13T10:13:42","guid":{"rendered":"https:\/\/contecon.de\/picapportwiki\/?page_id=1344"},"modified":"2024-05-23T18:30:45","modified_gmt":"2024-05-23T16:30:45","slug":"getoriginalfile","status":"publish","type":"page","link":"https:\/\/contecon.de\/picapportwiki\/getoriginalfile\/","title":{"rendered":"getOriginalFile"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-page\" data-elementor-id=\"1344\" class=\"elementor elementor-1344\">\n\t\t\t\t<div class=\"elementor-element elementor-element-768ac81 e-flex e-con-boxed e-con e-parent\" data-id=\"768ac81\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\" data-core-v316-plus=\"true\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-e40f6ae elementor-widget elementor-widget-heading\" data-id=\"e40f6ae\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.19.0 - 07-02-2024 *\/\n.elementor-heading-title{padding:0;margin:0;line-height:1}.elementor-widget-heading .elementor-heading-title[class*=elementor-size-]>a{color:inherit;font-size:inherit;line-height:inherit}.elementor-widget-heading .elementor-heading-title.elementor-size-small{font-size:15px}.elementor-widget-heading .elementor-heading-title.elementor-size-medium{font-size:19px}.elementor-widget-heading .elementor-heading-title.elementor-size-large{font-size:29px}.elementor-widget-heading .elementor-heading-title.elementor-size-xl{font-size:39px}.elementor-widget-heading .elementor-heading-title.elementor-size-xxl{font-size:59px}<\/style><h2 class=\"elementor-heading-title elementor-size-default\">getOriginalFile<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-50baa8d elementor-widget elementor-widget-text-editor\" data-id=\"50baa8d\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.19.0 - 07-02-2024 *\/\n.elementor-widget-text-editor.elementor-drop-cap-view-stacked .elementor-drop-cap{background-color:#69727d;color:#fff}.elementor-widget-text-editor.elementor-drop-cap-view-framed .elementor-drop-cap{color:#69727d;border:3px solid;background-color:transparent}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap{margin-top:8px}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap-letter{width:1em;height:1em}.elementor-widget-text-editor .elementor-drop-cap{float:left;text-align:center;line-height:1;font-size:50px}.elementor-widget-text-editor .elementor-drop-cap-letter{display:inline-block}<\/style>\t\t\t\t<p>Return the original-file of the requested photo. (e.g. the original .jpg file or a pdf or video if a plugin is installed)<\/p><h3 id=\"getOriginalFile-APIversion\">API version<\/h3><p>1.0<\/p><p>Working example URL: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getOriginalFile?sid=bdV9KFX26z7zcP5Whjbjnw&amp;index=12\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getOriginalFile?sid=bdV9KFX26z7zcP5Whjbjnw&amp;index=12<\/a><\/p><h3 id=\"getOriginalFile-RequiredPermissions\">Required Permissions<\/h3><p>The userID used for this request (lnk* for shared photos) must have the following permission:<\/p><ul><li>Keep original metadata of .jpg files in downloads. (<strong><em>pap:access:downloadswithmetadata<\/em><\/strong>)<\/li><\/ul><h3 id=\"getOriginalFile-Parametertoidentifythefile\">Parameter to identify the file<\/h3><p>\u00a0<\/p><div class=\"table-wrap conf-macro output-block\" data-hasbody=\"false\" data-macro-name=\"include\"><table class=\"confluenceTable stickyTableHeaders\"><thead class=\"tableFloatingHeaderOriginal\"><tr><th class=\"confluenceTh\">Name<\/th><th class=\"confluenceTh\">Type<\/th><th class=\"confluenceTh\">Since<br \/>version<\/th><th class=\"confluenceTh\">Required<\/th><th class=\"confluenceTh\">Value(s)<\/th><\/tr><\/thead><thead class=\"tableFloatingHeader\"><tr><th class=\"confluenceTh\">Name<\/th><th class=\"confluenceTh\">Type<\/th><th class=\"confluenceTh\">Since<br \/>version<\/th><th class=\"confluenceTh\">Required<\/th><th class=\"confluenceTh\">Value(s)<\/th><\/tr><\/thead><tbody><tr><td class=\"highlight-blue confluenceTd\" colspan=\"5\" data-highlight-colour=\"blue\"><p>Option1: get photo from a shared gallery<\/p><\/td><\/tr><tr><td class=\"confluenceTd\">sid<\/td><td class=\"confluenceTd\">string<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\">ShareID. Unique <em><strong>sid<\/strong> <\/em>returned by <em>getSharedGallerys <\/em>or by the Web-GUI function <strong><em>share photos<\/em><\/strong><\/td><\/tr><tr><td class=\"confluenceTd\">index<\/td><td class=\"confluenceTd\">int<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\">Zero based index of requested photo in shared gallery.<\/td><\/tr><tr><td class=\"highlight-green confluenceTd\" colspan=\"5\" data-highlight-colour=\"green\"><p>Option2: get photo from an already executed <em>runQuery<\/em><\/p><\/td><\/tr><tr><td class=\"confluenceTd\">apisid<\/td><td class=\"confluenceTd\">string<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\"><p>Based on the setting of <em><strong>webapi.default.uid<\/strong><\/em> in picapport.properties you may provide one of the following values<\/p><ul><li>Session-ID returned from <em>createWebApiSession <\/em><p>\u00a0<\/p><\/li><li>If you do not provide <em><strong>apisid<\/strong> <\/em>and configuration parameter <em><strong>webapi.default.uid<\/strong><\/em> is set to a valid userid (with same password)<br \/>a WebApi-Session will be created implicitly for the defined user.<\/li><li>If an existing userID is provided (with password set to same value as userID ) a WebApi-Session will be created implicitly<br \/>for the defined userID.<\/li><\/ul><\/td><\/tr><tr><td class=\"confluenceTd\">vid<\/td><td class=\"confluenceTd\">int<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\">ViewID returned from <em>runQuery<\/em><\/td><\/tr><tr><td class=\"confluenceTd\">index<\/td><td class=\"confluenceTd\">int<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\">Zero based index of requested photo in view returned by <em>runQuery<\/em><\/td><\/tr><tr><td class=\"highlight-green confluenceTd\" colspan=\"5\" data-highlight-colour=\"green\">Option3: get a single photo from a unique photoID<\/td><\/tr><tr><td class=\"confluenceTd\">apisid<\/td><td class=\"confluenceTd\">string<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\">desciption see above option2<\/td><\/tr><tr><td class=\"confluenceTd\" colspan=\"1\">photoid<\/td><td class=\"confluenceTd\" colspan=\"1\">string<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">yes<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>A valid photo id to uniquely identify a photo. see: <em><strong>PhotoID<\/strong> <\/em>on page <a href=\"https:\/\/contecon.de\/picapportwiki\/full-text-search-of-photos-supported-metadata\/\">Full text search of photos &#8211; Supported metadata<\/a><\/p><p>If <em><strong>photoid<\/strong> <\/em>is provided as parameter, <strong><em>vid<\/em> <\/strong>and <em><strong>index<\/strong> <\/em>will be ignored even if they are provided<\/p><p>Since version 7.4 you can query the photoid in the thumbnail view. Select one or more photos and then menu: tags -&gt; &#8222;show metadata details&#8220;<\/p><div class=\"confluence-information-macro confluence-information-macro-note conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"note\"><div class=\"confluence-information-macro-body\"><p>Because the photoid is a base64 encoded String it may contain &#8218;+&#8216; or &#8218;\/&#8216; characters. The proper escaping for the URL is:<\/p><ul><li>%2B for &#8218;+&#8216;<\/li><li>%2F for &#8218;\/&#8216;<\/li><\/ul><p>You can also use JavaScripts <em><strong>encodeURIComponent()<\/strong><\/em> function.<\/p><p>See examples below<\/p><\/div><\/div><\/td><\/tr><tr><td class=\"confluenceTd\" colspan=\"5\"><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 <em><strong>webapi.default.uid<\/strong><\/em> or a valid userID for apisid<\/p><h3 id=\"getOriginalFile-Examples\">Examples<\/h3><ul><li>Get photo metadata of a photo: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getPhotoMetadata?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getPhotoMetadata?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA<\/a><\/li><li>Get photo: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getPhoto?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getPhoto?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA<\/a><\/li><li>get thumbnail: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getThumbnail?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getThumbnail?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA<\/a><\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/div><p>\u00a0<\/p><h3 id=\"getOriginalFile-Result\">Result<\/h3><div class=\"table-wrap\"><table class=\"confluenceTable\"><thead><tr><th class=\"confluenceTh\">mime type<\/th><td class=\"confluenceTd\">depends on requested resource (file)<\/td><\/tr><\/thead><tbody><tr><th class=\"confluenceTh\">content<\/th><td class=\"confluenceTd\">requested resource (file)<\/td><\/tr><tr><th class=\"confluenceTh\" colspan=\"1\">http status codes<\/th><td class=\"confluenceTd\" colspan=\"1\"><ul><li>200 OK<\/li><li>400 Bad Request<\/li><li>403 Forbidden<\/li><li>404 Not Found<\/li><li>500 Internal Server Error<\/li><li>501 Not implemented<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/div><p>\u00a0<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-6c4496d e-flex e-con-boxed e-con e-parent\" data-id=\"6c4496d\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\" data-core-v316-plus=\"true\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>getOriginalFile Return the original-file of the requested photo. (e.g. the original .jpg file or a pdf or video if a plugin is installed) API version 1.0 Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getOriginalFile?sid=bdV9KFX26z7zcP5Whjbjnw&amp;index=12 Required Permissions The userID used for this request (lnk* for shared photos) must have the following permission: Keep original metadata of .jpg files in downloads. [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1344","page","type-page","status-publish","hentry","entry"],"_links":{"self":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1344","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/comments?post=1344"}],"version-history":[{"count":7,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1344\/revisions"}],"predecessor-version":[{"id":2151,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1344\/revisions\/2151"}],"wp:attachment":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/media?parent=1344"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}