Response [200 Ok]

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

Album [1 of 2] - Avannaata Qimussersua
/api/v2/album/vqxTXC

Uri /api/v2/album/vqxTXC
UriDescription Album by key
ResponseLevel Public
AlbumKey vqxTXC
AllowDownloads true
CanBuy false
CanFavorite false
CanShare true
Description empty string
EXIF false
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 9
ImagesLastUpdated 2023-04-02T21:25:51+00:00
Keywords empty string
LastUpdated 2023-04-02T21:25:07+00:00
Name Avannaata Qimussersua
NiceName Avannaata-Qimussersua
NodeID r5SB9w
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title Avannaata Qimussersua
UrlName Avannaata-Qimussersua
UrlPath /Events/Avannaata-Qimussersua
WebUri https://destinationarcticcircle.smugmug.com/Events/Avannaata-Qimussersua

Uris

AlbumDownload
/api/v2/album/vqxTXC!download

Uri /api/v2/album/vqxTXC!download
UriDescription Download album
EndpointType AlbumDownload
Locator Download
LocatorType Objects

AlbumGeoMedia
/api/v2/album/vqxTXC!geomedia

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

AlbumHighlightImage
/api/v2/album/vqxTXC!highlightimage

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

AlbumImages
/api/v2/album/vqxTXC!images

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

AlbumPopularMedia
/api/v2/album/vqxTXC!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/vqxTXC!pricelistexclusions

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

AlbumPrices
/api/v2/album/vqxTXC!prices

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

AlbumShareUris
/api/v2/album/vqxTXC!shareuris

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

Folder
/api/v2/folder/user/destinationarcticcircle/Events

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

HighlightImage
/api/v2/highlight/node/r5SB9w

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

Node
/api/v2/node/r5SB9w

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

NodeCoverImage
/api/v2/node/r5SB9w!cover

Uri /api/v2/node/r5SB9w!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/Events!parents

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

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] - Extreme-E
/api/v2/album/tVTSGV

Uri /api/v2/album/tVTSGV
UriDescription Album by key
ResponseLevel Public
AlbumKey tVTSGV
AllowDownloads true
CanBuy false
CanFavorite false
CanShare true
Description empty string
EXIF false
External true
Filenames false
Geography true
HasDownloadPassword true
ImageCount 29
ImagesLastUpdated 2022-11-25T13:44:53+00:00
Keywords empty string
LastUpdated 2022-11-25T13:43:19+00:00
Name Extreme-E
NiceName Extreme-E
NodeID d4XwMJ
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title Extreme-E
UrlName Extreme-E
UrlPath /Events/Extreme-E
WebUri https://destinationarcticcircle.smugmug.com/Events/Extreme-E

Uris

AlbumGeoMedia
/api/v2/album/tVTSGV!geomedia

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

AlbumHighlightImage
/api/v2/album/tVTSGV!highlightimage

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

AlbumImages
/api/v2/album/tVTSGV!images

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

AlbumPopularMedia
/api/v2/album/tVTSGV!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/tVTSGV!pricelistexclusions

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

AlbumPrices
/api/v2/album/tVTSGV!prices

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

AlbumShareUris
/api/v2/album/tVTSGV!shareuris

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

Folder
/api/v2/folder/user/destinationarcticcircle/Events

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

HighlightImage
/api/v2/highlight/node/d4XwMJ

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

Node
/api/v2/node/d4XwMJ

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

NodeCoverImage
/api/v2/node/d4XwMJ!cover

Uri /api/v2/node/d4XwMJ!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/Events!parents

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

UnlockAlbumDownload
/api/v2/album/tVTSGV!unlockdownload

Uri /api/v2/album/tVTSGV!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.06267

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/Events!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": [
                    "Events"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/destinationarcticcircle/Events!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "Avannaata-Qimussersua",
                "UrlName": "Avannaata-Qimussersua",
                "Title": "Avannaata Qimussersua",
                "Name": "Avannaata Qimussersua",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": false,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "vqxTXC",
                "CanBuy": false,
                "CanFavorite": false,
                "LastUpdated": "2023-04-02T21:25:07+00:00",
                "ImagesLastUpdated": "2023-04-02T21:25:51+00:00",
                "NodeID": "r5SB9w",
                "ImageCount": 9,
                "UrlPath": "/Events/Avannaata-Qimussersua",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/vqxTXC",
                "WebUri": "https://destinationarcticcircle.smugmug.com/Events/Avannaata-Qimussersua",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/vqxTXC!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/r5SB9w",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/r5SB9w!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/Events",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Events!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/r5SB9w",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/vqxTXC!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/vqxTXC!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/vqxTXC!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/vqxTXC!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/vqxTXC!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/vqxTXC!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/vqxTXC!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "Extreme-E",
                "UrlName": "Extreme-E",
                "Title": "Extreme-E",
                "Name": "Extreme-E",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": false,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "tVTSGV",
                "CanBuy": false,
                "CanFavorite": false,
                "LastUpdated": "2022-11-25T13:43:19+00:00",
                "ImagesLastUpdated": "2022-11-25T13:44:53+00:00",
                "NodeID": "d4XwMJ",
                "ImageCount": 29,
                "UrlPath": "/Events/Extreme-E",
                "CanShare": true,
                "HasDownloadPassword": true,
                "Packages": false,
                "Uri": "/api/v2/album/tVTSGV",
                "WebUri": "https://destinationarcticcircle.smugmug.com/Events/Extreme-E",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/tVTSGV!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/d4XwMJ",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/d4XwMJ!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/Events",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/destinationarcticcircle/Events!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/d4XwMJ",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/tVTSGV!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/tVTSGV!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/tVTSGV!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/tVTSGV!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "UnlockAlbumDownload": {
                        "Uri": "/api/v2/album/tVTSGV!unlockdownload",
                        "UriDescription": "Unlock password-protected album download",
                        "EndpointType": "UnlockAlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/tVTSGV!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/tVTSGV!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.06267,
                "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