Page tree
Skip to end of metadata
Go to start of metadata

Get the metadata of one photo in gallery defined by parameter sid and index.

API version

1.0

Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/getPhotoMetadata?sid=bdV9KFX26z7zcP5Whjbjnw&index=12

Parameter to identify the photo

NameTypeSince
version
RequiredValue(s)

Option1: get photo from a shared gallery

sidstring7.4yesShareID. Unique sid returned by getSharedGallerys or by the Web-GUI function share photos
indexint7.4yesZero based index of requested photo in shared gallery.

Option2: get photo from an already executed runQuery

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.

vidint7.4yesViewID returned from runQuery
indexint7.4yesZero based index of requested photo in view returned by runQuery
Option3: get a single photo from a unique photoID
apisidstring7.4yesdesciption see above option2
photoidstring7.4yes

A valid photo id to uniquely identify a photo. see: PhotoID on page Full text search of photos - Supported metadata

If photoid is provided as parameter, vid and index will be ignored even if they are provided

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"

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.

See examples below

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 or a valid userID for apisid

Examples

 

Result

mime typeapplication/json
contentMetadata of Photo if gallery has Permission to view photo metadata (pap:access:metadata)
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

Example
value
apertureValuestring7.4"f/22,0"
creationDatetimestamp7.4"2015-07-02T14:35:33"
creationYearint7.4

2015

exposureTimestring7.4"1/160 sec"
depends on camera
fileNamestring7.4"E:\\MyPhotos\\2015\\Demos\\DEV-5Y8A3042.jpg"
fingerprintstring7.4"EsYKL5SRzjpnxNFSWPPE"
PicApport fingerprint based on metadata
focalLengthstring7.4

"90,0 mm"
depends on camera

heightint7.43579
photo height in pixels
isoSpeedstring7.4"400"
depends on camera
lastUpdatetimestamp7.4"2017-07-27T17:22:39"
latitudestring7.4"49.560138333333335"
lensstring7.4"TAMRON SP 90mm"
depends on camera / lens
likesint7.40
number of likes
longitudestring7.4"8.249656666666667"
makestring7.4"Canon"
modelstring7.4"Canon EOS 7D Mark II"
personsstring array7.4["Maria Musterman", "Jack London"]
photoIDstring7.4"iILNtIMuSPaSWorMlHVpXA"
unique PicApport photo ID
ratingint7.43
rating from 0 to 5 (stars)
softwarestring7.4"Adobe Photoshop Lightroom 6.0 (Windows)"
tagsstring array7.4["Contecon", "PicApport", "Demo"]
textSearchstring7.4"jul contecon 5y8a3042 usd eos tamron jul02 ........"
titlestring7.4"Demo photo PicApport - title"
widthint7.4

2684
photo width in pixels

  • No labels