Response [200 Ok]

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

LargestImage [1 of 1]
/api/v2/image/JKMN6cn-1!largestimage

Uri /api/v2/image/JKMN6cn-1!largestimage
UriDescription Largest size available for image
Ext jpg
Height 768
MD5 7d9ef06c0cc9afb3c884a06a635abb5b
Size 104537
Url https://photos.smugmug.com/photos/i-JKMN6cn/1/XL/i-JKMN6cn-XL.jpg
Usable true
Watermarked false
Width 548

Uris

ImageSizeXLarge
/api/v2/image/JKMN6cn-1!sizexlarge

Uri /api/v2/image/JKMN6cn-1!sizexlarge
UriDescription Image size: Xlarge
EndpointType ImageSizeXLarge
Locator ImageSizeXLarge
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.05347

Config

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

Options

Path

  • /api
  • /v2
  • /image
  • /
  • !largestimage

Notes

  • The Uris.Locator will vary depending on the maximum available size
  • If this image is generated on-the-fly, Size is not available in the response data

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Output Fields

Ext text
Height integer
MD5 text
Size integer
Url uri
Usable boolean
Watermarked boolean
Width integer

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image/JKMN6cn-1!largestimage?_accept=text%2Fhtml"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "MaxSize",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Select",
                    "OPTIONS": [
                        "ImageSizeTiny",
                        "ImageSizeThumb",
                        "ImageSizeSmall",
                        "ImageSizeMedium",
                        "ImageSizeLarge",
                        "ImageSizeXLarge",
                        "ImageSizeX2Large",
                        "ImageSizeX3Large",
                        "ImageSizeX4Large",
                        "ImageSizeX5Large",
                        "ImageSize4K",
                        "ImageSize5K",
                        "ImageSizeOriginal"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Url",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": []
            },
            {
                "Name": "Size",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "Height",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "Width",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "MD5",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Usable",
                "Type": "Boolean"
            },
            {
                "Name": "Ext",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Watermarked",
                "Type": "Boolean"
            }
        ],
        "Notes": [
            "The Uris.Locator will vary depending on the maximum available size",
            "If this image is generated on-the-fly, Size is not available in the response data"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "JKMN6cn-1",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "largestimage"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/image/JKMN6cn-1!largestimage",
        "Locator": "LargestImage",
        "LocatorType": "Object",
        "LargestImage": {
            "Url": "https://photos.smugmug.com/photos/i-JKMN6cn/1/XL/i-JKMN6cn-XL.jpg",
            "Size": 104537,
            "Height": 768,
            "Width": 548,
            "MD5": "7d9ef06c0cc9afb3c884a06a635abb5b",
            "Usable": true,
            "Ext": "jpg",
            "Watermarked": false,
            "Uri": "/api/v2/image/JKMN6cn-1!largestimage",
            "UriDescription": "Largest size available for image",
            "Uris": {
                "ImageSizeXLarge": {
                    "Uri": "/api/v2/image/JKMN6cn-1!sizexlarge",
                    "Locator": "ImageSizeXLarge",
                    "LocatorType": "Object",
                    "UriDescription": "Image size: Xlarge",
                    "EndpointType": "ImageSizeXLarge"
                }
            }
        },
        "UriDescription": "Largest size available for image",
        "EndpointType": "LargestImage",
        "Timing": {
            "Total": {
                "time": 0.05347,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}