There are a handful of things you can do through the ShootProof API that don’t fit in with any of the other categories, so we’ve listed them here.
/studio/brand/{brandId}/notificationWe’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| Property | Description |
|---|---|
| filterDismissed |
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. |
| 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 notifications.
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/NotificationCollection"
}
}
},
"description": "A collection of notifications."
}
}/studio/brand/{brandId}/notification/{notificationId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| notificationId required |
A notification 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 notification.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attributes nullable read-only deprecated |
Attributes are key-value pairs of data related to the notification. WARNING! This is a free-form bag of unstructured data. The properties and values should not be relied upon by implementations; they are subject to change. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created read-only |
The date on which the entity was created. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| descriptor read-only |
The value of the descriptor varies among notification types. In general, the descriptor may be used as a label for the entity described in the notification. For orders and invoices, the descriptor is often the total currency amount related to the notification. For contracts and events, the descriptor is the name of the contract or event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dismissed |
If the notification is dismissed, this will be |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message read-only |
The message may be used as the notification text. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationGroup read-only |
The notification group refers to the type of entity this notification relates to. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationType read-only |
A string identifier to indicate the type of notification described by this entity. This identifier may be one of the following strings
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/Notification"
}
}
},
"description": "A notification."
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Only provide those properties that you wish to update. All other properties will remain unchanged.
/studio/brand/{brandId}/notification/{notificationId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| notificationId required |
A notification 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 notification object to update. Only provide those properties that need updating.
| Property | Description |
|---|---|
| dismissed |
If the notification is dismissed, this will be |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| 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/Notification"
}
}
},
"description": "The notification object to update. Only provide those properties that need\nupdating.",
"required": true
}200 OKThe updated notification.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attributes nullable read-only deprecated |
Attributes are key-value pairs of data related to the notification. WARNING! This is a free-form bag of unstructured data. The properties and values should not be relied upon by implementations; they are subject to change. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created read-only |
The date on which the entity was created. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| descriptor read-only |
The value of the descriptor varies among notification types. In general, the descriptor may be used as a label for the entity described in the notification. For orders and invoices, the descriptor is often the total currency amount related to the notification. For contracts and events, the descriptor is the name of the contract or event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dismissed |
If the notification is dismissed, this will be |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message read-only |
The message may be used as the notification text. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationGroup read-only |
The notification group refers to the type of entity this notification relates to. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationType read-only |
A string identifier to indicate the type of notification described by this entity. This identifier may be one of the following strings
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/Notification"
}
}
},
"description": "The updated notification."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/brand/{brandId}/notification/{notificationId}We’ve got some helpful examples coming your way soon. Stay tuned!
| Property | Description |
|---|---|
| brandId required |
The brand identifier. |
| notificationId required |
A notification 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. |
A notification.
| Property | Description |
|---|---|
| dismissed |
If the notification is dismissed, this will be |
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| 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/Notification"
}
}
},
"description": "A notification.",
"required": true
}200 OKThe updated notification.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| attributes nullable read-only deprecated |
Attributes are key-value pairs of data related to the notification. WARNING! This is a free-form bag of unstructured data. The properties and values should not be relied upon by implementations; they are subject to change. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created read-only |
The date on which the entity was created. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| descriptor read-only |
The value of the descriptor varies among notification types. In general, the descriptor may be used as a label for the entity described in the notification. For orders and invoices, the descriptor is often the total currency amount related to the notification. For contracts and events, the descriptor is the name of the contract or event. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dismissed |
If the notification is dismissed, this will be |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message read-only |
The message may be used as the notification text. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationGroup read-only |
The notification group refers to the type of entity this notification relates to. For example, if the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notificationType read-only |
A string identifier to indicate the type of notification described by this entity. This identifier may be one of the following strings
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
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/Notification"
}
}
},
"description": "The updated notification."
},
"400": {
"$ref": "#/components/responses/validationError"
},
"default": {
"$ref": "#/components/responses/defaultError"
}
}Returns messages intended to display on the main interface. Dashboard messages are short indications of recent events (orders placed, contracts signed, lab orders shipped), suggestions to the user, etc. They are more "tweet" sized and not "email" sized messages.
/studio/dashboard-messageWe’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. |
200 OKList of current dashboard messages.
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. |
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": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"properties": {
"items": {
"items": {
"properties": {
"active": {
"description": "Indication of whether the message is active or not.\nShould only be displayed if true.",
"example": true,
"type": "boolean"
},
"backgroundImageUrl": {
"description": "URL of a background image intended to cover the\nentire display of the message",
"example": null,
"type": "string"
},
"callToActionLabel": {
"description": "Text to display on the call-to-action\nbutton/icon/method.",
"example": "Click to go to the Thing",
"type": "string"
},
"callToActionUrl": {
"description": "The URL the user should be transferred to on\nactivating the call-to-action button/icon/method.",
"example": "https://www.shootproof.com/",
"type": "string"
},
"country": {
"description": "ISO country code where the message applies",
"example": "US",
"type": "string"
},
"created": {
"description": "Creation date/time",
"example": "2019-05-23T17:42:00.000Z",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Main body text of the message",
"example": "An important thing has happened that you should be\naware of. Since you might not be aware of it, we\nmade you this message to call your attention to it.",
"type": "string"
},
"displayOrder": {
"description": "A numeric indicator of how to sort messages for\ndisplay. Display smaller numbers before larger\nnumbers. Weights may not be continious (5, 10, 20,\n30, 50, 100, 250, 500, 600, 1000, etc.)",
"example": 10,
"type": "string"
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/Id"
}
]
},
"imageUrl": {
"description": "URL of an icon for display with message",
"example": null,
"type": "string"
},
"lastUpdated": {
"description": "Last update date/time",
"example": "2019-05-23T17:42:00.000Z",
"format": "date-time",
"type": "string"
},
"learnMoreLabel": {
"description": "Text to display on a link/icon for users to get\nmore information about the notification.\nActivating it should transfer the user to the\nlearnMoreUrl.",
"example": "Learn About Things",
"type": "string"
},
"learnMoreUrl": {
"description": "URL where a user can find more information about\nthe notification without triggering an action.",
"example": "https://www.shootproof.com/help",
"type": "string"
},
"required": {
"description": "Indicates if displaying this message is mandatory",
"example": true,
"type": "boolean"
},
"title": {
"description": "Headline, masthead, or title of message",
"example": "A Thing To Be Aware Of",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"dashboard-message"
]
}
]
},
"weight": {
"description": "A numeric indicator of how important a message\nis compared to other messages. Useful to determine\nwhich messages to not display if insufficient\nspace is available to display all messages.",
"example": 10,
"type": "integer"
}
},
"required": [
"type",
"id",
"title",
"description",
"country",
"required",
"active",
"weight",
"displayOrder",
"callToActionUrl",
"callToActionLabel",
"learnMoreUrl",
"learnMoreLabel",
"imageUrl",
"backgroundImageUrl",
"created",
"lastUpdated"
],
"type": "object"
},
"title": "Language",
"type": "array"
},
"type": {
"enum": [
"dashboard-message-collection"
],
"example": "dashboard-message-collection"
}
}
}
]
}
}
},
"description": "List of current dashboard messages."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/studio/languageWe’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. |
200 OKSupported languages.
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": {
"allOf": [
{
"$ref": "#/components/schemas/List"
},
{
"properties": {
"items": {
"items": {
"properties": {
"code": {
"description": "The language code.",
"example": "en_US",
"type": "string"
},
"name": {
"description": "The language name.",
"example": "English (US)",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"language"
]
}
]
}
},
"required": [
"type",
"code",
"name"
],
"type": "object"
},
"title": "Language",
"type": "array"
},
"type": {
"enum": [
"language-collection"
],
"example": "language-collection"
}
}
}
]
}
}
},
"description": "Supported languages."
}
}/studio/shorturlWe’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 URL to shorten.
| Property | Description |
|---|---|
| type |
The type of resource represented. |
| url |
The URL to shorten. |
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/Shorturl"
}
}
},
"description": "The URL to shorten.",
"required": true
}200 OKThe shortened URL.
When the Content-Type of the response is application/vnd.shootproof+json, the following properties will be available in the response body.
| Property | Description |
|---|---|
| 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. |
| shorturl read-only |
The shortened form of |
| type |
The type of resource represented. |
| url |
The URL to shorten. |
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/Shorturl"
}
}
},
"description": "The shortened URL."
},
"400": {
"$ref": "#/components/responses/validationError"
}
}/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"
}
}