Response [200 Ok]

Uri /api/v2/album/7gmS9r?_shorturis=
UriDescription Album by key
DocUri https://api.smugmug.com/api/v2/doc/reference/album.html
EndpointType Album
Locator Album
LocatorType Object

Album [1 of 1] - april gallery
/api/v2/album/7gmS9r

Uri /api/v2/album/7gmS9r
UriDescription Album by key
ResponseLevel Public
AlbumKey 7gmS9r
AllowDownloads true
CanShare true
Description empty string
External true
HasDownloadPassword false
ImageCount 0
ImagesLastUpdated 2017-04-01T08:49:54+00:00
Keywords empty string
LastUpdated 2017-04-01T08:49:54+00:00
Name april gallery
NiceName April-gallery
NodeID v6QGnx
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title april gallery
UrlName April-gallery
UrlPath /April-2017-folder/April-gallery
WebUri http://www.michaelmileyphotography.ie/April-2017-folder/April-gallery

Uris

AlbumComments /api/v2/album/7gmS9r!comments
AlbumDownload /api/v2/album/7gmS9r!download
AlbumGeoMedia /api/v2/album/7gmS9r!geomedia
AlbumHighlightImage /api/v2/album/7gmS9r!highlightimage
AlbumImages /api/v2/album/7gmS9r!images
AlbumPopularMedia /api/v2/album/7gmS9r!popularmedia
AlbumPrices /api/v2/album/7gmS9r!prices
AlbumShareUris /api/v2/album/7gmS9r!shareuris
Folder /api/v2/folder/user/michaelmileyphotography/April-2017-folder
HighlightImage /api/v2/highlight/node/v6QGnx
Node /api/v2/node/v6QGnx
NodeCoverImage /api/v2/node/v6QGnx!cover
ParentFolders /api/v2/folder/user/michaelmileyphotography/April-2017-folder!parents
User /api/v2/user/michaelmileyphotography

Timing

Total

cycles 1
objects 0
time 0.0371

Request

Uri /api/v2/album/7gmS9r?_shorturis=
Method GET
Version v2

Options

Path

  • /api
  • /v2
  • /album
  • /

Notes

  • To sort images manually first set SortMethod to Position
  • When selecting SortMethod=Position, SortMethod is automatically set to Ascending
  • NiceName is deprecated; use UrlName instead
  • Title is deprecated; use Name instead
  • AlbumHighlightImage is deprecated, use HighlightImage instead

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

AlbumKey text
AllowDownloads boolean
Backprinting text
BoutiquePackaging select
  • No
  • Yes
  • Inherit from User
CanRank boolean
CanShare boolean Does the owner of this album want it to be shareable?
Clean boolean
Comments boolean
Date datetime
Description text
DownloadPassword text
EXIF boolean
External Deprecated as of 2015-09-08 An old setting that no longer has any function
FamilyEdit boolean
Filenames boolean
FriendEdit boolean
Geography boolean
HasDownloadPassword boolean
Header select
  • Custom
  • SmugMug
 Appearance
HideOwner boolean
HighlightAlbumImageUri uri
ImageCount integer
ImagesLastUpdated timestamp The last time at which images were added, removed, or rearranged in this album
InterceptShipping select
  • No
  • Yes
  • Inherit from User
 Personal Delivery
Keywords text
LargestSize select
  • Medium
  • Large
  • XLarge
  • X2Large
  • X3Large
  • X4Large
  • X5Large
  • 4K
  • 5K
  • Original
LastUpdated datetime
Name text
NiceName Deprecated as of 2014-11-20 Use UrlName instead
NodeID text
OriginalSizes integer
PackagingBranding boolean
Password text
PasswordHint text
Printable boolean
PrintmarkUri uri
Privacy select
  • Public
  • Unlisted
  • Private
 "Private" is not supported on legacy accounts
ProofDays integer
Protected boolean Right-Click Protection
SecurityType select
  • None
  • Password
  • GrantAccess
Share boolean
Slideshow boolean
SmugSearchable select
  • No
  • Inherit from User
SortDirection select
  • Ascending
  • Descending
SortMethod select
  • Position
  • Caption
  • Filename
  • Date Uploaded
  • Date Modified
  • Date Taken
SquareThumbs boolean
TemplateUri uri
ThemeUri uri Only applies to legacy accounts
Title Deprecated as of 2014-11-20 Use Name instead
TotalSizes integer
UploadKey text Guest UploadKey
UrlName text A human-readable name for use in the URL
UrlPath text
Watermark boolean Automatically apply watermark to uploaded images?
WatermarkUri uri
WorldSearchable boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/7gmS9r?_shorturis="
    },
    "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": "NiceName",
                "Description": "Use UrlName instead",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 60,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "UrlName",
                "Description": "A human-readable name for use in the URL",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 60
            },
            {
                "Name": "Title",
                "Description": "Use Name instead",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255,
                "Deprecated": "2014-11-20"
            },
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "PrintmarkUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Printmark"
                ]
            },
            {
                "Name": "WatermarkUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Watermark"
                ]
            },
            {
                "Name": "ThemeUri",
                "Description": "Only applies to legacy accounts",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Theme"
                ]
            },
            {
                "Name": "TemplateUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Template"
                ]
            },
            {
                "Name": "AllowDownloads",
                "Type": "Boolean"
            },
            {
                "Name": "Backprinting",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "BoutiquePackaging",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "CanRank",
                "Type": "Boolean"
            },
            {
                "Name": "Clean",
                "Type": "Boolean"
            },
            {
                "Name": "Comments",
                "Type": "Boolean"
            },
            {
                "Name": "Description",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": 65535
            },
            {
                "Name": "DownloadPassword",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "EXIF",
                "Type": "Boolean"
            },
            {
                "Name": "External",
                "Description": "An old setting that no longer has any function",
                "Type": "Boolean",
                "Deprecated": "2015-09-08"
            },
            {
                "Name": "FamilyEdit",
                "Type": "Boolean"
            },
            {
                "Name": "Filenames",
                "Type": "Boolean"
            },
            {
                "Name": "FriendEdit",
                "Type": "Boolean"
            },
            {
                "Name": "Geography",
                "Type": "Boolean"
            },
            {
                "Name": "Header",
                "Description": "Appearance",
                "Type": "Select",
                "OPTIONS": [
                    "Custom",
                    "SmugMug"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "HideOwner",
                "Type": "Boolean"
            },
            {
                "Name": "InterceptShipping",
                "Description": "Personal Delivery",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "LargestSize",
                "Type": "Select",
                "OPTIONS": [
                    "Medium",
                    "Large",
                    "XLarge",
                    "X2Large",
                    "X3Large",
                    "X4Large",
                    "X5Large",
                    "4K",
                    "5K",
                    "Original"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "PackagingBranding",
                "Type": "Boolean"
            },
            {
                "Name": "Password",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "PasswordHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Printable",
                "Type": "Boolean"
            },
            {
                "Name": "Privacy",
                "Description": "\"Private\" is not supported on legacy accounts",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "ProofDays",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "Protected",
                "Description": "Right-Click Protection",
                "Type": "Boolean"
            },
            {
                "Name": "Share",
                "Type": "Boolean"
            },
            {
                "Name": "Slideshow",
                "Type": "Boolean"
            },
            {
                "Name": "SmugSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortDirection",
                "Type": "Select",
                "OPTIONS": [
                    "Ascending",
                    "Descending"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortMethod",
                "Type": "Select",
                "OPTIONS": [
                    "Position",
                    "Caption",
                    "Filename",
                    "Date Uploaded",
                    "Date Modified",
                    "Date Taken"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SquareThumbs",
                "Type": "Boolean"
            },
            {
                "Name": "UploadKey",
                "Description": "Guest UploadKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Watermark",
                "Description": "Automatically apply watermark to uploaded images?",
                "Type": "Boolean"
            },
            {
                "Name": "WorldSearchable",
                "Type": "Boolean"
            },
            {
                "Name": "SecurityType",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": "ALL"
            },
            {
                "Name": "HighlightAlbumImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "AlbumImage"
                ]
            },
            {
                "Name": "AlbumKey",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Date",
                "Type": "DateTime"
            },
            {
                "Name": "LastUpdated",
                "Type": "DateTime"
            },
            {
                "Name": "ImagesLastUpdated",
                "Description": "The last time at which images were added, removed, or rearranged in this album",
                "Type": "Timestamp"
            },
            {
                "Name": "NodeID",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "OriginalSizes",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "TotalSizes",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ImageCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "UrlPath",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "CanShare",
                "Description": "Does the owner of this album want it to be shareable?",
                "Type": "Boolean"
            },
            {
                "Name": "HasDownloadPassword",
                "Type": "Boolean"
            }
        ],
        "Notes": [
            "To sort images manually first set SortMethod to Position",
            "When selecting SortMethod=Position, SortMethod is automatically set to Ascending",
            "NiceName is deprecated; use UrlName instead",
            "Title is deprecated; use Name instead",
            "AlbumHighlightImage is deprecated, use HighlightImage instead"
        ],
        "ResponseLevels": [
            "Full",
            "Password",
            "Public",
            "GrantAccess"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "7gmS9r"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/7gmS9r?_shorturis=",
        "Locator": "Album",
        "LocatorType": "Object",
        "Album": {
            "NiceName": "April-gallery",
            "UrlName": "April-gallery",
            "Title": "april gallery",
            "Name": "april gallery",
            "AllowDownloads": true,
            "Description": "",
            "External": true,
            "Keywords": "",
            "PasswordHint": "",
            "Protected": false,
            "SortDirection": "Ascending",
            "SortMethod": "Position",
            "SecurityType": "None",
            "AlbumKey": "7gmS9r",
            "LastUpdated": "2017-04-01T08:49:54+00:00",
            "ImagesLastUpdated": "2017-04-01T08:49:54+00:00",
            "NodeID": "v6QGnx",
            "ImageCount": 0,
            "UrlPath": "/April-2017-folder/April-gallery",
            "CanShare": true,
            "HasDownloadPassword": false,
            "Uri": "/api/v2/album/7gmS9r",
            "WebUri": "http://www.michaelmileyphotography.ie/April-2017-folder/April-gallery",
            "UriDescription": "Album by key",
            "Uris": {
                "AlbumShareUris": "/api/v2/album/7gmS9r!shareuris",
                "Node": "/api/v2/node/v6QGnx",
                "NodeCoverImage": "/api/v2/node/v6QGnx!cover",
                "User": "/api/v2/user/michaelmileyphotography",
                "Folder": "/api/v2/folder/user/michaelmileyphotography/April-2017-folder",
                "ParentFolders": "/api/v2/folder/user/michaelmileyphotography/April-2017-folder!parents",
                "HighlightImage": "/api/v2/highlight/node/v6QGnx",
                "AlbumHighlightImage": "/api/v2/album/7gmS9r!highlightimage",
                "AlbumImages": "/api/v2/album/7gmS9r!images",
                "AlbumPopularMedia": "/api/v2/album/7gmS9r!popularmedia",
                "AlbumGeoMedia": "/api/v2/album/7gmS9r!geomedia",
                "AlbumComments": "/api/v2/album/7gmS9r!comments",
                "AlbumDownload": "/api/v2/album/7gmS9r!download",
                "AlbumPrices": "/api/v2/album/7gmS9r!prices"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Album by key",
        "EndpointType": "Album",
        "DocUri": "https://api.smugmug.com/api/v2/doc/reference/album.html",
        "Timing": {
            "Total": {
                "time": 0.0371,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Options
    1. Notes
    2. Available Response Levels
    3. Methods
    4. Available Media Types
    5. Output Fields
  4. JSON