Response [200 Ok]

Uri /api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

Album [1 of 2] - CGL Adrogue
/api/v2/album/8kx5tS

Uri /api/v2/album/8kx5tS
UriDescription Album by key
ResponseLevel Public
AlbumKey 8kx5tS
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description May 24 - 25 2024
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 16
ImagesLastUpdated 2024-06-18T07:31:18+00:00
Keywords empty string
LastUpdated 2024-06-18T07:25:08+00:00
Name CGL Adrogue
NiceName CGL-Adrogue
NodeID twX32N
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title CGL Adrogue
UrlName CGL-Adrogue
UrlPath /Latin-America/GLS23-24/Argentina/CGL-Adrogue
WebUri https://globalleadership.smugmug.com/Latin-America/GLS23-24/Argentina/CGL-Adrogue

Uris

AlbumComments
/api/v2/album/8kx5tS!comments

Uri /api/v2/album/8kx5tS!comments
UriDescription Comments on album
EndpointType AlbumComments
Locator Comment
LocatorType Objects

AlbumDownload
/api/v2/album/8kx5tS!download

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

AlbumGeoMedia
/api/v2/album/8kx5tS!geomedia

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

AlbumHighlightImage
/api/v2/album/8kx5tS!highlightimage

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

AlbumImages
/api/v2/album/8kx5tS!images

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

AlbumPopularMedia
/api/v2/album/8kx5tS!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/8kx5tS!pricelistexclusions

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

AlbumPrices
/api/v2/album/8kx5tS!prices

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

AlbumShareUris
/api/v2/album/8kx5tS!shareuris

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

Folder
/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina

Uri /api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/twX32N

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

Node
/api/v2/node/twX32N

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

NodeCoverImage
/api/v2/node/twX32N!cover

Uri /api/v2/node/twX32N!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/globalleadership/Latin-America/GLS23-24/Argentina!parents

Uri /api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/globalleadership

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

Album [2 of 2] - CGL Rosario
/api/v2/album/gtMBfb

Uri /api/v2/album/gtMBfb
UriDescription Album by key
ResponseLevel Public
AlbumKey gtMBfb
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description 3/16/2024
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 9
ImagesLastUpdated 2024-03-20T07:17:02+00:00
Keywords empty string
LastUpdated 2024-03-20T07:15:45+00:00
Name CGL Rosario
NiceName CGL-Rosario
NodeID Q6Pqm3
Packages false
PasswordHint empty string
Protected true
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title CGL Rosario
UrlName CGL-Rosario
UrlPath /Latin-America/GLS23-24/Argentina/CGL-Rosario
WebUri https://globalleadership.smugmug.com/Latin-America/GLS23-24/Argentina/CGL-Rosario

Uris

AlbumComments
/api/v2/album/gtMBfb!comments

Uri /api/v2/album/gtMBfb!comments
UriDescription Comments on album
EndpointType AlbumComments
Locator Comment
LocatorType Objects

AlbumDownload
/api/v2/album/gtMBfb!download

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

AlbumGeoMedia
/api/v2/album/gtMBfb!geomedia

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

AlbumHighlightImage
/api/v2/album/gtMBfb!highlightimage

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

AlbumImages
/api/v2/album/gtMBfb!images

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

AlbumPopularMedia
/api/v2/album/gtMBfb!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/gtMBfb!pricelistexclusions

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

AlbumPrices
/api/v2/album/gtMBfb!prices

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

AlbumShareUris
/api/v2/album/gtMBfb!shareuris

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

Folder
/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina

Uri /api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/Q6Pqm3

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

Node
/api/v2/node/Q6Pqm3

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

NodeCoverImage
/api/v2/node/Q6Pqm3!cover

Uri /api/v2/node/Q6Pqm3!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/globalleadership/Latin-America/GLS23-24/Argentina!parents

Uri /api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/globalleadership

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

Timing

Total

cycles 1
objects 0
time 0.04911

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/globalleadership/Latin-America/GLS23-24/Argentina!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": "globalleadership",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Latin-America",
                    "GLS23-24",
                    "Argentina"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "CGL-Adrogue",
                "UrlName": "CGL-Adrogue",
                "Title": "CGL Adrogue",
                "Name": "CGL Adrogue",
                "AllowDownloads": true,
                "Description": "May 24 - 25 2024",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "8kx5tS",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2024-06-18T07:25:08+00:00",
                "ImagesLastUpdated": "2024-06-18T07:31:18+00:00",
                "NodeID": "twX32N",
                "ImageCount": 16,
                "UrlPath": "/Latin-America/GLS23-24/Argentina/CGL-Adrogue",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/8kx5tS",
                "WebUri": "https://globalleadership.smugmug.com/Latin-America/GLS23-24/Argentina/CGL-Adrogue",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/8kx5tS!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/twX32N",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/twX32N!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/globalleadership",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!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/twX32N",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/8kx5tS!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/8kx5tS!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/8kx5tS!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/8kx5tS!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/8kx5tS!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/8kx5tS!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/8kx5tS!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/8kx5tS!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "CGL-Rosario",
                "UrlName": "CGL-Rosario",
                "Title": "CGL Rosario",
                "Name": "CGL Rosario",
                "AllowDownloads": true,
                "Description": "3/16/2024",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": true,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "gtMBfb",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2024-03-20T07:15:45+00:00",
                "ImagesLastUpdated": "2024-03-20T07:17:02+00:00",
                "NodeID": "Q6Pqm3",
                "ImageCount": 9,
                "UrlPath": "/Latin-America/GLS23-24/Argentina/CGL-Rosario",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/gtMBfb",
                "WebUri": "https://globalleadership.smugmug.com/Latin-America/GLS23-24/Argentina/CGL-Rosario",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/gtMBfb!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/Q6Pqm3",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/Q6Pqm3!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/globalleadership",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/globalleadership/Latin-America/GLS23-24/Argentina!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/Q6Pqm3",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/gtMBfb!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/gtMBfb!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/gtMBfb!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/gtMBfb!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/gtMBfb!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/gtMBfb!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/gtMBfb!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/gtMBfb!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.04911,
                "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