{"id":1379,"date":"2024-03-13T11:29:21","date_gmt":"2024-03-13T10:29:21","guid":{"rendered":"https:\/\/contecon.de\/picapportwiki\/?page_id=1379"},"modified":"2024-03-13T11:33:47","modified_gmt":"2024-03-13T10:33:47","slug":"runquery","status":"publish","type":"page","link":"https:\/\/contecon.de\/picapportwiki\/runquery\/","title":{"rendered":"runQuery"},"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

runQuery<\/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

Run a PicApport query inside of a WebApi-Session that has previously created with\u00a0createWebApiSession<\/em>.<\/p>

Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/runQuery?query=animals<\/a><\/p>

API version<\/h3>

1.0<\/p>

Parameter<\/h3>
\u00a0<\/div>
apisid<\/td>string<\/td>7.4<\/td>yes<\/td>\u00a0<\/em>Based on the setting of webapi.default.uid<\/strong><\/em> in picapport.properties you may provide one of the following values<\/span>
  • Session-ID returned from createWebApiSession

    <\/em><\/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>
query<\/td>string<\/td>7.4<\/td>yes<\/td>

A valid PicApport query. see: http:\/\/onlinedemo.picapport.de:8080\/picapport#help<\/a><\/p>

Because PicApport query may contain special characters make sure that you URL are properly encoded e.g wig the JavaScript function encodeURIComponent()<\/strong><\/em><\/p><\/div><\/div><\/td><\/tr><\/tbody><\/table><\/div>

Result<\/h3>
mime type<\/th>application\/json<\/td><\/tr><\/thead>
content<\/th>Session token to identify the authorized session and an information to access the photos<\/td><\/tr>
http status codes<\/th>
  • 200 OK<\/li>
  • 400 Bad Request<\/li>
  • 403 Forbidden<\/li>
  • 404 Not Found<\/li>
  • 500 Internal Server Error<\/li>
  • 501 Not implemented<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/div>

    Result:JSON<\/h3>
    \u00a0<\/div>
    apisid<\/td>string<\/td>7.4<\/td>Session-ID returned from createWebApiSession<\/em><\/td><\/tr>
    vid<\/td>int<\/td>7.4<\/td>A view id to identify the query<\/td><\/tr>
    count<\/td>int<\/td>7.4<\/td>Number of photos found for the query<\/td><\/tr><\/tbody><\/table>\t\t\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
    \n\t\t\t\t\t
    \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":"

    runQuery Run a PicApport query inside of a WebApi-Session that has previously created with\u00a0createWebApiSession. Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/runQuery?query=animals API version 1.0 Parameter \u00a0 apisid string 7.4 yes \u00a0Based on the setting of webapi.default.uid in picapport.properties you may provide one of the following values Session-ID returned from createWebApiSession If you do not provide apisid and configuration […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ocean_front_end_style_editor":"no","ocean_post_layout":"full-screen","ocean_both_sidebars_style":"","ocean_both_sidebars_content_width":0,"ocean_both_sidebars_sidebars_width":0,"ocean_sidebar":"","ocean_second_sidebar":"","ocean_disable_margins":"enable","ocean_add_body_class":"","ocean_shortcode_before_top_bar":"","ocean_shortcode_after_top_bar":"","ocean_shortcode_before_header":"","ocean_shortcode_after_header":"","ocean_has_shortcode":"","ocean_shortcode_after_title":"","ocean_shortcode_before_footer_widgets":"","ocean_shortcode_after_footer_widgets":"","ocean_shortcode_before_footer_bottom":"","ocean_shortcode_after_footer_bottom":"","ocean_display_top_bar":"off","ocean_display_header":"default","ocean_header_style":"","ocean_center_header_left_menu":"","ocean_custom_header_template":"","ocean_custom_logo":0,"ocean_custom_retina_logo":0,"ocean_custom_logo_max_width":0,"ocean_custom_logo_tablet_max_width":0,"ocean_custom_logo_mobile_max_width":0,"ocean_custom_logo_max_height":0,"ocean_custom_logo_tablet_max_height":0,"ocean_custom_logo_mobile_max_height":0,"ocean_header_custom_menu":"","ocean_menu_typo_font_family":"","ocean_menu_typo_font_subset":"","ocean_menu_typo_font_size":0,"ocean_menu_typo_font_size_tablet":0,"ocean_menu_typo_font_size_mobile":0,"ocean_menu_typo_font_size_unit":"px","ocean_menu_typo_font_weight":"","ocean_menu_typo_font_weight_tablet":"","ocean_menu_typo_font_weight_mobile":"","ocean_menu_typo_transform":"","ocean_menu_typo_transform_tablet":"","ocean_menu_typo_transform_mobile":"","ocean_menu_typo_line_height":0,"ocean_menu_typo_line_height_tablet":0,"ocean_menu_typo_line_height_mobile":0,"ocean_menu_typo_line_height_unit":"","ocean_menu_typo_spacing":0,"ocean_menu_typo_spacing_tablet":0,"ocean_menu_typo_spacing_mobile":0,"ocean_menu_typo_spacing_unit":"","ocean_menu_link_color":"","ocean_menu_link_color_hover":"","ocean_menu_link_color_active":"","ocean_menu_link_background":"","ocean_menu_link_hover_background":"","ocean_menu_link_active_background":"","ocean_menu_social_links_bg":"","ocean_menu_social_hover_links_bg":"","ocean_menu_social_links_color":"","ocean_menu_social_hover_links_color":"","ocean_disable_title":"on","ocean_disable_heading":"default","ocean_post_title":"","ocean_post_subheading":"","ocean_post_title_style":"","ocean_post_title_background_color":"","ocean_post_title_background":0,"ocean_post_title_bg_image_position":"","ocean_post_title_bg_image_attachment":"","ocean_post_title_bg_image_repeat":"","ocean_post_title_bg_image_size":"","ocean_post_title_height":0,"ocean_post_title_bg_overlay":0.5,"ocean_post_title_bg_overlay_color":"","ocean_disable_breadcrumbs":"default","ocean_breadcrumbs_color":"","ocean_breadcrumbs_separator_color":"","ocean_breadcrumbs_links_color":"","ocean_breadcrumbs_links_hover_color":"","ocean_display_footer_widgets":"off","ocean_display_footer_bottom":"off","ocean_custom_footer_template":"","footnotes":""},"class_list":["post-1379","page","type-page","status-publish","hentry","entry"],"_links":{"self":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1379","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=1379"}],"version-history":[{"count":4,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1379\/revisions"}],"predecessor-version":[{"id":1384,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1379\/revisions\/1384"}],"wp:attachment":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/media?parent=1379"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}