Event Category 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 categories.",
  "properties": {
    "items": {
      "description": "An array of event categories.",
      "items": {
        "description": "An event category.",
        "properties": {
          "coverPhoto": {
            "description": "A cover photo for the event category.",
            "nullable": true,
            "properties": {
              "displayUrl": {
                "description": "Display URL for this image.",
                "properties": {
                  "thumb": {
                    "description": "A URL for the event category cover photo image.",
                    "format": "uri",
                    "readOnly": true,
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "focalPointPercentages": {
                "description": "A pair of `x,y` coordinates on a rectangular coordinate system, defining a\nfocal point to use when rendering the cover photo. These numbers represent\npercentages and not fixed pixels.",
                "properties": {
                  "x": {
                    "description": "The x-coordinate for the focal point, as a percentage. (i.e.\n`(x / width) * 100`)",
                    "example": 49.85,
                    "type": "number"
                  },
                  "y": {
                    "description": "The y-coordinate for the focal point, as a percentage. (i.e.\n`(y / height) * 100`)",
                    "example": 25.7,
                    "type": "number"
                  }
                },
                "title": "Focal Point Percentages",
                "type": "object"
              },
              "height": {
                "description": "Height of the cover photo image in pixels.",
                "type": "integer"
              },
              "width": {
                "description": "Width of the cover photo image in pixels.",
                "type": "integer"
              }
            },
            "type": "object"
          },
          "displayOrder": {
            "description": "The order in which the categories should be displayed.",
            "type": "integer"
          },
          "eventCount": {
            "description": "The total number of events within this event category.",
            "readOnly": true,
            "type": "integer"
          },
          "id": {
            "description": "The identifier for this event category.",
            "type": "integer"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The event category name.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "event-category"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id",
          "name"
        ],
        "title": "Event Category",
        "type": "object"
      },
      "title": "Event Category",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "event-category-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Category Collection",
  "type": "object"
}