Cover Photo

Description

cover-photo
Base Image

A cover photo.

Properties

Property Description
coverPhotoStatus read-only
string
enum
  • active
  • pending
  • deleted

The current status of this cover photo.
coverPhotoType read-only
string
enum
  • event
  • event-album

The slug string name of the cover photo type.
created read-only
string
date-time

The creation date of the image.
displayUrl nullable read-only
object
Image Display Url

Display URLs for this image.
filesize read-only
integer

The original filesize of the image (in bytes).
focalPointPercentages required
object

A pair of x,y coordinates on a rectangular coordinate system, defining a focal point to use when rendering the cover photo. These numbers represent percentages and not fixed pixels.

Property Description
x
number

The x-coordinate for the focal point, as a percentage. (i.e. (x / width) * 100)
y
number

The y-coordinate for the focal point, as a percentage. (i.e. (y / height) * 100)
height read-only
integer

The height in pixels of the image.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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.
mimeType nullable read-only
string

The image file MIME type.
name
string
  • ≤ 250 characters

The original filename of the image.
photoId nullable write-only
integer

If using an existing event photo as the cover photo, the identifier for the event photo.
type
string
enum
  • cover-photo

The type of object represented.
width read-only
integer

The width in pixels of the image.

OpenAPI Schema

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

{
  "description": "A cover photo.",
  "properties": {
    "coverPhotoStatus": {
      "description": "The current status of this cover photo.",
      "enum": [
        "active",
        "pending",
        "deleted"
      ],
      "readOnly": true,
      "type": "string"
    },
    "coverPhotoType": {
      "description": "The slug string name of the cover photo type.",
      "enum": [
        "event",
        "event-album"
      ],
      "readOnly": true,
      "type": "string"
    },
    "created": {
      "description": "The creation date of the image.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "displayUrl": {
      "allOf": [
        {
          "description": "Display URLs for this image.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/ImageDisplayUrl"
        }
      ]
    },
    "filesize": {
      "description": "The original filesize of the image (in bytes).",
      "example": 18452563,
      "readOnly": true,
      "type": "integer"
    },
    "focalPointPercentages": {
      "description": "A pair of x,y coordinates on a rectangular coordinate system,\ndefining a focal point to use when rendering the cover photo.\nThese numbers represent percentages and not fixed pixels.",
      "properties": {
        "x": {
          "description": "The x-coordinate for the focal point, as a percentage. (i.e.\n`(x / width) * 100`)",
          "type": "number"
        },
        "y": {
          "description": "The y-coordinate for the focal point, as a percentage. (i.e.\n`(y / height) * 100`)",
          "type": "number"
        }
      },
      "required": [
        "x",
        "y"
      ],
      "type": "object"
    },
    "height": {
      "description": "The height in pixels of the image.",
      "example": 3000,
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "mimeType": {
      "description": "The image file MIME type.",
      "example": "image/jpeg",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "The original filename of the image.",
      "example": "my-file.jpg",
      "maxLength": 250,
      "type": "string"
    },
    "photoId": {
      "description": "If using an existing event photo as the cover photo, the identifier\nfor the event photo.",
      "nullable": true,
      "type": "integer",
      "writeOnly": true
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "cover-photo"
      ],
      "type": "string"
    },
    "width": {
      "description": "The width in pixels of the image.",
      "example": 2400,
      "readOnly": true,
      "type": "integer"
    }
  },
  "required": [
    "type",
    "focalPointPercentages",
    "coverPhotoStatus",
    "coverPhotoType"
  ],
  "title": "Image",
  "type": "object"
}
Image