Return a list of all photos in gallery defined by parameter sid.
API version
1.0
Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/getGallery?sid=bdV9KFX26z7zcP5Whjbjnw&withmeta=true
Parameter
Name | Type | Since version | Required | Value(s) |
---|---|---|---|---|
sid | string | 7.4 | yes | Unique sid returned by getSharedGallerys or by the Web-GUI function share photos |
withmeta | boolean | 7.4 | no | default=false if true the photos array in result will be filled if gallery has Permission to view photo metadata (pap:access:metadata) |
Result
mime type | application/json |
---|---|
content | Metadata of Gallery |
http status codes |
|
Result:JSON
Name | Type | Since version | Value | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sid | string | 7.4 | Unique sid of this gallery returned by getSharedGallerys or by the Web-GUI function share photos | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uid | string | 7.4 | Internal picapport user-ID used for this gallery | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | 7.4 | Name of this gallery | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | 7.4 | Description text (Can be edited with the PicApport Web-GUI user management) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
count | int | 7.4 | Number of images (or files) in gallery | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexmarked | int | 7.4 | Index of the first marked photo when the gallery was created. This can be used to create a title image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created | date | 7.4 | Timestamp when this gallery has been created. Format: yyyy-mm-dd hh:mm:ss | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expires | date | 7.4 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
photos | array | 7.4 | Optional array. photos will only be available if the user account for the gallery has the following permission:
If available each array element has the following members
|