Event Photo Collection In Patch

Description

A collection of event photos to be updated.

Properties

Property Description
items

A collection of one or more batched resources. If items is null or an empty array, no action is taken.

Property Description
id

Identifies one or more resources for which changes may be applied. This property accepts several different types of values:

  • []: If the id property is an empty array, then the changes will apply to all resources applicable to the context of the operation.
  • number[]: If the value is an array of integers, then the changes will apply to each of the resources identified by the numbers. If any of these numbers are negative (i.e., prefixed with a minus sign, -), the changes will not apply to resources identified by those numbers, even if the same number is present in the array in its positive form.
  • null or not present: An undefined state. The changes will not be applied to any resources.

This functionality allows a great degree of flexibility to batch processing of API resources. We can ask that the changes be applied to all resources for the given type by providing an empty array. We can apply the changes to all resources except a few (e.g., "id": [-45, -76, -32]). We can apply the changes to some resources, but not others (e.g., "id": [-32, 56, 45, -6, 18, 32]—in this example, the changes will not be applied to the resource identified by 32).

isHidden

Whether the photo(s) should be marked 'hidden.'

previousPhotoId nullable

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

This may only be used on a changeset for a single event photo identifer. If multiple event photo identifiers are present in the id array, a validation failure error will occur.

type

The type of resource represented (i.e., event).

watermarkId nullable

The numeric identifier for the watermark to apply to the photo(s).

Please note: If provided, all photos indicated by the id property will be re-watermarked using the watermark indicated by watermarkId. Only provide watermarkId if you wish to re-watermark the photos. If the value is set to null, all photos indicated in the id property will have their watermarks removed. If the watermarkId is not provided, no change will occur.

type

The model type for the collection object (i.e., event-collection).

OpenAPI Schema

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

{
  "description": "A collection of event photos 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 event photos.",
        "properties": {
          "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"
          },
          "isHidden": {
            "description": "Whether the photo(s) should be marked 'hidden.'",
            "type": "boolean"
          },
          "previousPhotoId": {
            "description": "The numeric identifier for the photo that precedes this\nphoto when the `event.photoSortType` or\n`album.photoSortType` for the event or album in which this\nphoto appears is set to `custom`.\n\nThis may only be used on a changeset for a single event\nphoto identifer. If multiple event photo 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"
          },
          "watermarkId": {
            "description": "The numeric identifier for the watermark to apply to the\nphoto(s).\n\n_**Please note:** If provided, all photos indicated by the\n`id` property will be re-watermarked using the watermark\nindicated by `watermarkId`. Only provide `watermarkId` if\nyou wish to re-watermark the photos. If the value is set\nto `null`, all photos indicated in the `id` property will\nhave their watermarks removed. If the `watermarkId` is not\nprovided, no change will occur._",
            "nullable": true,
            "type": "integer"
          }
        },
        "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 Photo Collection",
  "type": "object"
}