SYNO.PhotoStation.Album list

The list method returns a paginated list of items (photos, videos or albums) contained within a given album or matching a set of user defined queries.

Request

Standard Query

Standard queries list contents of a particular album. The only filtering is based on type.

Advanced Queries

With advanced queries, users may filter results based on:

• multiple album names
• keywords
• date ranges
• tags
• people
• location
• EXIF information

Each search type contains a value parameter and a corresponding operator parameter which determines how the query values are treated.

Query Values

NOTE: There are ignore and recursive parameters within the code base, but it does not appear they are implemented.

Query Operators

With the exception of date_op, the query operators determine whether all values are required to match or if any single term among the query values can match. The date_op operator determines which type of date is compared.

While the EXIF values (eg. camera, model, etc..) also have _op parameters (eg. camera_op) the only allowed value is any (the default), so they are not required.

Sample Response

Standard query of root album containing four child albums:

{
  "success": true,
  "data": {
    "total": 4,
    "offset": 4,
    "items": [
      {
        "info": {
          "sharepath": "2019",
          "name": "2019",
          "title": "2019",
          "description": "",
          "hits": 0,
          "type": "public",
          "conversion": true,
          "allow_comment": false,
          "allow_embed": true
        },
        "id": "album_32303139",
        "type": "album",
        "additional": null,
        "thumbnail_status": "small,large"
      },
      {
        "info": {
          "sharepath": "2019-08-25",
          "name": "2019-08-25",
          "title": "2019-08-25",
          "description": "",
          "hits": 0,
          "type": "private",
          "conversion": true,
          "allow_comment": false,
          "allow_embed": false
        },
        "id": "album_323031392d30382d3235",
        "type": "album",
        "additional": null,
        "thumbnail_status": "small,large"
      },
      {
        "info": {
          "sharepath": "iphone",
          "name": "iphone",
          "title": "iphone",
          "description": "",
          "hits": 0,
          "type": "private",
          "conversion": true,
          "allow_comment": false,
          "allow_embed": false
        },
        "id": "album_6970686f6e65",
        "type": "album",
        "additional": null,
        "thumbnail_status": "small,large"
      },
      {
        "info": {
          "sharepath": "other",
          "name": "other",
          "title": "other",
          "description": "",
          "hits": 0,
          "type": "private",
          "conversion": true,
          "allow_comment": false,
          "allow_embed": false
        },
        "id": "album_6f74686572",
        "type": "album",
        "additional": null,
        "thumbnail_status": "preview,small,large"
      }
    ]
  }
}

Pagination

The pagination of returned results is determined by the values of limit and offset. limit determines how many items to return in each query while offset determines the starting point for the current return set.

In order to fetch all matches from a list query, the following workflow should be followed:

• send request with offset=0
• receive response and examine returned total and offset values
• if total == offset, there are no more items to receive and the query is complete
• send request with offset equal to the value of offset returned in response
• repeat above until total == offset

Additional Information

The additional parameter returns additional optional information for the returned items based on the list of values provided. The available additional values vary based on the type of item as shown below:

Any additional value that is not compatible with a given item’s type will be silently ignored.

Errors

On error, list can return one of the following error values: