A collection of event defaults objects.
| 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 defaults objects.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"description": "An event defaults object.",
"properties": {
"abandonedCartEmailEnabled": {
"description": "Whether this event has the Abandoned Cart Email feature enabled.",
"type": "boolean"
},
"allowAddAllToCart": {
"description": "Whether to show \"Buy All\" buttons, allowing clients to add all\nphotos in the event to their cart. If this is set to true,\n`priceSheetShowPackagesOnly` MUST be false.",
"type": "boolean"
},
"allowBlackWhiteFiltering": {
"description": "Allow clients to see and order a black and white version of an\nimage.",
"type": "boolean"
},
"allowCropping": {
"description": "Allow clients to crop photos on orders.",
"type": "boolean"
},
"allowFreeDigitals": {
"description": "Whether to allow clients to download free digitals from the event.",
"type": "boolean"
},
"allowFreeDigitalsDownloadAll": {
"description": "If `allowFreeDigitals` is true, whether to allow clients to download\nthe entire event.",
"type": "boolean"
},
"allowOrderItemClientComments": {
"description": "Whether to allow client comments to be placed on cart/order items.\nDefaults to false.",
"type": "boolean"
},
"allowPayLater": {
"description": "Whether to allow clients to pay later.",
"type": "boolean"
},
"autoArchiveDays": {
"description": "If provided, the number of days after event expiration to\nautomatically archive the event.",
"nullable": true,
"type": "integer"
},
"autoSetAlbumCovers": {
"description": "Whether to autogenerate album cover images from the first image in\nthe album.",
"type": "boolean"
},
"bannerExpirationDate": {
"description": "An optional expiration date that will turn off the banner automatically",
"format": "date-time",
"nullable": true,
"type": "string"
},
"bannerText": {
"description": "Text for a banner that appears above the navigation on all gallery pages.",
"maxLength": 85,
"nullable": true,
"type": "string"
},
"bannerUrl": {
"description": "An optional URL for a link from the banner.",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"brandTheme": {
"$ref": "#/components/schemas/BrandTheme",
"readOnly": true
},
"brandThemeId": {
"description": "The identifier for the brand theme the event uses.",
"type": "integer"
},
"checkoutText": {
"description": "If provided, a message shown to the client at checkout.",
"maxLength": 1000,
"nullable": true,
"type": "string"
},
"created": {
"description": "The creation date of this event defaults object.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"digitalRules": {
"description": "Collection of digital rules available for this event defaults.\nDigital rules describe configurations for free digitals\ndownloads.",
"items": {
"$ref": "#/components/schemas/DigitalRule"
},
"title": "Digital Rule",
"type": "array"
},
"emailAutomationGroupId": {
"description": "The identifier for the email automation group associated with the\nevent.",
"nullable": true,
"type": "integer"
},
"enableStore": {
"description": "Whether the store (shopping cart) is enabled for the event.",
"type": "boolean"
},
"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 the event.",
"nullable": true,
"readOnly": true,
"type": "string"
},
"eventCategoryId": {
"description": "The category identifier associated with the event.",
"nullable": true,
"type": "integer"
},
"eventStatus": {
"description": "The event status.",
"enum": [
"active",
"inactive",
"archived"
],
"type": "string"
},
"exifSearchFieldLabel": {
"description": "The label for the EXIF data search field for the event.\n\nThis is only available if the studio has been flagged in the admin\nwith this permission.",
"maxLength": 40,
"nullable": true,
"type": "string"
},
"hasScreenshotDeterrenceDesktop": {
"description": "Whether screenshot deterrence is enabled for desktop browsers.",
"type": "boolean"
},
"headline": {
"description": "Headline to display to event visitors.",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"hideAlbums": {
"description": "Whether to hide all the albums in an event.\n\nThis is only available if the studio has been flagged in the admin\nwith this permission.",
"type": "boolean"
},
"hideAllPhotosAlbum": {
"description": "Whether to hide the \"All Photos\" default photo album.",
"type": "boolean"
},
"hidePhotoCountAlbums": {
"description": "Whether to hide the photo count for all albums in the client facing\ngallery.",
"type": "boolean"
},
"homepageLinkTo": {
"description": "The URL to which the homepage link should send users. This is\nrequired if `showHomepageLink` is `true`.\n\nValid values are:\n\n* `studio_homepage`: The homepage link points to the ShootProof\nhomepage for the brand.\n* `studio_website`: The homepage link points to the website URL set\nfor the brand.",
"enum": [
"studio_homepage",
"studio_website"
],
"nullable": true,
"type": "string"
},
"id": {
"description": "The identifier for this event defaults object.",
"readOnly": true,
"type": "integer"
},
"information": {
"description": "Information to display to event visitors.",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"isDefault": {
"description": "Whether this is marked as the default event defaults.",
"type": "boolean"
},
"isPreRegistration": {
"description": "Whether pre-registration mode is turned on for the event.",
"type": "boolean"
},
"landingLayoutType": {
"description": "The layout type for the event landing page. The possible landing\nlayout types are:\n\n* `basic`: Accent\n* `full-bottom`: Limelight\n* `full-bottom-alt`: Foundation\n* `full-center`: Marquee\n* `hexagon`: Symmetry\n* `split`: Detail\n* `no-cover`: Headline",
"enum": [
"full-bottom",
"full-center",
"split",
"basic",
"no-cover"
],
"type": "string"
},
"languageCode": {
"description": "The Unicode CLDR language tag for the language used in the event.",
"type": "string"
},
"lastUpdated": {
"description": "The date this event defaults object was last updated.",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"minimumOrderAmount": {
"description": "The minimum amount required for any order placed for the event.",
"nullable": true,
"type": "number"
},
"musicAutoPlay": {
"description": "If there is a playlist defined, whether to auto-play the music when\nthe even loads in the browser.",
"type": "boolean"
},
"name": {
"description": "A descriptive name for these event defaults settings.",
"maxLength": 100,
"type": "string"
},
"pickupOptions": {
"description": "An array of order pickup options supported by the event.",
"items": {
"description": "A string identifying a pickup option.",
"enum": [
"studio",
"dropship"
],
"type": "string"
},
"type": "array"
},
"playlist": {
"description": "The playlist for the event, if applicable. (TODO: playlists not\nsupported in the API at this time.)",
"nullable": true,
"readOnly": true
},
"playlistId": {
"description": "The identifier for the playlist the event uses.",
"nullable": true,
"type": "integer"
},
"preRegistrationMessage": {
"description": "Text to display to visitors when the event is in pre-registration\nmode.",
"maxLength": 1000,
"nullable": true,
"type": "string"
},
"priceSheet": {
"description": "The price sheet for the event, if applicable. (TODO: price sheets\nnot supported in the API at this time.)",
"nullable": true,
"readOnly": true
},
"priceSheetId": {
"description": "The identifier for the price sheet the event uses. If `null`, then\nthe shopping cart for the event is turned off.",
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"priceSheetShowPackagesOnly": {
"description": "Whether to limit the display of price sheet items to only those that are packages.\nIf this is set to true, `allowAddAllToCart` MUST be false.",
"type": "boolean"
},
"printRelease": {
"description": "Print release text that is sent to the client when\nShootProof-fulfilled digitals are downloaded. Some HTML is allowed.",
"maxLength": 7500,
"nullable": true,
"type": "string"
},
"requireEmail": {
"description": "Whether an email address is required to view the event.",
"type": "boolean"
},
"screenshotDeterrenceDesktopBody": {
"description": "The body text shown in the screenshot deterrence overlay on desktop browsers.",
"nullable": true,
"type": "string"
},
"screenshotDeterrenceDesktopTitle": {
"description": "The title text shown in the screenshot deterrence overlay on desktop browsers.",
"nullable": true,
"type": "string"
},
"screenshotDeterrenceMobileType": {
"description": "The blur style for mobile screenshot deterrence. Use 'none' to disable.",
"enum": [
"none",
"horizontal",
"diagonal"
],
"nullable": true,
"type": "string"
},
"showFilenames": {
"description": "Whether to show the filenames of photos in the event.",
"type": "boolean"
},
"showHomepageLink": {
"description": "Whether to show a link to the studio homepage.",
"type": "boolean"
},
"showSocialSharingLinks": {
"description": "Whether to display social media sharing links for the event.",
"type": "boolean"
},
"socialSharingMessage": {
"description": "The default message to include when a social sharing link is\nclicked.",
"maxLength": 93,
"nullable": true,
"type": "string"
},
"thumbnailGutterWidth": {
"description": "Relative size of thumbnail gutter width for display.",
"enum": [
"s",
"m",
"l",
"xl"
],
"type": "string",
"x-internal": true
},
"thumbnailSize": {
"description": "Relative size of thumbnails for display.",
"enum": [
"s",
"m",
"l",
"xl"
],
"nullable": true,
"type": "string",
"x-internal": true
},
"type": {
"description": "The type of object represented.",
"enum": [
"event-defaults"
],
"type": "string"
},
"useCoversAsBanners": {
"description": "Whether the gallery and albums show cover photos as a banner.",
"type": "boolean"
},
"videoUrl": {
"description": "The URL of a video to display to event visitors.",
"maxLength": 255,
"nullable": true,
"type": "string"
},
"viewType": {
"description": "The layout type for the event photo pages. The possible view types\nare:\n\n* `vmason`: Cascade layout\n* `hmason`: Subway layout",
"enum": [
"vmason",
"hmason"
],
"type": "string"
}
},
"required": [
"name",
"isDefault"
],
"title": "Event Defaults",
"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-defaults-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Event Defaults Collection",
"type": "object"
}