Event Album

Description

An event album.

To enumerate the child albums and photos of this album, see links.children.

Properties

Property Description
albumPassword nullable

A password that visitors must use to access the event album.

albumSortType

The type of sorting to apply to sub-albums of this album.

This affects only the sub-albums in this album and does not cascade down through to their sub-albums. To apply an album sort type to all sub-albums, use a batch update operation on an album collection resource or album children collection resource.

albumsCount read-only

The number of sub-albums in the event album.

coverPhoto required nullable read-only

A cover photo for the event album.

created read-only

The creation date of the event album.

digitalRules

Collection of digital rules available for this album. Digital rules describe configurations for free digitals downloads.

eventId read-only

The numeric identifier for the event to which this album belongs.

id read-only

The identifier for the event album.

isHidden

Whether the album has been marked 'hidden'.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The event album name.

parentAlbumId nullable

The identifier for the event album's parent album, if applicable.

photoSortType

The type of sorting to apply to photos in this album.

This affects only the photos in this album and does not cascade down through to sub-albums. To apply a photo sort type to all sub-albums, use a batch update operation on an album collection resource or album children collection resource.

photosCount read-only

The number of photos in the event album.

previousAlbumId nullable read-only

The numeric identifier for the album that precedes this album when the event.albumSortType or album.albumSortType for the event or album in which this album appears is set to custom.

If this album resource has a parentAlbumId, the previousAlbumId refers to the preceding album in the collection of sub-albums for the album. If this album resource does not have a parentAlbumId (i.e., it is null), the previousAlbumId refers to the preceding album in the collection of albums for the event identified by eventId.

If the albumSortType for the event or album in which this album appears is not set to custom, the previousAlbumId will be null. Likewise, if the albumSortType is custom and this is the first album in the sequence, the value of previousAlbumId will be null.

type

The type of object represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An event album.\n\nTo enumerate the child albums and photos of this album, see\n`links.children`.",
  "properties": {
    "albumPassword": {
      "description": "A password that visitors must use to access the event album.",
      "maxLength": 30,
      "nullable": true,
      "type": "string"
    },
    "albumSortType": {
      "default": "name-asc",
      "description": "The type of sorting to apply to sub-albums of this album.\n\nThis affects only the sub-albums in this album and does not cascade\ndown through to their sub-albums. To apply an album sort type to all\nsub-albums, use a batch update operation on an album collection\nresource or album children collection resource.",
      "enum": [
        "custom",
        "name-asc",
        "name-desc"
      ],
      "type": "string"
    },
    "albumsCount": {
      "description": "The number of sub-albums in the event album.",
      "readOnly": true,
      "type": "integer"
    },
    "coverPhoto": {
      "allOf": [
        {
          "nullable": true,
          "title": "Cover Photo"
        },
        {
          "$ref": "#/components/schemas/CoverPhoto"
        }
      ],
      "description": "A cover photo for the event album.",
      "readOnly": true
    },
    "created": {
      "description": "The creation date of the event album.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "digitalRules": {
      "description": "Collection of digital rules available for this album. Digital rules\ndescribe configurations for free digitals downloads.",
      "items": {
        "$ref": "#/components/schemas/DigitalRule"
      },
      "title": "Digital Rule",
      "type": "array"
    },
    "eventId": {
      "description": "The numeric identifier for the event to which this album belongs.",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "The identifier for the event album.",
      "readOnly": true,
      "type": "integer"
    },
    "isHidden": {
      "description": "Whether the album has been marked 'hidden'.",
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The event album name.",
      "maxLength": 50,
      "type": "string"
    },
    "parentAlbumId": {
      "description": "The identifier for the event album's parent album, if applicable.",
      "nullable": true,
      "type": "integer"
    },
    "photoSortType": {
      "default": "name-asc",
      "description": "The type of sorting to apply to photos in this album.\n\nThis affects only the photos in this album and does not cascade down\nthrough to sub-albums. To apply a photo sort type to all sub-albums,\nuse a batch update operation on an album collection resource or\nalbum children collection resource.",
      "enum": [
        "custom",
        "name-asc",
        "name-desc",
        "shootDate-asc",
        "shootDate-desc"
      ],
      "type": "string"
    },
    "photosCount": {
      "description": "The number of photos in the event album.",
      "readOnly": true,
      "type": "integer"
    },
    "previousAlbumId": {
      "description": "The numeric identifier for the album that precedes this album when\nthe `event.albumSortType` or `album.albumSortType` for the event or\nalbum in which this album appears is set to `custom`.\n\nIf this album resource has a `parentAlbumId`, the `previousAlbumId`\nrefers to the preceding album in the collection of sub-albums for\nthe album. If this album resource does not have a `parentAlbumId`\n(i.e., it is `null`), the `previousAlbumId` refers to the preceding\nalbum in the collection of albums for the event identified by\n`eventId`.\n\nIf the `albumSortType` for the event or album in which this album\nappears is not set to `custom`, the `previousAlbumId` will be\n`null`. Likewise, if the `albumSortType` is `custom` and this is the\nfirst album in the sequence, the value of `previousAlbumId` will be\n`null`.",
      "nullable": true,
      "readOnly": true,
      "type": "integer"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event-album"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name",
    "isHidden"
  ],
  "title": "Event Album",
  "type": "object"
}