Response [200 Ok]

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

Album [1 of 2] - November 3rd
/api/v2/album/QkXxVF

Uri /api/v2/album/QkXxVF
UriDescription Album by key
ResponseLevel Public
AlbumKey QkXxVF
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 1600
ImagesLastUpdated 2022-09-20T01:09:31+00:00
Keywords empty string
LastUpdated 2014-11-12T23:58:04+00:00
Name November 3rd
NiceName November-3rd
NodeID 8Hhbx
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title November 3rd
UrlName November-3rd
UrlPath /Business-Missions/2014/Thailand-Business-Mission/November-3rd
WebUri https://photos.usasean.org/Business-Missions/2014/Thailand-Business-Mission/November-3rd

Uris

AlbumComments
/api/v2/album/QkXxVF!comments

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

AlbumDownload
/api/v2/album/QkXxVF!download

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

AlbumGeoMedia
/api/v2/album/QkXxVF!geomedia

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

AlbumHighlightImage
/api/v2/album/QkXxVF!highlightimage

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

AlbumImages
/api/v2/album/QkXxVF!images

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

AlbumPopularMedia
/api/v2/album/QkXxVF!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/QkXxVF!pricelistexclusions

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

AlbumPrices
/api/v2/album/QkXxVF!prices

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

AlbumShareUris
/api/v2/album/QkXxVF!shareuris

Uri /api/v2/album/QkXxVF!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/Business-Missions/2014/Thailand-Business-Mission

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/8Hhbx

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

Node
/api/v2/node/8Hhbx

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

NodeCoverImage
/api/v2/node/8Hhbx!cover

Uri /api/v2/node/8Hhbx!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/Business-Missions/2014/Thailand-Business-Mission!parents

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!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] - November 4th
/api/v2/album/nR78h2

Uri /api/v2/album/nR78h2
UriDescription Album by key
ResponseLevel Public
AlbumKey nR78h2
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 1565
ImagesLastUpdated 2022-09-18T18:18:55+00:00
Keywords empty string
LastUpdated 2014-11-13T01:19:54+00:00
Name November 4th
NiceName November-4th
NodeID jmKqq
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title November 4th
UrlName November-4th
UrlPath /Business-Missions/2014/Thailand-Business-Mission/November-4th
WebUri https://photos.usasean.org/Business-Missions/2014/Thailand-Business-Mission/November-4th

Uris

AlbumComments
/api/v2/album/nR78h2!comments

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

AlbumDownload
/api/v2/album/nR78h2!download

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

AlbumGeoMedia
/api/v2/album/nR78h2!geomedia

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

AlbumHighlightImage
/api/v2/album/nR78h2!highlightimage

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

AlbumImages
/api/v2/album/nR78h2!images

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

AlbumPopularMedia
/api/v2/album/nR78h2!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/nR78h2!pricelistexclusions

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

AlbumPrices
/api/v2/album/nR78h2!prices

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

AlbumShareUris
/api/v2/album/nR78h2!shareuris

Uri /api/v2/album/nR78h2!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/Business-Missions/2014/Thailand-Business-Mission

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission
UriDescription A folder or legacy (sub)category by UrlPath
EndpointType Folder
Locator Folder
LocatorType Object
Folder [1 of 1]

HighlightImage
/api/v2/highlight/node/jmKqq

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

Node
/api/v2/node/jmKqq

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

NodeCoverImage
/api/v2/node/jmKqq!cover

Uri /api/v2/node/jmKqq!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/Business-Missions/2014/Thailand-Business-Mission!parents

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!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.03394

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/Business-Missions/2014/Thailand-Business-Mission!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": [
                    "Business-Missions",
                    "2014",
                    "Thailand-Business-Mission"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "November-3rd",
                "UrlName": "November-3rd",
                "Title": "November 3rd",
                "Name": "November 3rd",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Position",
                "SecurityType": "None",
                "AlbumKey": "QkXxVF",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2014-11-12T23:58:04+00:00",
                "ImagesLastUpdated": "2022-09-20T01:09:31+00:00",
                "NodeID": "8Hhbx",
                "ImageCount": 1600,
                "UrlPath": "/Business-Missions/2014/Thailand-Business-Mission/November-3rd",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/QkXxVF",
                "WebUri": "https://photos.usasean.org/Business-Missions/2014/Thailand-Business-Mission/November-3rd",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/QkXxVF!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/8Hhbx",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/8Hhbx!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/Business-Missions/2014/Thailand-Business-Mission",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!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/8Hhbx",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/QkXxVF!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/QkXxVF!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/QkXxVF!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/QkXxVF!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/QkXxVF!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/QkXxVF!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/QkXxVF!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/QkXxVF!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "November-4th",
                "UrlName": "November-4th",
                "Title": "November 4th",
                "Name": "November 4th",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Position",
                "SecurityType": "None",
                "AlbumKey": "nR78h2",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2014-11-13T01:19:54+00:00",
                "ImagesLastUpdated": "2022-09-18T18:18:55+00:00",
                "NodeID": "jmKqq",
                "ImageCount": 1565,
                "UrlPath": "/Business-Missions/2014/Thailand-Business-Mission/November-4th",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/nR78h2",
                "WebUri": "https://photos.usasean.org/Business-Missions/2014/Thailand-Business-Mission/November-4th",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/nR78h2!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/jmKqq",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/jmKqq!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/Business-Missions/2014/Thailand-Business-Mission",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "A folder or legacy (sub)category by UrlPath",
                        "EndpointType": "Folder"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2014/Thailand-Business-Mission!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/jmKqq",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/nR78h2!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/nR78h2!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/nR78h2!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/nR78h2!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/nR78h2!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/nR78h2!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/nR78h2!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/nR78h2!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.03394,
                "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