Brands use contracts for a variety of reasons and situations. ShootProof provides a flexible approach to contracts, allowing studios to choose when and if they need them, as well as attaching them to invoices and associating contacts to them.
/studio/brand/{brandId}/contractWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| Property | Description |
|---|---|
| filterContactId |
The contract contact ID by which to filter results. |
| filterExcludeLinkedToInvoice |
Indicates that contracts linked to invoice(s) should be excluded from the results. |
| filterExpirationDateEnd |
The contract expiration end date by which to filter results. If provided, only contracts that expire before midnight UTC of this date will be returned. |
| filterExpirationDateStart |
The contract expiration start date by which to filter results. If provided, only contracts that expire on or after midnight UTC of this date will be returned. |
| filterStatus |
The contract status by which to filter results. |
| page |
The page of results to return. |
| rows |
The number of rows to return on each page of results. |
| searchContactInfo |
Customer name or email address by which to filter results. |
| searchContractName |
Contract name by which to filter results. |
| sortBy |
The property by which items returned should be sorted. |
| sortType |
The direction in which sorting should occur. |
| Property | Description |
|---|---|
| Authentication required |
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 OKA collection of contracts.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||||||||||||||||||||||||||||
| 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.
|
||||||||||||||||||||||||||||||||||||||||
| type |
The type of resource represented. |
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/ContractCollection"
}
}
},
"description": "A collection of contracts."
}
}/studio/brand/{brandId}/contractWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The contract to create.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contactIds write-only |
An array of unique contact ids to link to contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| type |
The type of resource represented. |
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/Contract"
}
}
},
"description": "The contract to create.",
"required": true
}201 CreatedThe new contract.
| Header | Description |
|---|---|
| Location |
The URL to the new contract. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Contract"
}
}
},
"description": "The new contract.",
"headers": {
"Location": {
"description": "The URL to the new contract.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/templateWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| Property | Description |
|---|---|
| filterCreatedStart |
Filter contract templates by templates created after |
| filterExpirationDateEnd |
Filter contract templates by templates created before |
| page |
The page of results to return. |
| rows |
The number of rows to return on each page of results. |
| searchContractTemplateName |
Contract template name by which to filter results. |
| sortBy |
The property by which items returned should be sorted. |
| sortType |
The direction in which sorting should occur. |
| Property | Description |
|---|---|
| Authentication required |
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 OKA collection of contract templates.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||
| 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.
|
||||||||||||
| type |
The type of resource represented. |
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/ContractTemplateCollection"
}
}
},
"description": "A collection of contract templates."
}
}/studio/brand/{brandId}/contract/templateWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The contract template to create.
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
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/ContractTemplate"
}
}
},
"description": "The contract template to create.",
"required": true
}201 CreatedThe new contract template.
| Header | Description |
|---|---|
| Location |
The URL to the contract template that is located in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandTheme read-only |
A brand theme. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| created read-only |
The creation date of this contract template. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/ContractTemplate"
}
}
},
"description": "The new contract template.",
"headers": {
"Location": {
"description": "The URL to the contract template that is located in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/template/{contractTemplateId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractTemplateId required |
A contract template identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
204 No ContentThe resource was successfully deleted.
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"204": {
"$ref": "#/components/responses/deleteSuccess"
}
}/studio/brand/{brandId}/contract/template/{contractTemplateId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractTemplateId required |
A contract template identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKA contract template.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandTheme read-only |
A brand theme. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| created read-only |
The creation date of this contract template. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
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.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
{
"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"
}{
"detail": "You do not have permission to access the requested resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developer.shootproof.com/errors#error-forbidden"
}{
"detail": "The requested resource could not be found.",
"status": 404,
"title": "Not Found",
"type": "https://developer.shootproof.com/errors#error-not-found"
}{
"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"
}{
"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"
}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/ContractTemplate"
}
}
},
"description": "A contract template."
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Only provide those properties that you wish to update. All other properties will remain unchanged.
/studio/brand/{brandId}/contract/template/{contractTemplateId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractTemplateId required |
A contract template identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
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/ContractTemplate"
}
}
},
"required": true
}200 OKThe updated contract template.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandTheme read-only |
A brand theme. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| created read-only |
The creation date of this contract template. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/ContractTemplate"
}
}
},
"description": "The updated contract template."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/template/{contractTemplateId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractTemplateId required |
A contract template identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The updated contract template
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
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/ContractTemplate"
}
}
},
"description": "The updated contract template",
"required": true
}200 OKThe updated contract template.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| bodyHtml |
The HTML body of the contract template. |
| brandTheme read-only |
A brand theme. |
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| created read-only |
The creation date of this contract template. |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| languageCode |
The Unicode CLDR language tag for the language used in this contract template. |
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
| name |
The name for this contract template. |
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/ContractTemplate"
}
}
},
"description": "The updated contract template."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
204 No ContentThe resource was successfully deleted.
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"204": {
"$ref": "#/components/responses/deleteSuccess"
}
}/studio/brand/{brandId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKA contract
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
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.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
{
"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"
}{
"detail": "You do not have permission to access the requested resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developer.shootproof.com/errors#error-forbidden"
}{
"detail": "The requested resource could not be found.",
"status": 404,
"title": "Not Found",
"type": "https://developer.shootproof.com/errors#error-not-found"
}{
"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"
}{
"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"
}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/Contract"
}
}
},
"description": "A contract"
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Only provide those properties that you wish to update. All other properties will remain unchanged.
/studio/brand/{brandId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The contract object to update. Only provide those properties that need updating.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contactIds write-only |
An array of unique contact ids to link to contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| type |
The type of resource represented. |
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/Contract"
}
}
},
"description": "The contract object to update. Only provide those properties that need\nupdating.",
"required": true
}200 OKThe updated contract.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Contract"
}
}
},
"description": "The updated contract."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The contract object to update.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contactIds write-only |
An array of unique contact ids to link to contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| type |
The type of resource represented. |
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/Contract"
}
}
},
"description": "The contract object to update.",
"required": true
}200 OKThe updated contract.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Contract"
}
}
},
"description": "The updated contract."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/{contractId}/emailWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| Property | Description |
|---|---|
| Authentication required |
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. |
The contract email object used to send an email message.
| Property | Description |
|---|---|
| body |
The message to include in the body of the email. |
| buttonText |
The text for the call-to-action button in the email body. |
| headline |
The headline to use in the email body. |
| recipientEmails |
Email address(es) to send the email to. If provided, must be an array of valid email addresses. Optional, but may be required by child schemas. |
| subject |
The subject line for the email message. |
| type |
The type of resource represented. |
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/ContractEmail"
}
}
},
"description": "The contract email object used to send an email message.",
"required": true
}202 AcceptedOn success, we respond with the contract for which the email message was sent.
| Header | Description |
|---|---|
| Content-Location |
The URL to the contract that is located in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"202": {
"content": {
"application/vnd.shootproof+json": {
"schema": {
"$ref": "#/components/schemas/Contract"
}
}
},
"description": "On success, we respond with the contract for which the email message\nwas sent.",
"headers": {
"Content-Location": {
"description": "The URL to the contract that is located in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/contract/{contractId}/invoice/{invoiceId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| invoiceId required |
An invoice identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKThe contract from which the invoice was removed.
| Header | Description |
|---|---|
| Content-Location |
The URL to the contract that is located in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
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/Contract"
}
}
},
"description": "The contract from which the invoice was removed.",
"headers": {
"Content-Location": {
"description": "The URL to the contract that is located in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
}
}Associate the invoice identified by invoiceId in the path to the contract identified by contractId. This request does not require any body parameters.
/studio/brand/{brandId}/contract/{contractId}/invoice/{invoiceId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| invoiceId required |
An invoice identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKThe contract to which the invoice was added.
| Header | Description |
|---|---|
| Content-Location |
The URL to the contract that is located in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
404 Not FoundThe requested resource could not be found.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
409 ConflictIf the contract is already linked to a different invoice, we respond with a 409 Conflict response.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Contract"
}
}
},
"description": "The contract to which the invoice was added.",
"headers": {
"Content-Location": {
"description": "The URL to the contract that is located in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/notFoundError"
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "If the contract is already linked to a different invoice, we respond\nwith a `409 Conflict` response."
}
}Apply the signature identified by signatureId in the path to the contract identified by contractId. This request does not require any body parameters.
See "Get the authenticated user" for information on retrieving the authenticated user's signature.
/studio/brand/{brandId}/contract/{contractId}/signature/{signatureId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| signatureId required |
A signature identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKThe contract to which the signature was added.
| Header | Description |
|---|---|
| Content-Location |
The URL to the contract that is located in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| activity read-only |
A list of activities that have occurred with this contract. |
||||||||||||||
| bodyContainsMagicBlank read-only |
Indicates if the HTML body of the contract contains one or more 'magic blank' placeholder strings. |
||||||||||||||
| bodyHtml |
The HTML body of the contract. |
||||||||||||||
| brandTheme read-only |
A brand theme. |
||||||||||||||
| brandThemeId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| cancelationMessage nullable |
Optional cancelation message to include in studio-to-client email sent when contract status moves to canceled state. As of this writing, value only used on |
||||||||||||||
| contacts required read-only |
A collection of contacts associated with this contract |
||||||||||||||
| contractStatus |
The current status of the contract.
|
||||||||||||||
| contractTemplate required read-only | |||||||||||||||
| contractTemplateId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| created read-only |
The creation date of this contract. |
||||||||||||||
| expirationDate |
The date on which this contract expires. |
||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||
| invoices read-only |
An array of linked invoices. |
||||||||||||||
| isEditable |
Whether the contract is able to be edited. |
||||||||||||||
| isHidden |
Whether the contract has been marked 'hidden'. |
||||||||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this contract. |
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| name |
The name for this contract. |
||||||||||||||
| publicId read-only |
The public identifier for this contract (may be used in the portal website). |
||||||||||||||
| shootDate nullable |
This contract covers a photo shoot or event that took place on this date. |
||||||||||||||
| signatureClient nullable read-only |
The contract signature for the client. |
||||||||||||||
| signatureStudio nullable read-only |
The contract signature for the studio. |
||||||||||||||
| type |
The type of resource represented. |
409 ConflictThe request could not be completed due to a conflict with the current state of the target resource.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Contract"
}
}
},
"description": "The contract to which the signature was added.",
"headers": {
"Content-Location": {
"description": "The URL to the contract that is located in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"409": {
"$ref": "#/components/responses/conflictError"
}
}Removes the linked contract from the invoice.
/studio/brand/{brandId}/invoice/{invoiceId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| invoiceId required |
An invoice identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKResponds with the invoice on success.
| Header | Description |
|---|---|
| Content-Location |
The URL of the invoice in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| acceptedPaymentTypes |
An array of payment types this invoice accepts. |
||||||||
| activity read-only |
A list of activities that have occurred with this invoice. |
||||||||
| brandTheme |
A brand theme. |
||||||||
| brandThemeId |
The identifier for the brand theme this invoice uses. |
||||||||
| cancelationMessage |
Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state. |
||||||||
| contact required read-only |
The base definition for a contact. |
||||||||
| contactId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||
| contracts read-only |
An array of linked contracts. |
||||||||
| created read-only |
The creation date of this invoice. |
||||||||
| creditCardOnFile required nullable |
The credit card on file for this invoice, if applicable. |
||||||||
| creditCardTransactions read-only |
An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts. |
||||||||
| currencyCode read-only |
Identifies the currency used for this invoice. |
||||||||
| currencySymbol read-only |
The currency symbol for the currency used for this invoice. |
||||||||
| customInvoiceId read-only |
A client-facing identifier for this invoice, starting at 1000 for each studio. |
||||||||
| discountTotal read-only |
The total amount of all discounts applied to this invoice. |
||||||||
| discounts |
An array of discounts applied to this invoice template. |
||||||||
| dueTotal read-only |
The total amount of this invoice that is due. |
||||||||
| emailAutomationGroupId nullable |
The identifier for the email automation group this invoice uses. |
||||||||
| finalDueDate nullable read-only |
The date on which this invoice must be paid in full. |
||||||||
| grandTotal |
The invoice grand total. |
||||||||
| id |
The identifier for this invoice. |
||||||||
| installments |
An array of invoice installments, defining the installment schedule for this invoice. Installments are required for invoices having a grandTotal greater than zero, but disallowed for Invoices having a grandTotal of zero. |
||||||||
| invoiceRetainerLabel nullable |
This label represents how the studio wishes to refer to the initial payment represented by The following labels are available. You are responsible for displaying appropriate human-readable strings for these labels, translated for your audience.
|
||||||||
| invoiceStatus |
The human-readable name of the current status of this invoice. |
||||||||
| invoiceTemplateId nullable |
The identifier for the invoice template from which this invoice was created. |
||||||||
| isHidden |
Whether or not the invoice should be hidden |
||||||||
| issueDate |
The date on which this invoice was issued. |
||||||||
| items |
An array of line items for this invoice. |
||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this invoice. |
||||||||
| 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. |
||||||||
| notesToClient |
Notes to display on the invoice for the client. |
||||||||
| paidTotal read-only |
The total amount of this invoice that has been paid. |
||||||||
| paymentConfirmationText |
A message sent to the client upon receipt of payment. |
||||||||
| payments read-only |
An array of invoice payments, showing a history of all payments made on this invoice. |
||||||||
| publicId read-only |
The public identifier for this invoice (may be used in the portal website). |
||||||||
| retainerFixedAmount nullable |
Suggested fixed amount of retainer. If a retainer is defined, one of |
||||||||
| retainerPercent nullable |
Suggested amount of retainer in a percentage from 1-100. If a retainer is defined, one of |
||||||||
| retainerTotal read-only |
The total amount for the invoice retainer. |
||||||||
| salesTaxPercent nullable |
A decimal number from 0-100, specifying the sales tax percentage. |
||||||||
| salesTaxTitle nullable |
A label to apply to the sales tax percent on the invoice when viewed by the client. |
||||||||
| salesTaxTotal |
The total amount of sales tax on the invoice. |
||||||||
| subtotal |
The invoice subtotal. |
||||||||
| taxableSubtotal |
The taxable subtotal of the invoice, based on its taxable items. |
||||||||
| type |
The type of object represented. |
404 Not FoundThe requested resource could not be found.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Invoice"
}
}
},
"description": "Responds with the invoice on success.",
"headers": {
"Content-Location": {
"description": "The URL of the invoice in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/notFoundError"
}
}Links the given contract to the invoice.
/studio/brand/{brandId}/invoice/{invoiceId}/contract/{contractId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| contractId required |
A contract identifier. |
| invoiceId required |
An invoice identifier. |
| Property | Description |
|---|---|
| Authentication required |
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 OKResponds with the invoice on success.
| Header | Description |
|---|---|
| Content-Location |
The URL of the invoice in the response body. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| acceptedPaymentTypes |
An array of payment types this invoice accepts. |
||||||||
| activity read-only |
A list of activities that have occurred with this invoice. |
||||||||
| brandTheme |
A brand theme. |
||||||||
| brandThemeId |
The identifier for the brand theme this invoice uses. |
||||||||
| cancelationMessage |
Optional cancelation message to include in studio-to-client emails sent when invoice status moves to canceled state. |
||||||||
| contact required read-only |
The base definition for a contact. |
||||||||
| contactId |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||
| contracts read-only |
An array of linked contracts. |
||||||||
| created read-only |
The creation date of this invoice. |
||||||||
| creditCardOnFile required nullable |
The credit card on file for this invoice, if applicable. |
||||||||
| creditCardTransactions read-only |
An array of invoice credit card transactions, showing all attempts to charge a card for this invoice, including approved/declined attempts. |
||||||||
| currencyCode read-only |
Identifies the currency used for this invoice. |
||||||||
| currencySymbol read-only |
The currency symbol for the currency used for this invoice. |
||||||||
| customInvoiceId read-only |
A client-facing identifier for this invoice, starting at 1000 for each studio. |
||||||||
| discountTotal read-only |
The total amount of all discounts applied to this invoice. |
||||||||
| discounts |
An array of discounts applied to this invoice template. |
||||||||
| dueTotal read-only |
The total amount of this invoice that is due. |
||||||||
| emailAutomationGroupId nullable |
The identifier for the email automation group this invoice uses. |
||||||||
| finalDueDate nullable read-only |
The date on which this invoice must be paid in full. |
||||||||
| grandTotal |
The invoice grand total. |
||||||||
| id |
The identifier for this invoice. |
||||||||
| installments |
An array of invoice installments, defining the installment schedule for this invoice. Installments are required for invoices having a grandTotal greater than zero, but disallowed for Invoices having a grandTotal of zero. |
||||||||
| invoiceRetainerLabel nullable |
This label represents how the studio wishes to refer to the initial payment represented by The following labels are available. You are responsible for displaying appropriate human-readable strings for these labels, translated for your audience.
|
||||||||
| invoiceStatus |
The human-readable name of the current status of this invoice. |
||||||||
| invoiceTemplateId nullable |
The identifier for the invoice template from which this invoice was created. |
||||||||
| isHidden |
Whether or not the invoice should be hidden |
||||||||
| issueDate |
The date on which this invoice was issued. |
||||||||
| items |
An array of line items for this invoice. |
||||||||
| languageCode |
The Unicode CLDR language tag for the language used in this invoice. |
||||||||
| 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. |
||||||||
| notesToClient |
Notes to display on the invoice for the client. |
||||||||
| paidTotal read-only |
The total amount of this invoice that has been paid. |
||||||||
| paymentConfirmationText |
A message sent to the client upon receipt of payment. |
||||||||
| payments read-only |
An array of invoice payments, showing a history of all payments made on this invoice. |
||||||||
| publicId read-only |
The public identifier for this invoice (may be used in the portal website). |
||||||||
| retainerFixedAmount nullable |
Suggested fixed amount of retainer. If a retainer is defined, one of |
||||||||
| retainerPercent nullable |
Suggested amount of retainer in a percentage from 1-100. If a retainer is defined, one of |
||||||||
| retainerTotal read-only |
The total amount for the invoice retainer. |
||||||||
| salesTaxPercent nullable |
A decimal number from 0-100, specifying the sales tax percentage. |
||||||||
| salesTaxTitle nullable |
A label to apply to the sales tax percent on the invoice when viewed by the client. |
||||||||
| salesTaxTotal |
The total amount of sales tax on the invoice. |
||||||||
| subtotal |
The invoice subtotal. |
||||||||
| taxableSubtotal |
The taxable subtotal of the invoice, based on its taxable items. |
||||||||
| type |
The type of object represented. |
404 Not FoundThe requested resource could not be found.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
409 ConflictIf the invoice is linked to a different contract, then we respond with a 409 Conflict response.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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/Invoice"
}
}
},
"description": "Responds with the invoice on success.",
"headers": {
"Content-Location": {
"description": "The URL of the invoice in the response body.",
"schema": {
"format": "uri",
"type": "string"
}
}
}
},
"404": {
"$ref": "#/components/responses/notFoundError"
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "If the invoice is linked to a different contract, then we respond\nwith a `409 Conflict` response."
}
}/studio/signatureWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Authentication required |
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. |
The signature to create.
| Property | Description |
|---|---|
| signaturePaths |
The SVG paths that define this signature. |
| svgViewbox |
The SVG viewbox that defines the dimensions of this signature. |
| type |
The type of resource represented. |
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 CreatedThe newly-created signature.
| Header | Description |
|---|---|
| Location |
The URL to the newly-created signature. |
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| created read-only |
The date on which the entity was created. |
| id read-only |
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. |
| publicId read-only |
The public identifier for this signature (may be used in the portal website). |
| signaturePaths |
The SVG paths that define this signature. |
| svgViewbox |
The SVG viewbox that defines the dimensions of this signature. |
| type |
The type of resource represented. |
400 Bad RequestValidation error response. Check the info.errors property in the response for more details.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||||
| title |
A short description of the error encountered. |
||||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
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"
}
}/studio/signature/{signatureId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| Accept |
Optionally, you may provide an |
| Authentication required |
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 OKThe signature.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| created read-only |
The date on which the entity was created. |
| id read-only |
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. |
| publicId read-only |
The public identifier for this signature (may be used in the portal website). |
| signaturePaths |
The SVG paths that define this signature. |
| svgViewbox |
The SVG viewbox that defines the dimensions of this signature. |
| type |
The type of resource represented. |
When the Content-Type of the response is image/svg+xml, the following properties will be available in the response body.
"<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>"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.
When the Content-Type of the response is application/problem+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail |
A longer description of of the error encountered. |
||||||||||||
| info |
Additional information that may be provided to aid in error resolution.
|
||||||||||||
| status |
The HTTP status code associated with this error. |
||||||||||||
| title |
A short description of the error encountered. |
||||||||||||
| type |
A namespace URI uniquely identifying the error type. |
{
"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"
}{
"detail": "You do not have permission to access the requested resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developer.shootproof.com/errors#error-forbidden"
}{
"detail": "The requested resource could not be found.",
"status": 404,
"title": "Not Found",
"type": "https://developer.shootproof.com/errors#error-not-found"
}{
"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"
}{
"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"
}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"
}
}