Skip to end of metadata
Go to start of metadata

Run a PicApport query inside of a WebApi-Session that has previously created with createWebApiSession.

Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/runQuery?query=animals

API version

1.0

Parameter

NameTypeSince
version
RequiredValue(s)
apisidstring7.4yes Based 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 parameter webapi.default.uid is set to a valid userid (with same password)
    a WebApi-Session will be created implicitly for the defined user.

  • 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.
querystring7.4yes

A valid PicApport query. see: http://onlinedemo.picapport.de:8080/picapport#help

Because PicApport query may contain special characters make sure that you URL are properly encoded e.g wig the JavaScript function encodeURIComponent()

Result

mime typeapplication/json
contentSession token to identify the authorized session and an information to access the photos
http status codes
  • 200 OK
  • 400 Bad Request
  • 403 Forbidden
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not implemented

Result:JSON

NameType

Since
version

Value
apisidstring7.4Session-ID returned from createWebApiSession
vidint7.4A view id to identify the query
countint7.4Number of photos found for the query
  • No labels