Event Album In List

OpenAPI Schema

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

{
  "description": "An event album as viewed from a collection.",
  "properties": {
    "albumPassword": {
      "description": "The event album password.",
      "maxLength": 30,
      "readOnly": 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": [
        {
          "$ref": "#/components/schemas/CoverPhoto"
        },
        {
          "nullable": true
        }
      ],
      "description": "A cover photo for the event album."
    },
    "created": {
      "description": "The creation date of this event album.",
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "The identifier for this event album.",
      "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 parent album of this event album.",
      "nullable": true,
      "readOnly": 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",
    "links",
    "id",
    "name",
    "coverPhoto",
    "created"
  ],
  "title": "Event Album",
  "type": "object"
}