Contents

Authenticated User

The Authenticated User is the user who granted your app access to their ShootProof account. Using the Authenticated User’s credentials, your app can manage their account and more through the ShootProof API.

List the authenticated user’s notifications

get
/studio/brand/{brandId}/notification

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.

Query Parameters

Property Description
filterDismissed
boolean
  • default false

If the value is truthy, the response will list only dismissed notifications. If the value is falsy (default), then the response contains only non-dismissed notifications.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

A collection of notifications.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
items
notification[]
Notification

A collection of resources returned in the current result set.

Property Description
attributes nullable read-only deprecated
object

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
string
date-time
Signature

The date on which the entity was created.
descriptor read-only
string

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
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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
string

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
string
enum
  • contract
  • event
  • invoice
  • order
  • studio

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
string
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

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
string
enum
  • notification
Type

The type of resource represented.
links required read-only
object
Links

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
object

Metadata describing the current result set.

Property Description
currentPage
integer

The current page of results returned.
rows
integer

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

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

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

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).
type
string
enum
  • notification-collection
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.

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/NotificationCollection"
        }
      }
    },
    "description": "A collection of notifications."
  }
}

Get a notification

get
/studio/brand/{brandId}/notification/{notificationId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
notificationId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

A notification identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

A notification.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
attributes nullable read-only deprecated
object

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
string
date-time
Signature

The date on which the entity was created.
descriptor read-only
string

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
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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
string

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
string
enum
  • contract
  • event
  • invoice
  • order
  • studio

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
string
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

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
string
enum
  • notification
Type

The type of resource represented.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Notification"
        }
      }
    },
    "description": "A notification."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Partially update a notification

Only provide those properties that you wish to update. All other properties will remain unchanged.

patch
/studio/brand/{brandId}/notification/{notificationId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
notificationId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

A notification identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The notification object to update. Only provide those properties that need updating.

application/vnd.shootproof+json
Property Description
dismissed
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
type
string
enum
  • notification
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Notification"
      }
    }
  },
  "description": "The notification object to update. Only provide those properties that need\nupdating.",
  "required": true
}

200 OK

The updated notification.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
attributes nullable read-only deprecated
object

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
string
date-time
Signature

The date on which the entity was created.
descriptor read-only
string

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
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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
string

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
string
enum
  • contract
  • event
  • invoice
  • order
  • studio

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
string
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

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
string
enum
  • notification
Type

The type of resource represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Notification"
        }
      }
    },
    "description": "The updated notification."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Update a notification

put
/studio/brand/{brandId}/notification/{notificationId}

Example Request

Path Parameters

Property Description
brandId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The brand identifier.
notificationId required
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

A notification identifier.

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

A notification.

application/vnd.shootproof+json
Property Description
dismissed
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
type
string
enum
  • notification
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Notification"
      }
    }
  },
  "description": "A notification.",
  "required": true
}

200 OK

The updated notification.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
attributes nullable read-only deprecated
object

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
string
date-time
Signature

The date on which the entity was created.
descriptor read-only
string

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
boolean

If the notification is dismissed, this will be true. Otherwise, it will be false. Set dismissed to true to dismiss the notification.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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
string

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
string
enum
  • contract
  • event
  • invoice
  • order
  • studio

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
string
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

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
string
enum
  • notification
Type

The type of resource represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Notification"
        }
      }
    },
    "description": "The updated notification."
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Get the authenticated user

get
/studio/me

Example Request

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

The authenticated user.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
created read-only
string
date-time

The date on which this user was created.
email
string
email

The email address for this user.
firstName
string

The first name for this user.
id
number

The identifier for this user.
isStudioOwner read-only
boolean

Whether the authenticated user is the owner of the studio.
lastLogin nullable read-only
string
date-time

The date on which this user last logged in to the Studio Panel.
lastName
string

The last name for this user.
links required read-only
object
Links

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
string

The full name for this user.
permissions
string[]
unique
enum
  • account.payment-read
  • account.payment-withdrawal
  • account.read
  • account.update
  • brand-theme.create
  • brand-theme.read
  • brand-theme.update
  • brand.homepage-update
  • contact.create
  • contact.read
  • contact.update
  • contract.create
  • contract.read
  • contract.update
  • email-template.create
  • email-template.read
  • email-template.update
  • event-defaults.create
  • event-defaults.read
  • event-defaults.update
  • event-photo.create
  • event-photo.update
  • event.create
  • event.created-only
  • event.delete
  • event.read
  • event.update
  • invoice.create
  • invoice.read
  • invoice.update
  • mobile-app.create
  • mobile-app.read
  • mobile-app.update
  • order.read
  • order.update
  • playlist.read
  • playlist.update
  • price-sheet.create
  • price-sheet.read
  • price-sheet.update
  • report.event-visitors-read
  • report.invoices-read
  • report.items-read
  • report.orders-read
  • report.sales-read
  • tool.read
  • watermark.create
  • watermark.read
  • watermark.update

An array of permission identifiers indicating the permission levels this user has within the Studio Panel.

Permission Description
account.payment-read The user may view the studio account's plan & billing information.
account.payment-withdrawal The user may request payment withdrawals on behalf of the studio.
account.read The user may view studio account settings (e.g. contact info, users, etc.).
account.update The user may update studio account settings (e.g. contact info, users, etc.).
brand-theme.create The user may create themes.
brand-theme.read The user may view themes.
brand-theme.update The user may edit themes.
brand.homepage-update The user may edit the client galleries homepage for a brand.
contact.create The user may create contacts.
contact.read The user may view contacts.
contact.update The user may edit contacts.
contract.create The user may create contracts.
contract.read The user may view contracts.
contract.update The user may edit contracts.
email-template.create The user may create email templates and automation groups.
email-template.read The user may view email templates and automation groups.
email-template.update The user may edit email templates and automation groups.
event-defaults.create The user may create default settings for events.
event-defaults.read The user may view default settings for events.
event-defaults.update The user may edit default settings for events.
event-photo.create The user may create event photos.
event-photo.update The user may edit event photos.
event.create The user may create events.
event.created-only The user may only view/edit/delete events they created.
event.delete The user may delete events.
event.read The user may view events.
event.update The user may edit events.
invoice.create The user may create invoices.
invoice.read The user may view invoices.
invoice.update The user may edit invoices.
mobile-app.create The user may create mobile apps.
mobile-app.read The user may view mobile apps.
mobile-app.update The user may edit mobile apps.
order.read The user may view orders.
order.update The user may edit orders.
playlist.read The user may view music playlists.
playlist.update The user may edit music playlists.
price-sheet.create The user may create price sheets.
price-sheet.read The user may view price sheets.
price-sheet.update The user may edit price sheets.
report.event-visitors-read The user may view the "Event Visitors" report.
report.invoices-read The user may view the "Invoices" report.
report.items-read The user may view the "Top-Selling Items" report.
report.orders-read The user may view the "Orders" report.
report.sales-read The user may view the "Sales" report.
tool.read The user may view the available downloadable tools (i.e. Desktop Uploader).
watermark.create The user may create watermarks.
watermark.read The user may view watermarks.
watermark.update The user may edit watermarks.
signature
signature
Signature

A signature.
studio read-only
studio
Studio

The studio to which the authenticated user belongs.
type
string
enum
  • user

The type of object represented.
userStatus read-only
string

A human-readable string describing this user's status.
userStatusId
number

The numeric identifier for this user's status.

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/AuthenticatedUser"
        }
      }
    },
    "description": "The authenticated user."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}

Remove the authenticated user’s signature

If you need to remove a user’s signature, you may send a DELETE request to this resource to detach their signature.

Please note, this does not completely delete the signature if, for example, it has already been used to sign a contract, etc. Everything signed with the signature before it was removed will remained signed with that signature.

delete
/studio/me/signature

Example Request

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

The authenticated user’s signature was successfully detached from the user.

Headers
Header Description
Content-Location
string
uri

The URL to the resource represented in the body of the response.
Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
created read-only
string
date-time

The date on which this user was created.
email
string
email

The email address for this user.
firstName
string

The first name for this user.
id
number

The identifier for this user.
isStudioOwner read-only
boolean

Whether the authenticated user is the owner of the studio.
lastLogin nullable read-only
string
date-time

The date on which this user last logged in to the Studio Panel.
lastName
string

The last name for this user.
links required read-only
object
Links

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
string

The full name for this user.
permissions
string[]
unique
enum
  • account.payment-read
  • account.payment-withdrawal
  • account.read
  • account.update
  • brand-theme.create
  • brand-theme.read
  • brand-theme.update
  • brand.homepage-update
  • contact.create
  • contact.read
  • contact.update
  • contract.create
  • contract.read
  • contract.update
  • email-template.create
  • email-template.read
  • email-template.update
  • event-defaults.create
  • event-defaults.read
  • event-defaults.update
  • event-photo.create
  • event-photo.update
  • event.create
  • event.created-only
  • event.delete
  • event.read
  • event.update
  • invoice.create
  • invoice.read
  • invoice.update
  • mobile-app.create
  • mobile-app.read
  • mobile-app.update
  • order.read
  • order.update
  • playlist.read
  • playlist.update
  • price-sheet.create
  • price-sheet.read
  • price-sheet.update
  • report.event-visitors-read
  • report.invoices-read
  • report.items-read
  • report.orders-read
  • report.sales-read
  • tool.read
  • watermark.create
  • watermark.read
  • watermark.update

An array of permission identifiers indicating the permission levels this user has within the Studio Panel.

Permission Description
account.payment-read The user may view the studio account's plan & billing information.
account.payment-withdrawal The user may request payment withdrawals on behalf of the studio.
account.read The user may view studio account settings (e.g. contact info, users, etc.).
account.update The user may update studio account settings (e.g. contact info, users, etc.).
brand-theme.create The user may create themes.
brand-theme.read The user may view themes.
brand-theme.update The user may edit themes.
brand.homepage-update The user may edit the client galleries homepage for a brand.
contact.create The user may create contacts.
contact.read The user may view contacts.
contact.update The user may edit contacts.
contract.create The user may create contracts.
contract.read The user may view contracts.
contract.update The user may edit contracts.
email-template.create The user may create email templates and automation groups.
email-template.read The user may view email templates and automation groups.
email-template.update The user may edit email templates and automation groups.
event-defaults.create The user may create default settings for events.
event-defaults.read The user may view default settings for events.
event-defaults.update The user may edit default settings for events.
event-photo.create The user may create event photos.
event-photo.update The user may edit event photos.
event.create The user may create events.
event.created-only The user may only view/edit/delete events they created.
event.delete The user may delete events.
event.read The user may view events.
event.update The user may edit events.
invoice.create The user may create invoices.
invoice.read The user may view invoices.
invoice.update The user may edit invoices.
mobile-app.create The user may create mobile apps.
mobile-app.read The user may view mobile apps.
mobile-app.update The user may edit mobile apps.
order.read The user may view orders.
order.update The user may edit orders.
playlist.read The user may view music playlists.
playlist.update The user may edit music playlists.
price-sheet.create The user may create price sheets.
price-sheet.read The user may view price sheets.
price-sheet.update The user may edit price sheets.
report.event-visitors-read The user may view the "Event Visitors" report.
report.invoices-read The user may view the "Invoices" report.
report.items-read The user may view the "Top-Selling Items" report.
report.orders-read The user may view the "Orders" report.
report.sales-read The user may view the "Sales" report.
tool.read The user may view the available downloadable tools (i.e. Desktop Uploader).
watermark.create The user may create watermarks.
watermark.read The user may view watermarks.
watermark.update The user may edit watermarks.
signature
signature
Signature

A signature.
studio read-only
studio
Studio

The studio to which the authenticated user belongs.
type
string
enum
  • user

The type of object represented.
userStatus read-only
string

A human-readable string describing this user's status.
userStatusId
number

The numeric identifier for this user's status.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/AuthenticatedUser"
        }
      }
    },
    "description": "The authenticated user’s signature was successfully detached from the\nuser.",
    "headers": {
      "Content-Location": {
        "description": "The URL to the resource represented in the body of the response.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  }
}

Add a signature for the authenticated user

After creating a signature, you can attach that signature to the authenticated user using this resource with a PUT request.

put
/studio/me/signature

Example Request

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

An object containing the signature ID for the signature you wish to attach to the authenticated user.

application/vnd.shootproof+json
Property Description
signatureId
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

The signature identifier.

OpenAPI Schema

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

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "properties": {
          "signatureId": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Id"
              },
              {
                "description": "The signature identifier."
              }
            ]
          }
        },
        "type": "object"
      }
    }
  },
  "description": "An object containing the signature ID for the signature you wish to\nattach to the authenticated user.",
  "required": true
}

200 OK

The signature was successfully attached to the authenticated user.

Headers
Header Description
Content-Location
string
uri

The URL to the resource represented in the body of the response.
Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
created read-only
string
date-time

The date on which this user was created.
email
string
email

The email address for this user.
firstName
string

The first name for this user.
id
number

The identifier for this user.
isStudioOwner read-only
boolean

Whether the authenticated user is the owner of the studio.
lastLogin nullable read-only
string
date-time

The date on which this user last logged in to the Studio Panel.
lastName
string

The last name for this user.
links required read-only
object
Links

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
string

The full name for this user.
permissions
string[]
unique
enum
  • account.payment-read
  • account.payment-withdrawal
  • account.read
  • account.update
  • brand-theme.create
  • brand-theme.read
  • brand-theme.update
  • brand.homepage-update
  • contact.create
  • contact.read
  • contact.update
  • contract.create
  • contract.read
  • contract.update
  • email-template.create
  • email-template.read
  • email-template.update
  • event-defaults.create
  • event-defaults.read
  • event-defaults.update
  • event-photo.create
  • event-photo.update
  • event.create
  • event.created-only
  • event.delete
  • event.read
  • event.update
  • invoice.create
  • invoice.read
  • invoice.update
  • mobile-app.create
  • mobile-app.read
  • mobile-app.update
  • order.read
  • order.update
  • playlist.read
  • playlist.update
  • price-sheet.create
  • price-sheet.read
  • price-sheet.update
  • report.event-visitors-read
  • report.invoices-read
  • report.items-read
  • report.orders-read
  • report.sales-read
  • tool.read
  • watermark.create
  • watermark.read
  • watermark.update

An array of permission identifiers indicating the permission levels this user has within the Studio Panel.

Permission Description
account.payment-read The user may view the studio account's plan & billing information.
account.payment-withdrawal The user may request payment withdrawals on behalf of the studio.
account.read The user may view studio account settings (e.g. contact info, users, etc.).
account.update The user may update studio account settings (e.g. contact info, users, etc.).
brand-theme.create The user may create themes.
brand-theme.read The user may view themes.
brand-theme.update The user may edit themes.
brand.homepage-update The user may edit the client galleries homepage for a brand.
contact.create The user may create contacts.
contact.read The user may view contacts.
contact.update The user may edit contacts.
contract.create The user may create contracts.
contract.read The user may view contracts.
contract.update The user may edit contracts.
email-template.create The user may create email templates and automation groups.
email-template.read The user may view email templates and automation groups.
email-template.update The user may edit email templates and automation groups.
event-defaults.create The user may create default settings for events.
event-defaults.read The user may view default settings for events.
event-defaults.update The user may edit default settings for events.
event-photo.create The user may create event photos.
event-photo.update The user may edit event photos.
event.create The user may create events.
event.created-only The user may only view/edit/delete events they created.
event.delete The user may delete events.
event.read The user may view events.
event.update The user may edit events.
invoice.create The user may create invoices.
invoice.read The user may view invoices.
invoice.update The user may edit invoices.
mobile-app.create The user may create mobile apps.
mobile-app.read The user may view mobile apps.
mobile-app.update The user may edit mobile apps.
order.read The user may view orders.
order.update The user may edit orders.
playlist.read The user may view music playlists.
playlist.update The user may edit music playlists.
price-sheet.create The user may create price sheets.
price-sheet.read The user may view price sheets.
price-sheet.update The user may edit price sheets.
report.event-visitors-read The user may view the "Event Visitors" report.
report.invoices-read The user may view the "Invoices" report.
report.items-read The user may view the "Top-Selling Items" report.
report.orders-read The user may view the "Orders" report.
report.sales-read The user may view the "Sales" report.
tool.read The user may view the available downloadable tools (i.e. Desktop Uploader).
watermark.create The user may create watermarks.
watermark.read The user may view watermarks.
watermark.update The user may edit watermarks.
signature
signature
Signature

A signature.
studio read-only
studio
Studio

The studio to which the authenticated user belongs.
type
string
enum
  • user

The type of object represented.
userStatus read-only
string

A human-readable string describing this user's status.
userStatusId
number

The numeric identifier for this user's status.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/AuthenticatedUser"
        }
      }
    },
    "description": "The signature was successfully attached to the authenticated user.",
    "headers": {
      "Content-Location": {
        "description": "The URL to the resource represented in the body of the response.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Create a signature

post
/studio/signature

Example Request

Header Parameters

Property Description
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

Request Body

The signature to create.

application/vnd.shootproof+json
Property Description
signaturePaths
string

The SVG paths that define this signature.
svgViewbox
string

The SVG viewbox that defines the dimensions of this signature.
type
string
enum
  • signature
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.

{
  "content": {
    "application/vnd.shootproof+json": {
      "schema": {
        "$ref": "#/components/schemas/Signature"
      }
    }
  },
  "description": "The signature to create.",
  "required": true
}

201 Created

The newly-created signature.

Headers
Header Description
Location
string
uri

The URL to the newly-created signature.
Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
created read-only
string
date-time
Entity Creation Date

The date on which the entity was created.
id read-only
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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.
publicId read-only
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this signature (may be used in the portal website).
signaturePaths
string

The SVG paths that define this signature.
svgViewbox
string

The SVG viewbox that defines the dimensions of this signature.
type
string
enum
  • signature
Type

The type of resource represented.

400 Bad Request

Validation error response. Check the info.errors property in the response for more details.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
errors
object

If the error response is a result of validation errors, it will most likely be a 400 Bad Request response and contain this info.errors property. Each property name in the errors object is a property that failed validation. These properties contain objects with property names in the form of internal validation error message slugs paired with human-readable string values describing the validation failure. Each property may have multiple validation failure messages.
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.

OpenAPI Schema

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

{
  "201": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Signature"
        }
      }
    },
    "description": "The newly-created signature.",
    "headers": {
      "Location": {
        "description": "The URL to the newly-created signature.",
        "schema": {
          "format": "uri",
          "type": "string"
        }
      }
    }
  },
  "400": {
    "$ref": "#/components/responses/validationError"
  }
}

Get a signature

get
/studio/signature/{signatureId}

Example Request

Header Parameters

Property Description
Accept
string
enum
  • application/vnd.shootproof+json
  • image/svg+xml

Optionally, you may provide an Accept header with a value of image/svg+xml to be redirected to an SVG representation of the signature.
Authentication required
string

The bearer token used to make authenticated requests to the ShootProof Studio API. See the authorization guide for more information on how to obtain and use bearer tokens.

200 OK

The signature.

Response Body

When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.

Properties
Property Description
created read-only
string
date-time
Entity Creation Date

The date on which the entity was created.
id read-only
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

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.
publicId read-only
string
  • ^[a-fA-F0-9]{32}$

The public identifier for this signature (may be used in the portal website).
signaturePaths
string

The SVG paths that define this signature.
svgViewbox
string

The SVG viewbox that defines the dimensions of this signature.
type
string
enum
  • signature
Type

The type of resource represented.
Alternate Response Body

When the Content-Type of the response is image/svg+xml, the following properties will be available in the response body.

Properties
string
A signature represented as an SVG image.
A signature represented as an SVG image.
"<svg viewBox=\"0 0 430 150\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\">\n  <path stroke=\"black\" stroke-width=\"2\" fill=\"none\" shape-rendering=\"auto\" stroke-linejoin=\"round\" d=\"M125.5,66 L125.5,66 L126.5,66 L127.5,66 L127.5,66 L128.5,66 L129.5,66 L129.5,66 L129.5,66 L130.5,66 L130.5,66 L130.5,66 L131.5,66 L131.5,66 L132.5,65 L132.5,65 L132.5,65 L132.5,65\"></path>\n</svg>"

Error Response

API errors come in two kinds of varieties: 400s and 500s.

Any error with a status code of 400 to 499 is considered a client error. This means it’s usually an error you can handle in your app, and then resend a modified request to the ShootProof API to get a successful response.

An error in the range of 500 to 599, on the other hand, is a different story. These errors usually mean that a problem occured on the server and resending the request with modifications will not fix the issue.

Pay careful attention to the status codes. We try to stick as close as possible to their defined semantics. For a complete list of HTTP status codes, take a look at the official HTTP Status Code Registry.

Check out our errors guide for more information.

Response Body

When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.

Properties
Property Description
detail
string

A longer description of of the error encountered.
info
object

Additional information that may be provided to aid in error resolution.

Property Description
reason
string
enum
  • contract-not-ready-to-countersign
  • event-photo-count-limit
  • plan-does-not-allow-uploads

An optional reason for the error response.

In some cases, more information is required to convey information about the error to the client. In these cases, one of the following reason slugs may be used.

Reason Slug Description
contract-not-ready-to-countersign The contract is in a state that does not allow countersigning. Its status must be ready-to-countersign to perform this action.
event-photo-count-limit The event has reached the maximum number of photos allowed.
plan-does-not-allow-uploads The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows.
status
integer

The HTTP status code associated with this error.
title
string

A short description of the error encountered.
type
string
uri

A namespace URI uniquely identifying the error type.
Validation Error Example
{
  "detail": "There was a problem with your request. Please see `info` for more information.",
  "info": {
    "errors": {
      "type": {
        "isEmpty": "Value is required and can't be empty"
      }
    }
  },
  "status": 400,
  "title": "Bad Request",
  "type": "https://developer.shootproof.com/errors#error-bad-request"
}
Forbidden Error Example
{
  "detail": "You do not have permission to access the requested resource.",
  "status": 403,
  "title": "Forbidden",
  "type": "https://developer.shootproof.com/errors#error-forbidden"
}
Not Found Error Example
{
  "detail": "The requested resource could not be found.",
  "status": 404,
  "title": "Not Found",
  "type": "https://developer.shootproof.com/errors#error-not-found"
}
Server Error Example
{
  "detail": "An error occurred on the server. If this error continues to occur, please contact support.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://developer.shootproof.com/errors#error-server-error"
}
Unauthorized Error Example
{
  "detail": "No authorization credentials provided. You must provide an authorization token for this request.",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://developer.shootproof.com/errors#error-unauthorized"
}

OpenAPI Schema

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

{
  "200": {
    "content": {
      "application/vnd.shootproof+json": {
        "schema": {
          "$ref": "#/components/schemas/Signature"
        }
      },
      "image/svg+xml": {
        "examples": {
          "svg": {
            "summary": "A signature represented as an SVG image.",
            "value": "<svg viewBox=\"0 0 430 150\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\">\n  <path stroke=\"black\" stroke-width=\"2\" fill=\"none\" shape-rendering=\"auto\" stroke-linejoin=\"round\" d=\"M125.5,66 L125.5,66 L126.5,66 L127.5,66 L127.5,66 L128.5,66 L129.5,66 L129.5,66 L129.5,66 L130.5,66 L130.5,66 L130.5,66 L131.5,66 L131.5,66 L132.5,65 L132.5,65 L132.5,65 L132.5,65\"></path>\n</svg>"
          }
        },
        "schema": {
          "title": "A signature represented as an SVG image.",
          "type": "string"
        }
      }
    },
    "description": "The signature."
  },
  "default": {
    "$ref": "#/components/responses/defaultError"
  }
}