Response [200 Ok]

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

Album [1 of 1] - 2017 Myanmar Business Mission
/api/v2/album/GH33HM

Uri /api/v2/album/GH33HM
UriDescription Album by key
ResponseLevel Public
AlbumKey GH33HM
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description Nay Pyi Taw and Yangon, December 6-8
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 570
ImagesLastUpdated 2022-09-20T15:12:04+00:00
Keywords empty string
LastUpdated 2017-12-22T20:07:13+00:00
Name 2017 Myanmar Business Mission
NiceName 2017-Myanmar-Business-Mission
NodeID BNXTLW
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Position
Title 2017 Myanmar Business Mission
UrlName 2017-Myanmar-Business-Mission
UrlPath /Business-Missions/2017/2017-Myanmar-Business-Mission/2017-Myanmar-Business-Mission
WebUri https://photos.usasean.org/Business-Missions/2017/2017-Myanmar-Business-Mission/2017-Myanmar-Business-Mission

Uris

AlbumComments
/api/v2/album/GH33HM!comments

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

AlbumDownload
/api/v2/album/GH33HM!download

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

AlbumGeoMedia
/api/v2/album/GH33HM!geomedia

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

AlbumHighlightImage
/api/v2/album/GH33HM!highlightimage

Uri /api/v2/album/GH33HM!highlightimage
UriDescription Highlight image for album
EndpointType AlbumHighlightImage
Locator AlbumImage
LocatorType Object

AlbumImages
/api/v2/album/GH33HM!images

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

AlbumPopularMedia
/api/v2/album/GH33HM!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/GH33HM!pricelistexclusions

Uri /api/v2/album/GH33HM!pricelistexclusions
UriDescription Pricelist information for an Album
EndpointType AlbumPricelistExclusions
Locator AlbumPricelistExclusions
LocatorType Object

AlbumPrices
/api/v2/album/GH33HM!prices

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

AlbumShareUris
/api/v2/album/GH33HM!shareuris

Uri /api/v2/album/GH33HM!shareuris
UriDescription URIs that are useful for sharing
EndpointType AlbumShareUris
Locator AlbumShareUris
LocatorType Object

HighlightImage
/api/v2/highlight/node/BNXTLW

Uri /api/v2/highlight/node/BNXTLW
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object

Node
/api/v2/node/BNXTLW

Uri /api/v2/node/BNXTLW
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

NodeCoverImage
/api/v2/node/BNXTLW!cover

Uri /api/v2/node/BNXTLW!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object

ParentFolders
/api/v2/folder/user/US-ASEAN/Business-Missions/2017/2017-Myanmar-Business-Mission!parents

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2017/2017-Myanmar-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

Timing

Total

cycles 1
objects 0
time 0.04017

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/2017/2017-Myanmar-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",
                    "2017",
                    "2017-Myanmar-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/2017/2017-Myanmar-Business-Mission!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "2017-Myanmar-Business-Mission",
                "UrlName": "2017-Myanmar-Business-Mission",
                "Title": "2017 Myanmar Business Mission",
                "Name": "2017 Myanmar Business Mission",
                "AllowDownloads": true,
                "Description": "Nay Pyi Taw and Yangon, December 6-8",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Position",
                "SecurityType": "None",
                "AlbumKey": "GH33HM",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2017-12-22T20:07:13+00:00",
                "ImagesLastUpdated": "2022-09-20T15:12:04+00:00",
                "NodeID": "BNXTLW",
                "ImageCount": 570,
                "UrlPath": "/Business-Missions/2017/2017-Myanmar-Business-Mission/2017-Myanmar-Business-Mission",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/GH33HM",
                "WebUri": "https://photos.usasean.org/Business-Missions/2017/2017-Myanmar-Business-Mission/2017-Myanmar-Business-Mission",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/GH33HM!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/BNXTLW",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/BNXTLW!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/2017/2017-Myanmar-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/2017/2017-Myanmar-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/BNXTLW",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/GH33HM!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/GH33HM!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/GH33HM!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/GH33HM!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/GH33HM!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/GH33HM!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/GH33HM!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/GH33HM!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.04017,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}