Notification Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
attributes nullable read-only deprecated

Attributes are key-value pairs of data related to the notification.

WARNING! This is a free-form bag of unstructured data. The properties and values should not be relied upon by implementations; they are subject to change.

created read-only

The date on which the entity was created.

descriptor read-only

The value of the descriptor varies among notification types. In general, the descriptor may be used as a label for the entity described in the notification. For orders and invoices, the descriptor is often the total currency amount related to the notification. For contracts and events, the descriptor is the name of the contract or event.

dismissed

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.

id

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

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.

message read-only

The message may be used as the notification text. For example, if the notificationType is order-placed, the message might be “Jane Doe placed a new order.”

notificationGroup read-only

The notification group refers to the type of entity this notification relates to. For example, if the notificationType is event-photo-favorited-by-event-contact, the notificationGroup will be event since the notification is related to an event.

notificationType read-only

A string identifier to indicate the type of notification described by this entity. This identifier may be one of the following strings

ShootProof Identifier Description
contract-canceled The contract indicated by the contract link relation has been canceled.
contract-signed-by-client The contract indicated by the contract link relation was signed by the client.
event-photo-downloaded-by-event-contact The contact indicated by the contact link relation download a photo for the event indicated by the event link relation.
event-photo-favorited-by-event-contact The contact indicated by the contact link relation favorited a photo for the event indicated by the event link relation.
event-photo-hidden-by-event-contact The contact indicated by the contact link relation marked a photo as “hidden” for the event indicated by the event link relation.
event-photo-tagged-by-event-contact The contact indicated by the contact link relation tagged a photo for the event indicated by the event link relation.
invoice-past-due The invoice indicated by the invoice link relation is past due.
invoice-payment-received The brand received a payment for the invoice indicated by the invoice link relation.
order-approval-prolonged The order indicated by the order link relation has been awaiting approval for a long period of time.
order-needs-approval The order indicated by the order link relation is awaiting approval.
order-placed The order indicated by the order link relation was just placed.
order-shipped-from-lab The order indicated by the order link relation was shipped from the lab.
studio-granted-archiving-space The studio was granted more archiving space.
studio-money-balance-increased The studio’s money balance increased.
studio-photo-plan-next-bill-date-increased The studio’s next billing date changed, often due to more free time added to their plan.
studio-profit-released The studio’s money was released to their bank account.
type

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

totalActiveNotifications

The total number of active (not dismissed) notifications for the authenticated user.

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": {
        "properties": {
          "attributes": {
            "deprecated": true,
            "description": "Attributes are key-value pairs of data related to the notification.\n\n_**WARNING!** This is a free-form bag of unstructured data. The properties\nand values should not be relied upon by implementations; they are subject\nto change._",
            "nullable": true,
            "readOnly": true,
            "type": "object"
          },
          "created": {
            "$ref": "#/components/schemas/Signature/properties/created"
          },
          "descriptor": {
            "description": "The value of the descriptor varies among notification types. In general,\nthe descriptor may be used as a label for the entity described in the\nnotification. For orders and invoices, the descriptor is often the total\ncurrency amount related to the notification. For contracts and events, the\ndescriptor is the name of the contract or event.",
            "readOnly": true,
            "type": "string"
          },
          "dismissed": {
            "description": "If the notification is dismissed, this will be `true`. Otherwise, it will\nbe `false`. Set `dismissed` to `true` to dismiss the notification.",
            "type": "boolean"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "links": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Links"
              },
              {
                "readOnly": true
              }
            ]
          },
          "message": {
            "description": "The message may be used as the notification text. For example, if the\n`notificationType` is `order-placed`, the `message` might be “Jane Doe\nplaced a new order.”",
            "readOnly": true,
            "type": "string"
          },
          "notificationGroup": {
            "description": "The notification group refers to the type of entity this notification\nrelates to. For example, if the `notificationType` is `event-photo-favorited-by-event-contact`,\nthe `notificationGroup` will be `event` since the notification is related\nto an event.",
            "enum": [
              "contract",
              "event",
              "invoice",
              "order",
              "studio"
            ],
            "readOnly": true,
            "type": "string"
          },
          "notificationType": {
            "description": "A string identifier to indicate the type of notification described\nby this entity. This identifier may be one of the following strings\n\n| ShootProof Identifier | Description |\n| --------------------- | ----------- |\n| `contract-canceled` | The contract indicated by the `contract` link relation has been canceled. |\n| `contract-signed-by-client` | The contract indicated by the `contract` link relation was signed by the client. |\n| `event-photo-downloaded-by-event-contact` | The contact indicated by the `contact` link relation download a photo for the event indicated by the `event` link relation. |\n| `event-photo-favorited-by-event-contact` | The contact indicated by the `contact` link relation favorited a photo for the event indicated by the `event` link relation. |\n| `event-photo-hidden-by-event-contact` | The contact indicated by the `contact` link relation marked a photo as “hidden” for the event indicated by the `event` link relation. |\n| `event-photo-tagged-by-event-contact` | The contact indicated by the `contact` link relation tagged a photo for the event indicated by the `event` link relation. |\n| `invoice-past-due` | The invoice indicated by the `invoice` link relation is past due. |\n| `invoice-payment-received` | The brand received a payment for the invoice indicated by the `invoice` link relation. |\n| `order-approval-prolonged` | The order indicated by the `order` link relation has been awaiting approval for a long period of time.  |\n| `order-needs-approval` | The order indicated by the `order` link relation is awaiting approval. |\n| `order-placed` | The order indicated by the `order` link relation was just placed. |\n| `order-shipped-from-lab` | The order indicated by the `order` link relation was shipped from the lab. |\n| `studio-granted-archiving-space` | The studio was granted more archiving space.  |\n| `studio-money-balance-increased` | The studio’s money balance increased. |\n| `studio-photo-plan-next-bill-date-increased` | The studio’s next billing date changed, often due to more free time added to their plan. |\n| `studio-profit-released` | The studio’s money was released to their bank account. |",
            "enum": [
              "contract-canceled",
              "contract-signed-by-client",
              "event-photo-downloaded-by-event-contact",
              "event-photo-favorited-by-event-contact",
              "event-photo-hidden-by-event-contact",
              "event-photo-tagged-by-event-contact",
              "invoice-past-due",
              "invoice-payment-received",
              "order-approval-prolonged",
              "order-needs-approval",
              "order-placed",
              "order-shipped-from-lab",
              "studio-granted-archiving-space",
              "studio-money-balance-increased",
              "studio-photo-plan-next-bill-date-increased",
              "studio-profit-released"
            ],
            "readOnly": true,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "notification"
                ]
              }
            ]
          }
        },
        "title": "Notification",
        "type": "object"
      },
      "title": "Notification",
      "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"
        },
        "totalActiveNotifications": {
          "description": "The total number of active (not dismissed) notifications for the\nauthenticated user.",
          "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": [
        "notification-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of Notifications",
  "type": "object"
}