Response [200 Ok]

Uri /api/v2/image/XCTXHWh-0
UriDescription Image by key
DocUri https://api.smugmug.com/api/v2/doc/reference/image.html
EndpointType Image
Locator Image
LocatorType Object

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

Uri /api/v2/image/XCTXHWh-0
UriDescription Image by key
Altitude 0
CanBuy true
CanEdit false
Caption empty string
Collectable true
Date 2017-10-09T11:30:50+00:00
FileName DSC_-283.jpg
Format JPG
Hidden false
ImageKey XCTXHWh
IsArchive false
IsVideo false
KeywordArray
Array [1]
0 283
Keywords 283
LastUpdated 2017-10-09T11:30:51+00:00
Latitude 0.00000000000000
Longitude 0.00000000000000
OriginalHeight 900
OriginalSize 290463
OriginalWidth 600
Processing false
Protected false
ThumbnailUrl https://photos.smugmug.com/Jpegs-sized-for-web-with/JPEG/i-XCTXHWh/0/dad8ed79/Th/DSC_-283-Th.jpg
Title empty string
UploadKey 6515979705
Watermark No
Watermarked false
WebUri http://www.michaelmileyphotography.ie/Jpegs-sized-for-web-with/JPEG/i-XCTXHWh

Formatted Values

Caption [html, text]

html empty string
text empty string

Uris

ImageAlbum
/api/v2/album/qrdsh8

Uri /api/v2/album/qrdsh8
UriDescription Album by key
EndpointType Album
Locator Album
LocatorType Object

ImageComments
/api/v2/image/XCTXHWh!comments

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

ImageDownload
/api/v2/image/XCTXHWh!download

Uri /api/v2/image/XCTXHWh!download
UriDescription Download image
EndpointType ImageDownload
Locator ImageDownload
LocatorType Object

ImageMetadata
/api/v2/image/XCTXHWh!metadata

Uri /api/v2/image/XCTXHWh!metadata
UriDescription Metadata for image
EndpointType ImageMetadata
Locator ImageMetadata
LocatorType Object

ImageOwner
/api/v2/user/michaelmileyphotography

Uri /api/v2/user/michaelmileyphotography
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object

ImagePrices
/api/v2/image/XCTXHWh!prices

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

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

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

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

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

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

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

PointOfInterest
/api/v2/image/XCTXHWh!pointofinterest

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

PointOfInterestCrops
/api/v2/image/XCTXHWh!poicrops

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

Regions
/api/v2/image/XCTXHWh!regions

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

Timing

Total

cycles 1
objects 0
time 0.05417

Request

Uri /api/v2/image/XCTXHWh-0
Method GET
Version v2

Options

Path

  • /api
  • /v2
  • /image
  • /

Notes

  • The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed
  • "Watermark" has been deprecated in favor of "Watermarked". "Watermarked" will only be present for images with a known watermarked state
  • Photo sizes, including Original, without a "Size" or "MD5" property, will be generated dynamically upon request
  • "ArchivedUri", "ArchivedSize" and "ArchivedMD5" refer to the untouched version of the photo originally uploaded

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

Altitude integer
ArchivedMD5 text
ArchivedSize integer
ArchivedUri uri
CanBuy boolean
CanEdit boolean
Caption text
Collectable boolean
Date datetime
EZProject boolean
FileName text
Format text
FormattedValues hash Alternative versions of certain fields formatted for use in different contexts.
Hidden boolean
ImageKey text
IsArchive boolean
IsVideo boolean
KeywordArray array
Keywords text
LastUpdated timestamp
Latitude decimal
Longitude decimal
OriginalHeight integer
OriginalSize integer
OriginalWidth integer
Processing boolean
Protected boolean
ThumbnailUrl uri
Title text
UploadKey text
Watermark Deprecated as of 2014-11-20
Watermarked boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/XCTXHWh-0"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Title",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Caption",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "KeywordArray",
                "Type": "Array",
                "ITEM_TYPE": "Varchar",
                "MIN_COUNT": 0,
                "MAX_COUNT": "INFINITY"
            },
            {
                "Name": "Watermark",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from Album"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "Latitude",
                "Type": "DECIMAL",
                "PRECISION": 16,
                "SCALE": 14,
                "SIGNED": true
            },
            {
                "Name": "Longitude",
                "Type": "DECIMAL",
                "PRECISION": 17,
                "SCALE": 14,
                "SIGNED": true
            },
            {
                "Name": "Altitude",
                "Type": "Integer",
                "MIN_VALUE": 0,
                "MAX_VALUE": 16777215
            },
            {
                "Name": "Hidden",
                "Type": "Boolean"
            },
            {
                "Name": "ThumbnailUrl",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "FileName",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Processing",
                "Type": "Boolean"
            },
            {
                "Name": "UploadKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Date",
                "Type": "DateTime"
            },
            {
                "Name": "Format",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "OriginalHeight",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "OriginalWidth",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "OriginalSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "LastUpdated",
                "Type": "Timestamp"
            },
            {
                "Name": "Collectable",
                "Type": "Boolean"
            },
            {
                "Name": "IsArchive",
                "Type": "Boolean"
            },
            {
                "Name": "IsVideo",
                "Type": "Boolean"
            },
            {
                "Name": "CanEdit",
                "Type": "Boolean"
            },
            {
                "Name": "CanBuy",
                "Type": "Boolean"
            },
            {
                "Name": "Protected",
                "Type": "Boolean"
            },
            {
                "Name": "EZProject",
                "Type": "Boolean"
            },
            {
                "Name": "Watermarked",
                "Type": "Boolean"
            },
            {
                "Name": "ImageKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "ArchivedUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "ArchivedSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ArchivedMD5",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "FormattedValues",
                "Description": "Alternative versions of certain fields formatted for use in different contexts.",
                "Type": "Hash"
            }
        ],
        "Notes": [
            "The Uri returned by this endpoint may not exist if it was recently uploaded and is being processed",
            "\"Watermark\" has been deprecated in favor of \"Watermarked\".\n         \"Watermarked\" will only be present for images with a known watermarked state",
            "Photo sizes, including Original, without a \"Size\" or \"MD5\" property, will be generated dynamically upon request",
            "\"ArchivedUri\", \"ArchivedSize\" and \"ArchivedMD5\" refer to the untouched version of the photo originally uploaded"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "XCTXHWh-0"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/XCTXHWh-0",
        "Locator": "Image",
        "LocatorType": "Object",
        "Image": {
            "Title": "",
            "Caption": "",
            "Keywords": "283",
            "KeywordArray": [
                "283"
            ],
            "Watermark": "No",
            "Latitude": "0.00000000000000",
            "Longitude": "0.00000000000000",
            "Altitude": 0,
            "Hidden": false,
            "ThumbnailUrl": "https://photos.smugmug.com/Jpegs-sized-for-web-with/JPEG/i-XCTXHWh/0/dad8ed79/Th/DSC_-283-Th.jpg",
            "FileName": "DSC_-283.jpg",
            "Processing": false,
            "UploadKey": "6515979705",
            "Date": "2017-10-09T11:30:50+00:00",
            "Format": "JPG",
            "OriginalHeight": 900,
            "OriginalWidth": 600,
            "OriginalSize": 290463,
            "LastUpdated": "2017-10-09T11:30:51+00:00",
            "Collectable": true,
            "IsArchive": false,
            "IsVideo": false,
            "CanEdit": false,
            "CanBuy": true,
            "Protected": false,
            "Watermarked": false,
            "ImageKey": "XCTXHWh",
            "FormattedValues": {
                "Caption": {
                    "html": "",
                    "text": ""
                }
            },
            "Uri": "/api/v2/image/XCTXHWh-0",
            "WebUri": "http://www.michaelmileyphotography.ie/Jpegs-sized-for-web-with/JPEG/i-XCTXHWh",
            "UriDescription": "Image by key",
            "Uris": {
                "LargestImage": {
                    "Uri": "/api/v2/image/XCTXHWh-0!largestimage",
                    "Locator": "LargestImage",
                    "LocatorType": "Object",
                    "UriDescription": "Largest size available for image",
                    "EndpointType": "LargestImage"
                },
                "ImageSizes": {
                    "Uri": "/api/v2/image/XCTXHWh-0!sizes",
                    "Locator": "ImageSizes",
                    "LocatorType": "Object",
                    "UriDescription": "Sizes available for image",
                    "EndpointType": "ImageSizes"
                },
                "ImageSizeDetails": {
                    "Uri": "/api/v2/image/XCTXHWh-0!sizedetails",
                    "Locator": "ImageSizeDetails",
                    "LocatorType": "Object",
                    "UriDescription": "Detailed size information for image",
                    "EndpointType": "ImageSizeDetails"
                },
                "PointOfInterest": {
                    "Uri": "/api/v2/image/XCTXHWh!pointofinterest",
                    "Locator": "PointOfInterest",
                    "LocatorType": "Object",
                    "UriDescription": "Point of interest for image",
                    "EndpointType": "PointOfInterest"
                },
                "PointOfInterestCrops": {
                    "Uri": "/api/v2/image/XCTXHWh!poicrops",
                    "Locator": "PointOfInterestCrops",
                    "LocatorType": "List",
                    "UriDescription": "PointOfInterest Crops for image",
                    "EndpointType": "PointOfInterestCrops"
                },
                "Regions": {
                    "Uri": "/api/v2/image/XCTXHWh!regions",
                    "Locator": "Region",
                    "LocatorType": "Objects",
                    "UriDescription": "Regions for image",
                    "EndpointType": "Regions"
                },
                "ImageAlbum": {
                    "Uri": "/api/v2/album/qrdsh8",
                    "Locator": "Album",
                    "LocatorType": "Object",
                    "UriDescription": "Album by key",
                    "EndpointType": "Album"
                },
                "ImageDownload": {
                    "Uri": "/api/v2/image/XCTXHWh!download",
                    "Locator": "ImageDownload",
                    "LocatorType": "Object",
                    "UriDescription": "Download image",
                    "EndpointType": "ImageDownload"
                },
                "ImageOwner": {
                    "Uri": "/api/v2/user/michaelmileyphotography",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "ImageComments": {
                    "Uri": "/api/v2/image/XCTXHWh!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on image",
                    "EndpointType": "ImageComments"
                },
                "ImageMetadata": {
                    "Uri": "/api/v2/image/XCTXHWh!metadata",
                    "Locator": "ImageMetadata",
                    "LocatorType": "Object",
                    "UriDescription": "Metadata for image",
                    "EndpointType": "ImageMetadata"
                },
                "ImagePrices": {
                    "Uri": "/api/v2/image/XCTXHWh!prices",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Purchasable Skus",
                    "EndpointType": "ImagePrices"
                }
            }
        },
        "UriDescription": "Image by key",
        "EndpointType": "Image",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/image.html",
        "Timing": {
            "Total": {
                "time": 0.05417,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}