Link relations and hypermedia are the keys to understanding, interacting with, and traversing the ShootProof API. Links are described in detail in the links object.
You may find that some relationships are templated. These templated URLs follow the rules of RFC 6570 to define template parameters that may be used to construct URLs from data.
While we provide templated URLs for convenience, whenever possible, use the URLs our API provides in responses, rather than constructing them from templates.
Refer to the public link relations registry for more information and a list of additional link relationships.
Relation Name | Description |
---|---|
alternate |
The target URL is an alternate representation of the current resource. Usually, this will include a |
brand |
The target URL is a brand or collection of brands related to the current resource. |
brand-context |
The target URL indicates the brand authorized for the current context, based on the access token. This relationship is deprecated and should not be relied on. Access tokens obtained through the OAuth flow are not tied to a specific brand. |
brand-homepage |
The target URL is Client Gallery homepage for the brand related to the current resource. |
brand-theme |
The target URL is a brand theme or collection of brand themes related to the current resource. |
canonical |
The target URL is the primary location of the current resource (i.e. the current resource may be subordinate to another resource, and the target URL indicates its permanent location). |
children |
The target URL is a collection of resources that is subordinate to the current resource. That is, the current resource is a parent of the children, and the children belong to this resource. |
client |
The target URL is the location of the current resource in the Client Galleries website. The media type of the target URL is assumed to be |
client-admin |
The target URL is the location of the studio client admin for the current resource in the Client Galleries website. The media type of the target URL is assumed to be |
collection |
The target URL is the location of a collection of similar resources of which the current resource is a member. |
contact |
The target URL is a contact or collection of contacts related to the current resource. |
contact-referee |
The target URL is a list of available contacts that may be selected as referred by the current resource. |
contact-referred-by |
The target URL is a list of available contacts that may be selected as having referred the current resource. |
contact-tag |
The target URL is a list of contact tags available to apply to the current resource. |
contract |
The target URL is a contract or collection of contracts related to the current resource. |
contract-signature |
The target URL is a contract signature or collection of contract signatures related to the current resource. |
contract-template |
The target URL is a contract template or collection of contract templates related to the current resource. |
derivedfrom |
The target URL is the location of a resource from which the current resource is derived (or a subset of). |
The target URL may be an email message or collection of email messages related to the current resource. It may also be used to create an email message related to the current resource. |
|
email-automation-group |
The target URL is an email automation group or collection of email automation groups related to the current resource. |
email-template |
The target URL is an email template or collection of email templates related to the current resource. |
email-template-type |
The target URL is an email template type or collection of email template types related to the current resource. |
event |
The target URL is an event or collection of events related to the current resource. |
event-album |
The target URL is an event album or collection of event albums related to the current resource. |
event-album-passwords |
The target URL is a listing of all passwords for all event albums related to the current resource. If the |
event-album-photo |
The target URL is an event album photo or collection of event album photos related to the current resource. |
event-archive-cost |
The target URL is an event archive cost related to the current resource. |
event-category |
The target URL is an event category or collection of event categories related to the current resource. |
event-contact |
The target URL is an event contact or collection of event contacts related to the current resource. |
event-contact-photo-favorite |
The target URL is a photo or collection of photos related to the current resource and favorited by the context event contact. |
event-contact-photo-hidden |
The target URL is a photo or collection of photos related to the current resource and hidden by the context event contact. |
event-contact-photo-share |
The target URL is a photo or collection of photos related to the current resource and shared by the context event contact. |
event-contact-photo-tag |
The target URL is a photo or collection of photos related to the current resource and tagged by the context event contact. When |
event-defaults |
The target URL is a set of event defaults settings or collection of more than one set of event defaults settings related to the current resource. |
event-photo |
The target URL is an event photo or collection of event photos related to the current resource. |
event-photo-original |
The target URL is the original uploaded photo related to the current resource. |
event-photo-upload-policy |
The target URL may be used to generate an event photo upload policy related to the current resource. This is the first step in the process to upload new event photos to an event resource. |
event-visitor |
The target URL is an event visitor or collection of event visitors related to the current resource. |
invoice |
The target URL is an invoice or collection of invoices related to the current resource. |
invoice-credit-card |
The target URL may be used to manipulate the invoice credit card related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used. |
invoice-item-template |
The target URL is an invoice item template or collection of invoice item templates related to the current resource. |
invoice-payment |
The target URL may be used to make an invoice payment related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used. |
invoice-refund |
The target URL may be used to make an invoice refund related to the current resource. The current resource may be an invoice or may have an invoice related to it, for which the target URL may be used. |
invoice-template |
The target URL is an invoice template or collection of invoice templates related to the current resource. |
lab |
The target URL is a lab related to the current resource. |
lab-catalog |
The target URL is a lab catalog or collection of lab catalogs related to the current resource. |
lab-catalog-self-fulfilled |
The target URL is a self-fulfilled lab catalog or collection of self-fulfilled lab catalogs related to the current resource. |
lab-catalog-shipping-option |
The target URL is a lab catalog shipping option or collection of lab catalog shipping options related to the current resource. |
market-department |
The target URL is a market department or collection of market departments related to the current resource. |
market-product |
The target URL is a market product or collection of market products related to the current resource. |
market-vendor |
The target URL is a market vendor or collection of market vendors related to the current resource. |
me |
The target URL is the profile for the authenticated access token. Usually this is the Studio Panel user who has granted authorization and an access token. |
mobile-app |
The target URL is a mobile app or collection of mobile apps related to the current resource. |
order |
The target URL is an order or collection of orders related to the current resource. |
order-payment |
The target URL is an order payment or collection of order payments related to the current resource. |
parent |
The target URL identifies a parent resource for the current resource. It is often used on subordinate resources or collections to identify the resource to which they belong. |
playlist |
The target URL is a music playlist or collection of music playlists related to the current resource. |
portal |
The target URL is the location of the current resource in the Studio-Client Portal website. The media type of the target URL is assumed to be |
price-sheet |
The target URL is a price sheet or collection of price sheets related to the current resource. |
price-sheet-discount |
The target URL is a price sheet discount or collection of price sheet discounts related to the current resource. |
price-sheet-event |
The target URL is an event associated to a price sheet or a collection of events associated to a price sheet related to the current resource. |
price-sheet-item |
The target URL is a collection of price sheet items related to the current resource. |
price-sheet-item-image |
The target URL is a collection of images associated to a price sheet item related to the current resource. |
price-sheet-shipping-option |
The target URL is a price sheet shipping option or collection of price sheet shipping options related to the current resource. |
search |
The target URL is a location that may be used to search or filter results for the current resource. |
self |
The target URL is the current resource's own location. It may not be the canonical location of the resource; if this is the case, the |
shorturl |
The target URL may be used to create a shortened URL for use with social sharing. |
signature |
The target URL is a signature or collection of signatures related to the current resource. |
tax-profile |
The target URL is a tax profile or collection of tax profiles related to the current resource. |
token-replacement |
The target URL may be used to replace tokens in the current resource. Tokens available to pass for replacement are indicated by the URI template parameters. |
watermark |
The target URL is a watermark or collection of watermarks related to the current resource. |