Response [200 Ok]

Uri /api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

Album [1 of 2] - Kangerlussuaq
/api/v2/album/9wLFgz

Uri /api/v2/album/9wLFgz
UriDescription Album by key
ResponseLevel Public
AlbumKey 9wLFgz
AllowDownloads true
CanBuy false
CanFavorite false
CanShare true
Description empty string
EXIF false
External true
Filenames false
Geography true
HasDownloadPassword true
ImageCount 838
ImagesLastUpdated 2024-08-27T16:45:17+00:00
Keywords empty string
LastUpdated 2024-08-27T16:43:51+00:00
Name Kangerlussuaq
NiceName Kangerlussuaq
NodeID Cc2VdP
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Descending
SortMethod Date Uploaded
Title Kangerlussuaq
UrlName Kangerlussuaq
UrlPath /Kangerlussuaq-1/Kangerlussuaq
WebUri https://destinationarcticcircle.smugmug.com/Kangerlussuaq-1/Kangerlussuaq

Uris

AlbumGeoMedia
/api/v2/album/9wLFgz!geomedia

Uri /api/v2/album/9wLFgz!geomedia
UriDescription Geotagged images from album
EndpointType AlbumGeoMedia
Locator AlbumImage
LocatorType Objects

AlbumHighlightImage
/api/v2/album/9wLFgz!highlightimage

Uri /api/v2/album/9wLFgz!highlightimage
UriDescription Highlight image for album
EndpointType AlbumHighlightImage
Locator AlbumImage
LocatorType Object
AlbumImage [1 of 1]

AlbumImages
/api/v2/album/9wLFgz!images

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

AlbumPopularMedia
/api/v2/album/9wLFgz!popularmedia

Uri /api/v2/album/9wLFgz!popularmedia
UriDescription Popular images from album
EndpointType AlbumPopularMedia
Locator AlbumImage
LocatorType Objects

AlbumPricelistExclusions
/api/v2/album/9wLFgz!pricelistexclusions

Uri /api/v2/album/9wLFgz!pricelistexclusions
UriDescription Pricelist information for an Album
EndpointType AlbumPricelistExclusions
Locator AlbumPricelistExclusions
LocatorType Object
AlbumPricelistExclusions [1 of 1]

AlbumPrices
/api/v2/album/9wLFgz!prices

Uri /api/v2/album/9wLFgz!prices
UriDescription Purchasable Skus
EndpointType AlbumPrices
Locator CatalogSkuPrice
LocatorType Objects

AlbumShareUris
/api/v2/album/9wLFgz!shareuris

Uri /api/v2/album/9wLFgz!shareuris
UriDescription URIs that are useful for sharing
EndpointType AlbumShareUris
Locator AlbumShareUris
LocatorType Object
AlbumShareUris [1 of 1]

Folder
/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1

Uri /api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/Cc2VdP

Uri /api/v2/highlight/node/Cc2VdP
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object
Image [1 of 1]

Node
/api/v2/node/Cc2VdP

Uri /api/v2/node/Cc2VdP
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object
Node [1 of 1]

NodeCoverImage
/api/v2/node/Cc2VdP!cover

Uri /api/v2/node/Cc2VdP!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

ParentFolders
/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents

Uri /api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

UnlockAlbumDownload
/api/v2/album/9wLFgz!unlockdownload

Uri /api/v2/album/9wLFgz!unlockdownload
UriDescription Unlock password-protected album download
EndpointType UnlockAlbumDownload

User
/api/v2/user/destinationarcticcircle

Uri /api/v2/user/destinationarcticcircle
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object
User [1 of 1]

Album [2 of 2] - Kangerlussuaq General
/api/v2/album/FvRK68

Uri /api/v2/album/FvRK68
UriDescription Album by key
ResponseLevel Public
AlbumKey FvRK68
AllowDownloads true
CanBuy false
CanFavorite false
CanShare true
Description empty string
EXIF false
External true
Filenames false
Geography true
HasDownloadPassword true
ImageCount 58
ImagesLastUpdated 2024-12-31T08:22:07+00:00
Keywords empty string
LastUpdated 2023-08-21T13:27:45+00:00
Name Kangerlussuaq General
NiceName Kangerlussuaq-General
NodeID gWCjgp
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title Kangerlussuaq General
UrlName Kangerlussuaq-General
UrlPath /Kangerlussuaq-1/Kangerlussuaq-General
WebUri https://destinationarcticcircle.smugmug.com/Kangerlussuaq-1/Kangerlussuaq-General

Uris

AlbumGeoMedia
/api/v2/album/FvRK68!geomedia

Uri /api/v2/album/FvRK68!geomedia
UriDescription Geotagged images from album
EndpointType AlbumGeoMedia
Locator AlbumImage
LocatorType Objects

AlbumHighlightImage
/api/v2/album/FvRK68!highlightimage

Uri /api/v2/album/FvRK68!highlightimage
UriDescription Highlight image for album
EndpointType AlbumHighlightImage
Locator AlbumImage
LocatorType Object
AlbumImage [1 of 1]

AlbumImages
/api/v2/album/FvRK68!images

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

AlbumPopularMedia
/api/v2/album/FvRK68!popularmedia

Uri /api/v2/album/FvRK68!popularmedia
UriDescription Popular images from album
EndpointType AlbumPopularMedia
Locator AlbumImage
LocatorType Objects

AlbumPricelistExclusions
/api/v2/album/FvRK68!pricelistexclusions

Uri /api/v2/album/FvRK68!pricelistexclusions
UriDescription Pricelist information for an Album
EndpointType AlbumPricelistExclusions
Locator AlbumPricelistExclusions
LocatorType Object
AlbumPricelistExclusions [1 of 1]

AlbumPrices
/api/v2/album/FvRK68!prices

Uri /api/v2/album/FvRK68!prices
UriDescription Purchasable Skus
EndpointType AlbumPrices
Locator CatalogSkuPrice
LocatorType Objects

AlbumShareUris
/api/v2/album/FvRK68!shareuris

Uri /api/v2/album/FvRK68!shareuris
UriDescription URIs that are useful for sharing
EndpointType AlbumShareUris
Locator AlbumShareUris
LocatorType Object
AlbumShareUris [1 of 1]

Folder
/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1

Uri /api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/gWCjgp

Uri /api/v2/highlight/node/gWCjgp
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object
Image [1 of 1]

Node
/api/v2/node/gWCjgp

Uri /api/v2/node/gWCjgp
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object
Node [1 of 1]

NodeCoverImage
/api/v2/node/gWCjgp!cover

Uri /api/v2/node/gWCjgp!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

ParentFolders
/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents

Uri /api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

UnlockAlbumDownload
/api/v2/album/FvRK68!unlockdownload

Uri /api/v2/album/FvRK68!unlockdownload
UriDescription Unlock password-protected album download
EndpointType UnlockAlbumDownload

User
/api/v2/user/destinationarcticcircle

Uri /api/v2/user/destinationarcticcircle
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object
User [1 of 1]

Timing

Total

cycles 1
objects 0
time 0.0374

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !albums

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Add

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!albums"
    },
    "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": "FolderID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Type": "Varchar",
                    "MIN_CHARS": 5,
                    "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": "folder"
            },
            {
                "type": "path",
                "text": "user"
            },
            {
                "type": "singleparam",
                "param_name": "nickname",
                "param_value": "destinationarcticcircle",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Kangerlussuaq-1"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "Kangerlussuaq",
                "UrlName": "Kangerlussuaq",
                "Title": "Kangerlussuaq",
                "Name": "Kangerlussuaq",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": false,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Descending",
                "SortMethod": "Date Uploaded",
                "SecurityType": "None",
                "AlbumKey": "9wLFgz",
                "CanBuy": false,
                "CanFavorite": false,
                "LastUpdated": "2024-08-27T16:43:51+00:00",
                "ImagesLastUpdated": "2024-08-27T16:45:17+00:00",
                "NodeID": "Cc2VdP",
                "ImageCount": 838,
                "UrlPath": "/Kangerlussuaq-1/Kangerlussuaq",
                "CanShare": true,
                "HasDownloadPassword": true,
                "Packages": false,
                "Uri": "/api/v2/album/9wLFgz",
                "WebUri": "https://destinationarcticcircle.smugmug.com/Kangerlussuaq-1/Kangerlussuaq",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/9wLFgz!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/Cc2VdP",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/Cc2VdP!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/destinationarcticcircle",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "The sequence of parent folders, from the given folder to the root",
                        "EndpointType": "ParentFolders"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/Cc2VdP",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/9wLFgz!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/9wLFgz!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/9wLFgz!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/9wLFgz!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "UnlockAlbumDownload": {
                        "Uri": "/api/v2/album/9wLFgz!unlockdownload",
                        "UriDescription": "Unlock password-protected album download",
                        "EndpointType": "UnlockAlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/9wLFgz!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/9wLFgz!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "Kangerlussuaq-General",
                "UrlName": "Kangerlussuaq-General",
                "Title": "Kangerlussuaq General",
                "Name": "Kangerlussuaq General",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": false,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "FvRK68",
                "CanBuy": false,
                "CanFavorite": false,
                "LastUpdated": "2023-08-21T13:27:45+00:00",
                "ImagesLastUpdated": "2024-12-31T08:22:07+00:00",
                "NodeID": "gWCjgp",
                "ImageCount": 58,
                "UrlPath": "/Kangerlussuaq-1/Kangerlussuaq-General",
                "CanShare": true,
                "HasDownloadPassword": true,
                "Packages": false,
                "Uri": "/api/v2/album/FvRK68",
                "WebUri": "https://destinationarcticcircle.smugmug.com/Kangerlussuaq-1/Kangerlussuaq-General",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/FvRK68!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/gWCjgp",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/gWCjgp!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/destinationarcticcircle",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1!parents",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "The sequence of parent folders, from the given folder to the root",
                        "EndpointType": "ParentFolders"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/gWCjgp",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/FvRK68!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/FvRK68!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/FvRK68!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/FvRK68!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "UnlockAlbumDownload": {
                        "Uri": "/api/v2/album/FvRK68!unlockdownload",
                        "UriDescription": "Unlock password-protected album download",
                        "EndpointType": "UnlockAlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/FvRK68!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/FvRK68!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Albums inside of the folder",
        "EndpointType": "FolderAlbums",
        "Timing": {
            "Total": {
                "time": 0.0374,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Notes
    2. Methods
    3. Available Media Types
    4. Parameters
  5. JSON