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

Response [200 Ok]

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

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

Uri /api/v2/image/xGmGnvQ-0
UriDescription Image by key
Altitude 0
ArchivedMD5 fc255b3202b65d8c25d7bc084662f8af
ArchivedSize 8192624
ArchivedUri https://photos.smugmug.com/THOMAS-FARTHING-LDN-SS16/i-xGmGnvQ/0/6a40d56f/D/DSCF1541-D.jpg
CanBuy false
CanEdit false
CanShare true
Caption empty string
Collectable true
Comments true
Date 2016-06-30T15:43:03+00:00
FileName DSCF1541.jpg
Format JPG
Hidden false
ImageKey xGmGnvQ
IsArchive false
IsVideo false
KeywordArray
Array [0]
Keywords empty string
LastUpdated 2016-06-30T15:43:08+00:00
Latitude 0.00000000000000
Longitude 0.00000000000000
OriginalHeight 4000
OriginalSize 8192624
OriginalWidth 6000
Processing false
Protected false
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-xGmGnvQ/0/Th/i-xGmGnvQ-Th.jpg
Title empty string
UploadKey 5036723530
Watermark No
Watermarked false

Formatted Values

Caption [html, text]

html empty string
text empty string

FileName [html, text]

html DSCF1541.jpg
text DSCF1541.jpg

Uris

ImageComments /api/v2/image/xGmGnvQ!comments
ImagePricelistExclusions /api/v2/image/xGmGnvQ!pricelistexclusions
ImagePrices /api/v2/image/xGmGnvQ!prices
ImageSizeDetails /api/v2/image/xGmGnvQ-0!sizedetails
ImageSizes /api/v2/image/xGmGnvQ-0!sizes
LargestImage /api/v2/image/xGmGnvQ-0!largestimage
PointOfInterest /api/v2/image/xGmGnvQ!pointofinterest
PointOfInterestCrops /api/v2/image/xGmGnvQ!poicrops
Regions /api/v2/image/xGmGnvQ!regions

Timing

Total

cycles 1
objects 0
time 0.02328

Config

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

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/highlight/node/gk63WD?_shorturis="
    },
    "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": "gk63WD"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/highlight/node/gk63WD?_shorturis=",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "",
            "Keywords": "",
            "KeywordArray": [],
            "Watermark": "No",
            "Latitude": "0.00000000000000",
            "Longitude": "0.00000000000000",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/photos/i-xGmGnvQ/0/Th/i-xGmGnvQ-Th.jpg",
            "FileName": "DSCF1541.jpg",
            "Processing": false,
            "UploadKey": "5036723530",
            "Date": "2016-06-30T15:43:03+00:00",
            "Format": "JPG",
            "OriginalHeight": 4000,
            "OriginalWidth": 6000,
            "OriginalSize": 8192624,
            "LastUpdated": "2016-06-30T15:43:08+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": false,
            "Protected": false,
            "Watermarked": false,
            "ImageKey": "xGmGnvQ",
            "ArchivedUri": "https://photos.smugmug.com/THOMAS-FARTHING-LDN-SS16/i-xGmGnvQ/0/6a40d56f/D/DSCF1541-D.jpg",
            "ArchivedSize": 8192624,
            "ArchivedMD5": "fc255b3202b65d8c25d7bc084662f8af",
            "CanShare": true,
            "Comments": true,
            "ShowKeywords": true,
            "FormattedValues": {
                "Caption": {
                    "html": "",
                    "text": ""
                },
                "FileName": {
                    "html": "DSCF1541.jpg",
                    "text": "DSCF1541.jpg"
                }
            },
            "Uri": "/api/v2/image/xGmGnvQ-0",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": "/api/v2/image/xGmGnvQ-0!largestimage",
                "ImageSizes": "/api/v2/image/xGmGnvQ-0!sizes",
                "ImageSizeDetails": "/api/v2/image/xGmGnvQ-0!sizedetails",
                "PointOfInterest": "/api/v2/image/xGmGnvQ!pointofinterest",
                "PointOfInterestCrops": "/api/v2/image/xGmGnvQ!poicrops",
                "Regions": "/api/v2/image/xGmGnvQ!regions",
                "ImageComments": "/api/v2/image/xGmGnvQ!comments",
                "ImagePrices": "/api/v2/image/xGmGnvQ!prices",
                "ImagePricelistExclusions": "/api/v2/image/xGmGnvQ!pricelistexclusions"
            }
        },
        "UriDescription": "Highlight image for a folder, album, or page",
        "EndpointType": "HighlightImage",
        "Timing": {
            "Total": {
                "time": 0.02328,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Methods
    2. Available Media Types
  5. JSON