A collection of event album children. The items
array may contain objects with type
of either event-album
or event-album-photo
.
Property | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
items |
A collection of resources returned in the current result set. |
||||||||||
links required read-only |
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. |
||||||||||
meta read-only |
Metadata describing the current result set.
|
||||||||||
type |
The model type for the list response object. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A collection of event album children. The `items` array may contain\nobjects with `type` of either `event-album` or `event-album-photo`.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EventAlbumInList"
},
{
"$ref": "#/components/schemas/EventPhoto"
}
],
"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"
}