Brand Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
address required nullable

The mailing address for this brand.

created

The creation date of this brand.

customDomain nullable

A custom domain for this brand, if applicable.

email

The email address for this brand.

facebookFanPageUrl nullable

The URL for this brand's Facebook fan page.

galleryDomain

The domain for this brand's galleries.

homepageBrandTheme

A brand theme.

homepageBrandThemeId

The identifier for this brand's homepage brand theme.

id

The identifier for this brand.

instagramUsername nullable

The Instagram username for this brand.

isDefault

Whether this is the default brand for the logged-in user's studio.

labCatalogs

An array of lab catalogs to which this brand has access.

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.

locale

The locale defined for this brand.

name

The name of this brand.

phone

The phone number for this brand.

subdomain

The ShootProof subdomain for this brand.

twitterHandle nullable

The Twitter username for this brand.

type

The type of resource represented.

useDefaultWatermark

Whether or not the Brand's default watermark should be applied at upload time.

website nullable

The URL for this brand's website.

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 type of resource represented.

OpenAPI Schema

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

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A brand.",
        "properties": {
          "address": {
            "allOf": [
              {
                "description": "The mailing address for this brand.",
                "nullable": true
              },
              {
                "$ref": "#/components/schemas/Address"
              }
            ]
          },
          "created": {
            "description": "The creation date of this brand.",
            "format": "date-time",
            "type": "string"
          },
          "customDomain": {
            "description": "A custom domain for this brand, if applicable.",
            "format": "hostname",
            "nullable": true,
            "type": "string"
          },
          "email": {
            "description": "The email address for this brand.",
            "format": "email",
            "type": "string"
          },
          "facebookFanPageUrl": {
            "description": "The URL for this brand's Facebook fan page.",
            "format": "uri",
            "nullable": true,
            "type": "string"
          },
          "galleryDomain": {
            "description": "The domain for this brand's galleries.",
            "format": "uri",
            "type": "string"
          },
          "homepageBrandTheme": {
            "$ref": "#/components/schemas/BrandTheme"
          },
          "homepageBrandThemeId": {
            "description": "The identifier for this brand's homepage brand theme.",
            "type": "integer"
          },
          "id": {
            "description": "The identifier for this brand.",
            "type": "integer"
          },
          "instagramUsername": {
            "description": "The Instagram username for this brand.",
            "nullable": true,
            "type": "string"
          },
          "isDefault": {
            "description": "Whether this is the default brand for the logged-in user's studio.",
            "type": "boolean"
          },
          "labCatalogs": {
            "description": "An array of lab catalogs to which this brand has access.",
            "items": {
              "$ref": "#/components/schemas/LabCatalog"
            },
            "title": "Lab Catalog",
            "type": "array"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "locale": {
            "description": "The locale defined for this brand.",
            "type": "string"
          },
          "name": {
            "description": "The name of this brand.",
            "type": "string"
          },
          "phone": {
            "description": "The phone number for this brand.",
            "type": "string"
          },
          "subdomain": {
            "description": "The ShootProof subdomain for this brand.",
            "type": "string"
          },
          "twitterHandle": {
            "description": "The Twitter username for this brand.",
            "nullable": true,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "brand"
                ]
              }
            ]
          },
          "useDefaultWatermark": {
            "description": "Whether or not the Brand's default watermark should be applied at\nupload time.",
            "type": "boolean"
          },
          "website": {
            "description": "The URL for this brand's website.",
            "format": "uri",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Brand",
        "type": "object"
      },
      "title": "Brand",
      "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 type of resource represented.",
      "enum": [
        "brand-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}