SmugMug API - Highlight image for a folder, album, or page

Response [200 Ok]

Uri /api/v2/highlight/node/dWcn5
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object

Image [1 of 1]
/api/v2/image/smj2FmM-0

Uri /api/v2/image/smj2FmM-0
UriDescription Image by key
Altitude 0
CanBuy false
CanEdit false
CanShare true
Caption empty string
Collectable true
Comments true
Date 2015-09-02T16:59:50+00:00
FileName DSC_1592 sq-sig 200ppi copy.jpg
Format JPG
Hidden false
ImageKey smj2FmM
IsArchive false
IsVideo false
KeywordArray
Array [1]
0 flower
Keywords flower
LastUpdated 2015-09-02T18:24:38+00:00
Latitude 0.00000000000000
Longitude 0.00000000000000
OriginalHeight 2400
OriginalWidth 2400
Processing false
Protected true
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-smj2FmM/0/Th/i-smj2FmM-Th.jpg
Title empty string
UploadKey 4323287891
Watermark No
Watermarked false

Formatted Values

Caption [html, text]

html empty string
text empty string

FileName [html, text]

html DSC_1592 sq-sig 200ppi copy.jpg
text DSC_1592 sq-sig 200ppi copy.jpg

Uris

ImageComments
/api/v2/image/smj2FmM!comments

Uri /api/v2/image/smj2FmM!comments
UriDescription Comments on image
EndpointType ImageComments
Locator Comment
LocatorType Objects

ImagePricelistExclusions
/api/v2/image/smj2FmM!pricelistexclusions

Uri /api/v2/image/smj2FmM!pricelistexclusions
UriDescription Pricelist information for an image
EndpointType ImagePricelistExclusions
Locator ImagePricelistExclusions
LocatorType Object

ImagePrices
/api/v2/image/smj2FmM!prices

Uri /api/v2/image/smj2FmM!prices
UriDescription Purchasable Skus
EndpointType ImagePrices
Locator CatalogSkuPrice
LocatorType Objects

ImageSizeDetails
/api/v2/image/smj2FmM-0!sizedetails

Uri /api/v2/image/smj2FmM-0!sizedetails
UriDescription Detailed size information for image
EndpointType ImageSizeDetails
Locator ImageSizeDetails
LocatorType Object

ImageSizes
/api/v2/image/smj2FmM-0!sizes

Uri /api/v2/image/smj2FmM-0!sizes
UriDescription Sizes available for image
EndpointType ImageSizes
Locator ImageSizes
LocatorType Object

LargestImage
/api/v2/image/smj2FmM-0!largestimage

Uri /api/v2/image/smj2FmM-0!largestimage
UriDescription Largest size available for image
EndpointType LargestImage
Locator LargestImage
LocatorType Object

PointOfInterest
/api/v2/image/smj2FmM!pointofinterest

Uri /api/v2/image/smj2FmM!pointofinterest
UriDescription Point of interest for image
EndpointType PointOfInterest
Locator PointOfInterest
LocatorType Object

PointOfInterestCrops
/api/v2/image/smj2FmM!poicrops

Uri /api/v2/image/smj2FmM!poicrops
UriDescription PointOfInterest Crops for image
EndpointType PointOfInterestCrops
Locator PointOfInterestCrops
LocatorType List

Regions
/api/v2/image/smj2FmM!regions

Uri /api/v2/image/smj2FmM!regions
UriDescription Regions for image
EndpointType Regions
Locator Region
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.02486

Request

Uri /api/v2/highlight/node/dWcn5
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /highlight
  • /
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/highlight/node/dWcn5"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "highlight"
            },
            {
                "type": "singleparam",
                "param_name": "kind",
                "param_value": "node"
            },
            {
                "type": "singleparam",
                "param_name": "id",
                "param_value": "dWcn5"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/highlight/node/dWcn5",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "",
            "Keywords": "flower",
            "KeywordArray": [
                "flower"
            ],
            "Watermark": "No",
            "Latitude": "0.00000000000000",
            "Longitude": "0.00000000000000",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/photos/i-smj2FmM/0/Th/i-smj2FmM-Th.jpg",
            "FileName": "DSC_1592 sq-sig 200ppi copy.jpg",
            "Processing": false,
            "UploadKey": "4323287891",
            "Date": "2015-09-02T16:59:50+00:00",
            "Format": "JPG",
            "OriginalHeight": 2400,
            "OriginalWidth": 2400,
            "LastUpdated": "2015-09-02T18:24:38+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": false,
            "Protected": true,
            "Watermarked": false,
            "ImageKey": "smj2FmM",
            "CanShare": true,
            "Comments": true,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "",
                    "text": ""
                },
                "FileName": {
                    "html": "DSC_1592 sq-sig 200ppi copy.jpg",
                    "text": "DSC_1592 sq-sig 200ppi copy.jpg"
                }
            },
            "Uri": "/api/v2/image/smj2FmM-0",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/smj2FmM-0!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/smj2FmM-0!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/smj2FmM-0!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/smj2FmM!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/smj2FmM!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/smj2FmM!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageComments": {
                    "Uri": "/api/v2/image/smj2FmM!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on image",
                    "EndpointType": "ImageComments"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/smj2FmM!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                },
                "ImagePricelistExclusions": {
                    "Uri": "/api/v2/image/smj2FmM!pricelistexclusions",
                    "Locator": "ImagePricelistExclusions",
                    "LocatorType": "Object",
                    "UriDescription": "Pricelist information for an image",
                    "EndpointType": "ImagePricelistExclusions"
                }
            }
        },
        "UriDescription": "Highlight image for a folder, album, or page",
        "EndpointType": "HighlightImage",
        "Timing": {
            "Total": {
                "time": 0.02486,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}