Event Album Collection In Patch

OpenAPI Schema

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

{
  "description": "A collection of event albums to be updated.",
  "properties": {
    "items": {
      "description": "A collection of one or more batched resources. If `items` is `null`\nor an empty array, no action is taken.",
      "items": {
        "description": "A batch of changes to apply to one or more events albums.",
        "properties": {
          "albumPassword": {
            "description": "A password that visitors must use to access the event\nalbum.",
            "maxLength": 30,
            "nullable": true,
            "type": "string"
          },
          "albumSortType": {
            "description": "The type of sorting to apply to sub-albums of this album.\n\nIf this batch operation is not limited by an array of\nevent album identifiers, this will apply to all albums and\nsub-albums in the current collection.",
            "enum": [
              "custom",
              "name-asc",
              "name-desc"
            ],
            "type": "string"
          },
          "id": {
            "description": "Identifies one or more resources for which changes may be\napplied. This property accepts several different types of\nvalues:\n\n* `[]`: If the `id` property is an empty array, then the\nchanges will apply to all resources applicable to the context\nof the operation.\n* `number[]`: If the value is an array of integers, then the\nchanges will apply to each of the resources identified by the\nnumbers. If any of these numbers are negative (i.e., prefixed\nwith a minus sign, `-`), the changes will not apply to\nresources identified by those numbers, even if the same number\nis present in the array in its positive form.\n* `null` or _not present_: An undefined state. The changes\nwill not be applied to any resources.\n\nThis functionality allows a great degree of flexibility to\nbatch processing of API resources. We can ask that the changes\nbe applied to all resources for the given `type` by providing\nan empty array. We can apply the changes to all resources\nexcept a few (e.g., `\"id\": [-45, -76, -32]`). We can apply the\nchanges to some resources, but not others (e.g., `\"id\": [-32,\n56, 45, -6, 18, 32]`—in this example, the changes will not be\napplied to the resource identified by `32`).",
            "items": {
              "description": "A positive or negative integer, identifying a resource to\nwhich these changes should or should not (denoted by the\nminus sign) apply.",
              "type": "number"
            },
            "type": "array"
          },
          "parentAlbumId": {
            "description": "The identifier for the event album's parent album, if\napplicable.",
            "nullable": true,
            "type": "integer"
          },
          "photoSortType": {
            "description": "The type of sorting to apply to photos in this album.\n\nIf this batch operation is not limited by an array of\nevent album identifiers, this will apply to all albums and\nsub-albums in the current collection.",
            "enum": [
              "custom",
              "name-asc",
              "name-desc",
              "shootDate-asc",
              "shootDate-desc"
            ],
            "type": "string"
          },
          "previousAlbumId": {
            "description": "The numeric identifier for the album that precedes this\nalbum when the `event.albumSortType` or\n`album.albumSortType` for the event or album in which this\nalbum appears is set to `custom`.\n\nThis may only be used on a changeset for a single event\nalbum identifer. If multiple event album identifiers are\npresent in the `id` array, a validation failure error will\noccur.",
            "nullable": true,
            "type": "integer"
          },
          "type": {
            "description": "The type of resource represented (i.e., `event`).",
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "description": "The model type for the collection object (i.e., `event-collection`).",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Album Collection",
  "type": "object"
}