Response [200 Ok]

Uri /api/v2/album/DMQ8GZ!images?start=1&count=100
UriDescription Images from album
EndpointType AlbumImages
Locator AlbumImage
LocatorType Objects

AlbumImage [1 of 1]
/api/v2/album/DMQ8GZ/image/pfc2kGV-0

Uri /api/v2/album/DMQ8GZ/image/pfc2kGV-0
UriDescription Image from album
AlbumKey DMQ8GZ
Altitude 0
ArchivedMD5 3c182398b8cf3d27bcd201b73a1af1c5
ArchivedSize 155323
ArchivedUri https://photos.smugmug.com/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV/0/LcCkBDj9G9cqxTWdXdCgPs6LdCQQkQ2SZnDtQ2x6X/D/2019-04-27%20-%20ELL%20Coast%20Expos%20Timelapse-D.jpg
CanBuy false
CanEdit false
CanShare true
Caption empty string
Collectable false
Comments true
ComponentFileTypes
Date 2019-04-28T02:31:35+00:00
DateTimeOriginal 2019-04-28T09:05:11+00:00
DateTimeUploaded 2019-04-28T02:31:35+00:00
EZProject false
FileName 2019-04-27 - ELL Coast Expos Timelapse.mp4
Format MP4
Hidden false
ImageKey pfc2kGV
IsArchive false
IsVideo true
KeywordArray
Array [5]
0 2019
1 ELL
2 Coast
3 Expos
4 Timelapse
Keywords 2019; ELL; Coast; Expos; Timelapse
LastUpdated 2019-04-28T02:33:58+00:00
Latitude 0
Longitude 0
Movable true
Origin Album
OriginalHeight 720
OriginalSize 155323
OriginalWidth 1280
PreferredDisplayFileExtension MP4
Processing false
Protected false
Serial 0
ShowKeywords true
Status Open
SubStatus NFS
ThumbnailUrl https://photos.smugmug.com/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV/0/MmjvkphBkjWDMSdfXCLSK5N4kkNRn8QGzPBHCrfHM/Th/2019-04-27%20-%20ELL%20Coast%20Expos%20Timelapse-Th.jpg
Title empty string
UploadKey 8258631275
Watermark No
Watermarked false
WebUri https://www.steinbok.net/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV

Formatted Values

Caption [html, text]

html empty string
text empty string

FileName [html, text]

html 2019-04-27 - ELL Coast Expos Timelapse.mp4
text 2019-04-27 - ELL Coast Expos Timelapse.mp4

Uris

Album
/api/v2/album/DMQ8GZ

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

AlbumImageDownload
/api/v2/album/DMQ8GZ/image/pfc2kGV-0!download

Uri /api/v2/album/DMQ8GZ/image/pfc2kGV-0!download
UriDescription Download the image from the album
EndpointType AlbumImageDownload
Locator AlbumImageDownload
LocatorType Object

AlbumImageMetadata
/api/v2/album/DMQ8GZ/image/pfc2kGV-0!metadata

Uri /api/v2/album/DMQ8GZ/image/pfc2kGV-0!metadata
UriDescription Metadata for AlbumImage
EndpointType AlbumImageMetadata
Locator AlbumImageMetadata
LocatorType Object

AlbumImagePricelistExclusions
/api/v2/album/DMQ8GZ/image/pfc2kGV-0!pricelistexclusions

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

AlbumImageShareUris
/api/v2/album/DMQ8GZ/image/pfc2kGV-0!shareuris

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

CSMILVideo
/api/v2/video/pfc2kGV-0!csmil

Uri /api/v2/video/pfc2kGV-0!csmil
UriDescription Video CSMIL
EndpointType CSMILVideo
Locator CSMILVideo
LocatorType Object

EmbedVideo
/api/v2/video/pfc2kGV-0!embed

Uri /api/v2/video/pfc2kGV-0!embed
UriDescription Embed link for video
EndpointType EmbedVideo
Locator EmbedVideo
LocatorType Object

Image
/api/v2/image/pfc2kGV-0

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

ImageComments
/api/v2/image/pfc2kGV-0!comments

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

ImageMetadata
/api/v2/image/pfc2kGV-0!metadata

Uri /api/v2/image/pfc2kGV-0!metadata
UriDescription Metadata for image
EndpointType ImageMetadata
Locator ImageMetadata
LocatorType Object

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

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

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

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

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

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

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

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

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

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

LargestVideo
/api/v2/image/pfc2kGV-0!largestvideo

Uri /api/v2/image/pfc2kGV-0!largestvideo
UriDescription Largest size available for video
EndpointType LargestVideo
Locator LargestVideo
LocatorType Object

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

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

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

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

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

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

Pages

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

Timing

Total

cycles 1
objects 0
time 0.05519

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
An optional SKU ID filter. Only images that are valid for this SKU will be returned

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/DMQ8GZ!images?start=1&count=100"
    },
    "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)",
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive"
        },
        "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"
                },
                {
                    "Name": "SkuId",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "An optional SKU ID filter. Only images that are valid for this SKU will be returned",
                    "Type": "Integer",
                    "MIN_VALUE": 0,
                    "MAX_VALUE": "POSITIVE_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": "DMQ8GZ",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "images"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/DMQ8GZ!images?start=1&count=100",
        "Locator": "AlbumImage",
        "LocatorType": "Objects",
        "AlbumImage": [
            {
                "Title": "",
                "Caption": "",
                "Keywords": "2019; ELL; Coast; Expos; Timelapse",
                "KeywordArray": [
                    "2019",
                    "ELL",
                    "Coast",
                    "Expos",
                    "Timelapse"
                ],
                "Watermark": "No",
                "Latitude": "0",
                "Longitude": "0",
                "Altitude": 0,
                "Hidden": false,
                "ThumbnailUrl": "https://photos.smugmug.com/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV/0/MmjvkphBkjWDMSdfXCLSK5N4kkNRn8QGzPBHCrfHM/Th/2019-04-27%20-%20ELL%20Coast%20Expos%20Timelapse-Th.jpg",
                "FileName": "2019-04-27 - ELL Coast Expos Timelapse.mp4",
                "Processing": false,
                "UploadKey": "8258631275",
                "Date": "2019-04-28T02:31:35+00:00",
                "DateTimeUploaded": "2019-04-28T02:31:35+00:00",
                "DateTimeOriginal": "2019-04-28T09:05:11+00:00",
                "Format": "MP4",
                "OriginalHeight": 720,
                "OriginalWidth": 1280,
                "OriginalSize": 155323,
                "LastUpdated": "2019-04-28T02:33:58+00:00",
                "Collectable": false,
                "IsArchive": false,
                "IsVideo": true,
                "ComponentFileTypes": [],
                "CanEdit": false,
                "CanBuy": false,
                "Protected": false,
                "EZProject": false,
                "Watermarked": false,
                "ImageKey": "pfc2kGV",
                "Serial": 0,
                "ArchivedUri": "https://photos.smugmug.com/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV/0/LcCkBDj9G9cqxTWdXdCgPs6LdCQQkQ2SZnDtQ2x6X/D/2019-04-27%20-%20ELL%20Coast%20Expos%20Timelapse-D.jpg",
                "ArchivedSize": 155323,
                "ArchivedMD5": "3c182398b8cf3d27bcd201b73a1af1c5",
                "Status": "Open",
                "SubStatus": "NFS",
                "CanShare": true,
                "Comments": true,
                "ShowKeywords": true,
                "FormattedValues": {
                    "Caption": {
                        "html": "",
                        "text": ""
                    },
                    "FileName": {
                        "html": "2019-04-27 - ELL Coast Expos Timelapse.mp4",
                        "text": "2019-04-27 - ELL Coast Expos Timelapse.mp4"
                    }
                },
                "PreferredDisplayFileExtension": "MP4",
                "Uri": "/api/v2/album/DMQ8GZ/image/pfc2kGV-0",
                "UriDescription": "Image from album",
                "Uris": {
                    "LargestImage": {
                        "Uri": "/api/v2/image/pfc2kGV-0!largestimage",
                        "Locator": "LargestImage",
                        "LocatorType": "Object",
                        "UriDescription": "Largest size available for image",
                        "EndpointType": "LargestImage"
                    },
                    "LargestVideo": {
                        "Uri": "/api/v2/image/pfc2kGV-0!largestvideo",
                        "Locator": "LargestVideo",
                        "LocatorType": "Object",
                        "UriDescription": "Largest size available for video",
                        "EndpointType": "LargestVideo"
                    },
                    "ImageSizes": {
                        "Uri": "/api/v2/image/pfc2kGV-0!sizes",
                        "Locator": "ImageSizes",
                        "LocatorType": "Object",
                        "UriDescription": "Sizes available for image",
                        "EndpointType": "ImageSizes"
                    },
                    "ImageSizeDetails": {
                        "Uri": "/api/v2/image/pfc2kGV-0!sizedetails",
                        "Locator": "ImageSizeDetails",
                        "LocatorType": "Object",
                        "UriDescription": "Detailed size information for image",
                        "EndpointType": "ImageSizeDetails"
                    },
                    "PointOfInterest": {
                        "Uri": "/api/v2/image/pfc2kGV-0!pointofinterest",
                        "Locator": "PointOfInterest",
                        "LocatorType": "Object",
                        "UriDescription": "Point of interest for image",
                        "EndpointType": "PointOfInterest"
                    },
                    "PointOfInterestCrops": {
                        "Uri": "/api/v2/image/pfc2kGV-0!poicrops",
                        "Locator": "PointOfInterestCrops",
                        "LocatorType": "List",
                        "UriDescription": "PointOfInterest Crops for image",
                        "EndpointType": "PointOfInterestCrops"
                    },
                    "Regions": {
                        "Uri": "/api/v2/image/pfc2kGV-0!regions",
                        "Locator": "Region",
                        "LocatorType": "Objects",
                        "UriDescription": "Regions for image",
                        "EndpointType": "Regions"
                    },
                    "ImageComments": {
                        "Uri": "/api/v2/image/pfc2kGV-0!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on image",
                        "EndpointType": "ImageComments"
                    },
                    "EmbedVideo": {
                        "Uri": "/api/v2/video/pfc2kGV-0!embed",
                        "Locator": "EmbedVideo",
                        "LocatorType": "Object",
                        "UriDescription": "Embed link for video",
                        "EndpointType": "EmbedVideo"
                    },
                    "CSMILVideo": {
                        "Uri": "/api/v2/video/pfc2kGV-0!csmil",
                        "Locator": "CSMILVideo",
                        "LocatorType": "Object",
                        "UriDescription": "Video CSMIL",
                        "EndpointType": "CSMILVideo"
                    },
                    "ImageMetadata": {
                        "Uri": "/api/v2/image/pfc2kGV-0!metadata",
                        "Locator": "ImageMetadata",
                        "LocatorType": "Object",
                        "UriDescription": "Metadata for image",
                        "EndpointType": "ImageMetadata"
                    },
                    "ImagePrices": {
                        "Uri": "/api/v2/image/pfc2kGV-0!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "ImagePrices"
                    },
                    "ImagePricelistExclusions": {
                        "Uri": "/api/v2/image/pfc2kGV-0!pricelistexclusions",
                        "Locator": "ImagePricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an image",
                        "EndpointType": "ImagePricelistExclusions"
                    },
                    "Album": {
                        "Uri": "/api/v2/album/DMQ8GZ",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "Image": {
                        "Uri": "/api/v2/image/pfc2kGV-0",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Image by key",
                        "EndpointType": "Image"
                    },
                    "AlbumImagePricelistExclusions": {
                        "Uri": "/api/v2/album/DMQ8GZ/image/pfc2kGV-0!pricelistexclusions",
                        "Locator": "AlbumImagePricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an album image",
                        "EndpointType": "AlbumImagePricelistExclusions"
                    },
                    "AlbumImageMetadata": {
                        "Uri": "/api/v2/album/DMQ8GZ/image/pfc2kGV-0!metadata",
                        "Locator": "AlbumImageMetadata",
                        "LocatorType": "Object",
                        "UriDescription": "Metadata for AlbumImage",
                        "EndpointType": "AlbumImageMetadata"
                    },
                    "AlbumImageShareUris": {
                        "Uri": "/api/v2/album/DMQ8GZ/image/pfc2kGV-0!shareuris",
                        "Locator": "AlbumImageShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumImageShareUris"
                    },
                    "AlbumImageDownload": {
                        "Uri": "/api/v2/album/DMQ8GZ/image/pfc2kGV-0!download",
                        "Locator": "AlbumImageDownload",
                        "LocatorType": "Object",
                        "UriDescription": "Download the image from the album",
                        "EndpointType": "AlbumImageDownload"
                    }
                },
                "AlbumKey": "DMQ8GZ",
                "Movable": true,
                "Origin": "Album",
                "WebUri": "https://www.steinbok.net/ELL/ELL-2019-Coast-Expos/Timelapse/i-pfc2kGV"
            }
        ],
        "UriDescription": "Images from album",
        "EndpointType": "AlbumImages",
        "Pages": {
            "Total": 1,
            "Start": 1,
            "Count": 1,
            "RequestedCount": 100,
            "FirstPage": "/api/v2/album/DMQ8GZ!images?start=1&count=100",
            "LastPage": "/api/v2/album/DMQ8GZ!images?start=1&count=100"
        },
        "Timing": {
            "Total": {
                "time": 0.05519,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}