Event Contact Defaults Collection

Description

A collection of event contact defaults objects.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
adminModePin write-only

Access code assigned to this contact default for a given set of event contact defaults.

canHidePhotos

Whether the contact is allowed to hide photos for a given set of event contact defaults.

canTagPhotos

Whether the contact is allowed to tag photos for a given set of event contact defaults.

created read-only

The creation date of this event contact defaults object.

eventPhotoTags

An array of event photo tag objects for a given set of event contact defaults.

id read-only

The identifier for this event contact defaults object.

isDefault

Whether the current preset is the default for contacts.

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.

name

A descriptive name for these event contact defaults settings.

type

The type of object represented.

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.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The model type for the list response object.

OpenAPI Schema

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

{
  "description": "A collection of event contact defaults objects.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "An event contact defaults object.",
        "properties": {
          "adminModePin": {
            "description": "Access code assigned to this contact default for a given set of\nevent contact defaults.",
            "maxLength": 30,
            "minLength": 6,
            "type": "string",
            "writeOnly": true
          },
          "canHidePhotos": {
            "description": "Whether the contact is allowed to hide photos for a given set of\nevent contact defaults.",
            "type": "boolean"
          },
          "canTagPhotos": {
            "description": "Whether the contact is allowed to tag photos for a given set of\nevent contact defaults.",
            "type": "boolean"
          },
          "created": {
            "description": "The creation date of this event contact defaults object.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "eventPhotoTags": {
            "description": "An array of event photo tag objects for a given set of event contact\ndefaults.",
            "items": {
              "$ref": "#/components/schemas/EventContactDefaultsEventPhotoTag"
            },
            "type": "array"
          },
          "id": {
            "description": "The identifier for this event contact defaults object.",
            "readOnly": true,
            "type": "number"
          },
          "isDefault": {
            "description": "Whether the current preset is the default for contacts.",
            "type": "boolean"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "A descriptive name for these event contact defaults settings.",
            "maxLength": 100,
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "event-contact-defaults"
            ],
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "title": "Event Contact 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-contact-defaults-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Contact Defaults Collection",
  "type": "object"
}