A collection of events.
| 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 required 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 events.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"description": "An event as viewed from a collection.",
"properties": {
"contactId": {
"allOf": [
{
"nullable": true
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"contactName": {
"description": "The full name of the contact associated with this event.",
"nullable": true,
"type": "string"
},
"coverPhoto": {
"allOf": [
{
"$ref": "#/components/schemas/CoverPhoto"
},
{
"nullable": true
}
],
"description": "A cover photo for the event.",
"readOnly": true
},
"created": {
"description": "The creation date of this event.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The ID of the user who created this event.",
"type": "integer"
},
"eventAccessLevel": {
"description": "The event access level.",
"enum": [
"public-password",
"public-no-password",
"private-password",
"private-no-password"
],
"type": "string"
},
"eventCategory": {
"description": "The human-readable name of the category of this event.",
"nullable": true,
"type": "string"
},
"eventCategoryId": {
"description": "The numeric identifier for the category of this event.",
"nullable": true,
"type": "integer"
},
"eventDate": {
"description": "The date on which this event took place.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"eventStatus": {
"description": "The event status.",
"enum": [
"active",
"inactive",
"archived"
],
"type": "string"
},
"expirationDate": {
"description": "The date on which this event expires.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"id": {
"description": "The identifier for this event.",
"type": "integer"
},
"isPreRegistration": {
"description": "Whether pre-registration mode is turned on for the event.",
"type": "boolean"
},
"lastReleasedDate": {
"description": "The date on which this event was last released.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name of this event.",
"type": "string"
},
"photosCount": {
"description": "The total number of photos within this event, including\nphotos in albums.",
"type": "integer"
},
"playlistId": {
"description": "The identifier for the playlist this event uses.",
"nullable": true,
"readOnly": true,
"type": "integer"
},
"priceSheetId": {
"description": "The identifier for the price sheet assigned to the event.",
"nullable": true,
"type": "integer"
},
"releaseDate": {
"description": "The date on which this event will be released.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"type": {
"description": "The type of object represented.",
"enum": [
"event"
],
"type": "string"
}
},
"required": [
"type",
"links",
"id",
"name",
"eventStatus",
"eventAccessLevel",
"eventCategoryId",
"eventCategory",
"contactId",
"contactName",
"photosCount",
"eventDate",
"releaseDate",
"expirationDate",
"created"
],
"type": "object"
},
"title": "Event",
"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"
},
"eventTotals": {
"description": "Total counts for various types of events in various states.",
"properties": {
"active": {
"description": "The total number of active events for the brand.",
"type": "integer"
},
"all": {
"description": "The total number of events for the brand.",
"type": "integer"
},
"archived": {
"description": "The total number of archived events for the brand.",
"type": "integer"
},
"inactive": {
"description": "The total number of inactive events for the brand.",
"type": "integer"
},
"preregistered": {
"description": "The total number of pre-registered events for the brand.",
"type": "integer"
}
},
"required": [
"all",
"active",
"inactive",
"preregistered",
"archived"
],
"type": "object"
},
"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,
"required": [
"eventTotals"
],
"type": "object"
},
"type": {
"description": "The model type for the list response object.",
"enum": [
"event-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Event Collection",
"type": "object"
}