checkPhotoId

This function is currently under development and will be available with the release of Version 8.3 in Summer 2020

Check if a photo with photoid exists. Requires parameters apisid and photoid.

API version

1.0

Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/checkPhotoId?photoid=vm3%2BZ4%2FGQcOqLNWCOUWleA

Parameter to identify the photo

apisidstring8.3yes

 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.
photoidstring8.3yes

A valid photo id to uniquely identify a photo. see: PhotoID on page Full text search of photos – Supported metadata – PicApport Wiki (contecon.de)

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

  • %2B for ‚+‘
  • %2F for ‚/‘

You can also use JavaScripts encodeURIComponent() function.

For some examples of using photoid see also photoid on URL Parameter to identify a photo – PicApport Wiki (contecon.de)

Result

mime typeapplication/json
contentInformation if photo exits. Permission required:  Permission to upload files (pap:access:uploads)
http status codes
  • 200 OK
  • 400 Bad Request
  • 403 Forbidden
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not implemented

Result:JSON

photoIDstring8.3„iILNtIMuSPaSWorMlHVpXA“
unique PicApport photo ID
existsboolean8.3
  • true if photo with requested ID exists
  • false if not
alreadySyncedboolean9.1.04
  • true if photo with requested ID has already been transferred with photosync
    (ID exists in syncedPhotoIDs.txt)
  • false if not