Response [200 Ok]

Uri /api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

Album [1 of 2] - 2014
/api/v2/album/ntb2Xd

Uri /api/v2/album/ntb2Xd
UriDescription Album by key
ResponseLevel Public
AlbumKey ntb2Xd
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 12
ImagesLastUpdated 2022-09-09T09:25:31+00:00
Keywords empty string
LastUpdated 2014-10-10T14:02:27+00:00
Name 2014
NiceName 2014
NodeID rrWC5
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title 2014
UrlName 2014
UrlPath /Other/ASEAN-Ambassadors-Tours/2014
WebUri https://photos.usasean.org/Other/ASEAN-Ambassadors-Tours/2014

Uris

AlbumComments
/api/v2/album/ntb2Xd!comments

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

AlbumDownload
/api/v2/album/ntb2Xd!download

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

AlbumGeoMedia
/api/v2/album/ntb2Xd!geomedia

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

AlbumHighlightImage
/api/v2/album/ntb2Xd!highlightimage

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

AlbumImages
/api/v2/album/ntb2Xd!images

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

AlbumPopularMedia
/api/v2/album/ntb2Xd!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/ntb2Xd!pricelistexclusions

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

AlbumPrices
/api/v2/album/ntb2Xd!prices

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

AlbumShareUris
/api/v2/album/ntb2Xd!shareuris

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

Folder
/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours

Uri /api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/rrWC5

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

Node
/api/v2/node/rrWC5

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

NodeCoverImage
/api/v2/node/rrWC5!cover

Uri /api/v2/node/rrWC5!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/US-ASEAN/Other/ASEAN-Ambassadors-Tours!parents

Uri /api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/US-ASEAN

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

Album [2 of 2] - 2013
/api/v2/album/KZ3wbL

Uri /api/v2/album/KZ3wbL
UriDescription Album by key
ResponseLevel Public
AlbumKey KZ3wbL
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 233
ImagesLastUpdated 2022-09-18T07:24:49+00:00
Keywords empty string
LastUpdated 2014-10-10T14:00:57+00:00
Name 2013
NiceName 2013
NodeID SzkBK
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title 2013
UrlName 2013
UrlPath /Other/ASEAN-Ambassadors-Tours/2013
WebUri https://photos.usasean.org/Other/ASEAN-Ambassadors-Tours/2013

Uris

AlbumComments
/api/v2/album/KZ3wbL!comments

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

AlbumDownload
/api/v2/album/KZ3wbL!download

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

AlbumGeoMedia
/api/v2/album/KZ3wbL!geomedia

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

AlbumHighlightImage
/api/v2/album/KZ3wbL!highlightimage

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

AlbumImages
/api/v2/album/KZ3wbL!images

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

AlbumPopularMedia
/api/v2/album/KZ3wbL!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/KZ3wbL!pricelistexclusions

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

AlbumPrices
/api/v2/album/KZ3wbL!prices

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

AlbumShareUris
/api/v2/album/KZ3wbL!shareuris

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

Folder
/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours

Uri /api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/SzkBK

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

Node
/api/v2/node/SzkBK

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

NodeCoverImage
/api/v2/node/SzkBK!cover

Uri /api/v2/node/SzkBK!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/US-ASEAN/Other/ASEAN-Ambassadors-Tours!parents

Uri /api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/US-ASEAN

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

Timing

Total

cycles 1
objects 0
time 0.03746

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/US-ASEAN/Other/ASEAN-Ambassadors-Tours!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": "US-ASEAN",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Other",
                    "ASEAN-Ambassadors-Tours"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "2014",
                "UrlName": "2014",
                "Title": "2014",
                "Name": "2014",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Position",
                "SecurityType": "None",
                "AlbumKey": "ntb2Xd",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2014-10-10T14:02:27+00:00",
                "ImagesLastUpdated": "2022-09-09T09:25:31+00:00",
                "NodeID": "rrWC5",
                "ImageCount": 12,
                "UrlPath": "/Other/ASEAN-Ambassadors-Tours/2014",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/ntb2Xd",
                "WebUri": "https://photos.usasean.org/Other/ASEAN-Ambassadors-Tours/2014",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/ntb2Xd!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/rrWC5",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/rrWC5!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/US-ASEAN",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!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/rrWC5",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/ntb2Xd!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/ntb2Xd!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/ntb2Xd!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/ntb2Xd!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/ntb2Xd!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/ntb2Xd!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/ntb2Xd!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/ntb2Xd!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "2013",
                "UrlName": "2013",
                "Title": "2013",
                "Name": "2013",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Position",
                "SecurityType": "None",
                "AlbumKey": "KZ3wbL",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2014-10-10T14:00:57+00:00",
                "ImagesLastUpdated": "2022-09-18T07:24:49+00:00",
                "NodeID": "SzkBK",
                "ImageCount": 233,
                "UrlPath": "/Other/ASEAN-Ambassadors-Tours/2013",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/KZ3wbL",
                "WebUri": "https://photos.usasean.org/Other/ASEAN-Ambassadors-Tours/2013",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/KZ3wbL!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/SzkBK",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/SzkBK!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "User": {
                        "Uri": "/api/v2/user/US-ASEAN",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "Folder": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Other/ASEAN-Ambassadors-Tours!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/SzkBK",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/KZ3wbL!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/KZ3wbL!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/KZ3wbL!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/KZ3wbL!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/KZ3wbL!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/KZ3wbL!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/KZ3wbL!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/KZ3wbL!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.03746,
                "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