Event Album Children Collection Minimal

OpenAPI Schema

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

{
  "description": "A minimal collection of event album children, used when the `Prefer`\nheader is present in the request and requesting `return=minimal`.\n\nSince the response may include data of either `event-album` or\n`event-album-photo`, the `itemType` property is provided to indicate to\nwhat type of object the data relates.",
  "properties": {
    "id": {
      "description": "An array of album or photo IDs belonging to this collection.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "itemType": {
      "description": "The type of item represented by this collection.",
      "enum": [
        "event-album",
        "event-album-photo"
      ],
      "type": "string"
    },
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "type": "object"
      },
      "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 model type for the list response object.",
      "enum": [
        "event-album-children-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Album Children Collection",
  "type": "object"
}