Response [200 Ok]

Uri /api/v2/album/Kxjvbc!images
UriDescription Images from album
EndpointType AlbumImages
Locator AlbumImage
LocatorType Objects

AlbumImage [1 of 1]
/api/v2/album/Kxjvbc/image/f6N8QvN-0

Uri /api/v2/album/Kxjvbc/image/f6N8QvN-0
UriDescription Image from album
Altitude 0
ArchivedMD5 9b77a0c688c016a01e164b9900f47b18
ArchivedSize 2589830
ArchivedUri https://photos.smugmug.com/Product-Shot-Catalog/Size-Guide/i-f6N8QvN/0/80ccb357/D/size%20guide-D.jpg
CanBuy false
CanEdit false
CanShare false
Caption empty string
Collectable true
Comments false
ComponentFileTypes
Date 2023-07-07T14:26:55+00:00
DateTimeUploaded 2023-07-07T14:26:55+00:00
EZProject false
FileName size guide.jpg
Format JPG
Hidden false
ImageKey f6N8QvN
IsArchive false
IsVideo false
KeywordArray
Keywords empty string
LastUpdated 2023-07-07T14:26:56+00:00
Latitude 0
Longitude 0
Movable true
Origin Album
OriginalHeight 2720
OriginalSize 2589830
OriginalWidth 3740
PreferredDisplayFileExtension JPG
Processing false
Protected false
Serial 0
ShowKeywords true
ThumbnailUrl https://photos.smugmug.com/photos/i-f6N8QvN/0/Th/i-f6N8QvN-Th.jpg
Title empty string
UploadKey 13658030178
Watermark No
Watermarked false
WebUri https://assets.smugmug.com/Product-Shot-Catalog/Size-Guide/i-f6N8QvN

Formatted Values

Caption [html, text]

html empty string
text empty string

FileName [html, text]

html size guide.jpg
text size guide.jpg

Uris

Album
/api/v2/album/Kxjvbc

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

AlbumImagePricelistExclusions
/api/v2/album/Kxjvbc/image/f6N8QvN-0!pricelistexclusions

Uri /api/v2/album/Kxjvbc/image/f6N8QvN-0!pricelistexclusions
UriDescription Pricelist information for an album image
EndpointType AlbumImagePricelistExclusions
Locator AlbumImagePricelistExclusions
LocatorType Object

AlbumImageShareUris
/api/v2/album/Kxjvbc/image/f6N8QvN-0!shareuris

Uri /api/v2/album/Kxjvbc/image/f6N8QvN-0!shareuris
UriDescription URIs that are useful for sharing
EndpointType AlbumImageShareUris
Locator AlbumImageShareUris
LocatorType Object

Image
/api/v2/image/f6N8QvN-0

Uri /api/v2/image/f6N8QvN-0
UriDescription Image by key
EndpointType Image
Locator Image
LocatorType Object

ImagePricelistExclusions
/api/v2/image/f6N8QvN-0!pricelistexclusions

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

ImagePrices
/api/v2/image/f6N8QvN-0!prices

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

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

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

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

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

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

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

PointOfInterest
/api/v2/image/f6N8QvN-0!pointofinterest

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

PointOfInterestCrops
/api/v2/image/f6N8QvN-0!poicrops

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

Regions
/api/v2/image/f6N8QvN-0!regions

Uri /api/v2/image/f6N8QvN-0!regions
UriDescription Regions for image
EndpointType Regions
Locator Region
LocatorType Objects

Pages

Count 1
FirstPage /api/v2/album/Kxjvbc!images?start=1&count=100
LastPage /api/v2/album/Kxjvbc!images?start=1&count=100
RequestedCount 100
Start 1
Total 1

Timing

Total

cycles 1
objects 0
time 0.05424

Request

Uri /api/v2/album/Kxjvbc!images
Method GET
Version v2

Config

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

Options

Path

  • /api
  • /v2
  • /album
  • /
  • !images

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

Parameters

GET

A list of filenames (percent-encoded and comma-separated); if used, an image will only be included in the result set if its file name is in the list

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/Kxjvbc!images"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Add"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "FileNames",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Description": "A list of filenames (percent-encoded and comma-separated); if used, an image will only be included in the result set if its file name is in the list",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "_multiargs does not work at this endpoint"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "Kxjvbc",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "images"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/Kxjvbc!images",
        "Locator": "AlbumImage",
        "LocatorType": "Objects",
        "AlbumImage": [
            {
                "Title": "",
                "Caption": "",
                "Keywords": "",
                "KeywordArray": [],
                "Watermark": "No",
                "Latitude": "0",
                "Longitude": "0",
                "Altitude": 0,
                "Hidden": false,
                "ThumbnailUrl": "https://photos.smugmug.com/photos/i-f6N8QvN/0/Th/i-f6N8QvN-Th.jpg",
                "FileName": "size guide.jpg",
                "Processing": false,
                "UploadKey": "13658030178",
                "Date": "2023-07-07T14:26:55+00:00",
                "DateTimeUploaded": "2023-07-07T14:26:55+00:00",
                "Format": "JPG",
                "OriginalHeight": 2720,
                "OriginalWidth": 3740,
                "OriginalSize": 2589830,
                "LastUpdated": "2023-07-07T14:26:56+00:00",
                "Collectable": true,
                "IsArchive": false,
                "IsVideo": false,
                "ComponentFileTypes": [],
                "CanEdit": false,
                "CanBuy": false,
                "Protected": false,
                "EZProject": false,
                "Watermarked": false,
                "ImageKey": "f6N8QvN",
                "Serial": 0,
                "ArchivedUri": "https://photos.smugmug.com/Product-Shot-Catalog/Size-Guide/i-f6N8QvN/0/80ccb357/D/size%20guide-D.jpg",
                "ArchivedSize": 2589830,
                "ArchivedMD5": "9b77a0c688c016a01e164b9900f47b18",
                "CanShare": false,
                "Comments": false,
                "ShowKeywords": true,
                "FormattedValues": {
                    "Caption": {
                        "html": "",
                        "text": ""
                    },
                    "FileName": {
                        "html": "size guide.jpg",
                        "text": "size guide.jpg"
                    }
                },
                "PreferredDisplayFileExtension": "JPG",
                "Uri": "/api/v2/album/Kxjvbc/image/f6N8QvN-0",
                "UriDescription": "Image from album",
                "Uris": {
                    "LargestImage": {
                        "Uri": "/api/v2/image/f6N8QvN-0!largestimage",
                        "Locator": "LargestImage",
                        "LocatorType": "Object",
                        "UriDescription": "Largest size available for image",
                        "EndpointType": "LargestImage"
                    },
                    "ImageSizes": {
                        "Uri": "/api/v2/image/f6N8QvN-0!sizes",
                        "Locator": "ImageSizes",
                        "LocatorType": "Object",
                        "UriDescription": "Sizes available for image",
                        "EndpointType": "ImageSizes"
                    },
                    "ImageSizeDetails": {
                        "Uri": "/api/v2/image/f6N8QvN-0!sizedetails",
                        "Locator": "ImageSizeDetails",
                        "LocatorType": "Object",
                        "UriDescription": "Detailed size information for image",
                        "EndpointType": "ImageSizeDetails"
                    },
                    "PointOfInterest": {
                        "Uri": "/api/v2/image/f6N8QvN-0!pointofinterest",
                        "Locator": "PointOfInterest",
                        "LocatorType": "Object",
                        "UriDescription": "Point of interest for image",
                        "EndpointType": "PointOfInterest"
                    },
                    "PointOfInterestCrops": {
                        "Uri": "/api/v2/image/f6N8QvN-0!poicrops",
                        "Locator": "PointOfInterestCrops",
                        "LocatorType": "List",
                        "UriDescription": "PointOfInterest Crops for image",
                        "EndpointType": "PointOfInterestCrops"
                    },
                    "Regions": {
                        "Uri": "/api/v2/image/f6N8QvN-0!regions",
                        "Locator": "Region",
                        "LocatorType": "Objects",
                        "UriDescription": "Regions for image",
                        "EndpointType": "Regions"
                    },
                    "ImagePrices": {
                        "Uri": "/api/v2/image/f6N8QvN-0!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "ImagePrices"
                    },
                    "ImagePricelistExclusions": {
                        "Uri": "/api/v2/image/f6N8QvN-0!pricelistexclusions",
                        "Locator": "ImagePricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an image",
                        "EndpointType": "ImagePricelistExclusions"
                    },
                    "Album": {
                        "Uri": "/api/v2/album/Kxjvbc",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "Image": {
                        "Uri": "/api/v2/image/f6N8QvN-0",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Image by key",
                        "EndpointType": "Image"
                    },
                    "AlbumImagePricelistExclusions": {
                        "Uri": "/api/v2/album/Kxjvbc/image/f6N8QvN-0!pricelistexclusions",
                        "Locator": "AlbumImagePricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an album image",
                        "EndpointType": "AlbumImagePricelistExclusions"
                    },
                    "AlbumImageShareUris": {
                        "Uri": "/api/v2/album/Kxjvbc/image/f6N8QvN-0!shareuris",
                        "Locator": "AlbumImageShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumImageShareUris"
                    }
                },
                "Movable": true,
                "Origin": "Album",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/Size-Guide/i-f6N8QvN"
            }
        ],
        "UriDescription": "Images from album",
        "EndpointType": "AlbumImages",
        "Pages": {
            "Total": 1,
            "Start": 1,
            "Count": 1,
            "RequestedCount": 100,
            "FirstPage": "/api/v2/album/Kxjvbc!images?start=1&count=100",
            "LastPage": "/api/v2/album/Kxjvbc!images?start=1&count=100"
        },
        "Timing": {
            "Total": {
                "time": 0.05424,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}