Contents

Entities

Entities are a fancy way of saying “things.” In the ShootProof API all things are entities.

Entities are individual resources that are usually—but not always—part of a collection, and it’s through an entity’s collection resource that you’re able to list and create entities of that type.

Almost all entities in the ShootProof API share the following characteristics:

  1. They are part of a paginated collection.
  2. They have a type property that identifies what kind of entity it is.
  3. They have a links property that has self and collection properties as link relations.
  4. Many follow a standard CRUD model, mapping to these HTTP methods:
    1. Create maps to POST.
    2. Read maps to GET.
    3. Update maps to PUT or PATCH.
    4. Delete maps to DELETE.

Simple Entity

In its simplest form, a ShootProof entity looks like this:

{
  "type": "entity-type",
  "links": {
    "self": {
      "href": "https://api.shootproof.com/studio/entity/17df5170-b782-4cab-b5f0-451f7807eeb2"
    },
    "collection": {
      "href": "https://api.shootproof.com/studio/entity"
    }
  }
}

Entity Types

The ShootProof API has many entity types to play with. Many entity types map directly to a ShootProof link relation of the same name.

Entity Type Name
address
brand
brand-collection
brand-logo
brand-theme
brand-theme-collection
contact
contact-collection
contact-recent-activity
contact-recent-activity-collection
contract
contract-collection
contract-signature
contract-template
contract-template-collection
cover-photo
credit-card
digital-rule
digital-rule-collection
dpa
dpa-collection
email
email-automation-group
email-automation-group-collection
email-template
email-template-collection
email-template-type
email-template-type-collection
event
event-album
event-album-children-collection
event-album-collection
event-archive-cost
event-category
event-category-collection
event-collection
event-contact
event-contact-defaults
event-contact-defaults-collection
event-contact-defaults-event-photo-tag
event-contact-permissions-event-photo-tag
event-defaults
event-defaults-collection
event-permissions
event-photo
event-photo-collection
event-photo-tag
event-photo-upload-policy
image
invoice
invoice-activity
invoice-collection
invoice-credit-card-transaction
invoice-installment
invoice-item
invoice-item-template
invoice-payment
invoice-refund
invoice-template
lab
lab-catalog
lab-catalog-add-on-option
lab-catalog-collection
lab-catalog-group
lab-catalog-group-collection
lab-catalog-product
lab-catalog-product-collection
lab-catalog-shipping-option
lab-catalog-shipping-option-collection
market-department
market-order
market-product
market-purchased-product
market-vendor
mobile-app
order
order-collection
order-item-collection
order-payment
order-payment-collection
order-photo
playlist
price-sheet
price-sheet-add-on-group
price-sheet-add-on-option
price-sheet-collection
price-sheet-discount-collection
price-sheet-element-image
price-sheet-element-image-collection
price-sheet-group
price-sheet-group-collection
price-sheet-item
price-sheet-item-collection
price-sheet-item-digital
price-sheet-item-node
price-sheet-shipping-option
price-sheet-shipping-option-collection
price-sheet-subgroup
price-sheet-subgroup-collection
service-description
signature
song
song-collection
studio
studio-credit-card
studio-money-balance
studio-photo-plan
user
watermark
watermark-collection
zip-bundle