Response [200 Ok]

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

Album [1 of 2] - 2021 Indonesia Virtual Business Mission
/api/v2/album/xkc9Dt

Uri /api/v2/album/xkc9Dt
UriDescription Album by key
ResponseLevel Public
AlbumKey xkc9Dt
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 0
ImagesLastUpdated 2021-09-03T01:02:17+00:00
Keywords empty string
LastUpdated 2021-09-03T01:02:17+00:00
Name 2021 Indonesia Virtual Business Mission
NiceName 2021-Indonesia-Virtual-Business-Mission-1
NodeID 9gDb7V
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title 2021 Indonesia Virtual Business Mission
UrlName 2021-Indonesia-Virtual-Business-Mission-1
UrlPath /Business-Missions/2021/2021-Indonesia-Virtual-Business-Mission-1
WebUri https://photos.usasean.org/Business-Missions/2021/2021-Indonesia-Virtual-Business-Mission-1

Uris

AlbumComments
/api/v2/album/xkc9Dt!comments

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

AlbumDownload
/api/v2/album/xkc9Dt!download

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

AlbumGeoMedia
/api/v2/album/xkc9Dt!geomedia

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

AlbumHighlightImage
/api/v2/album/xkc9Dt!highlightimage

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

AlbumImages
/api/v2/album/xkc9Dt!images

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

AlbumPopularMedia
/api/v2/album/xkc9Dt!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/xkc9Dt!pricelistexclusions

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

AlbumPrices
/api/v2/album/xkc9Dt!prices

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

AlbumShareUris
/api/v2/album/xkc9Dt!shareuris

Uri /api/v2/album/xkc9Dt!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/2021

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

HighlightImage
/api/v2/highlight/node/9gDb7V

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

Node
/api/v2/node/9gDb7V

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

NodeCoverImage
/api/v2/node/9gDb7V!cover

Uri /api/v2/node/9gDb7V!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/2021!parents

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2021!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] - Customs Mission
/api/v2/album/KqDSsv

Uri /api/v2/album/KqDSsv
UriDescription Album by key
ResponseLevel Public
AlbumKey KqDSsv
AllowDownloads true
CanBuy true
CanFavorite false
CanShare true
Description empty string
EXIF true
External true
Filenames false
Geography true
HasDownloadPassword false
ImageCount 11
ImagesLastUpdated 2021-06-21T05:05:53+00:00
Keywords empty string
LastUpdated 2021-06-21T05:05:49+00:00
Name Customs Mission
NiceName Customs-Mission
NodeID bLGQkF
Packages false
PasswordHint empty string
Protected false
SecurityType None
SortDirection Ascending
SortMethod Date Taken
Title Customs Mission
UrlName Customs-Mission
UrlPath /Business-Missions/2021/Customs-Mission
WebUri https://photos.usasean.org/Business-Missions/2021/Customs-Mission

Uris

AlbumComments
/api/v2/album/KqDSsv!comments

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

AlbumDownload
/api/v2/album/KqDSsv!download

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

AlbumGeoMedia
/api/v2/album/KqDSsv!geomedia

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

AlbumHighlightImage
/api/v2/album/KqDSsv!highlightimage

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

AlbumImages
/api/v2/album/KqDSsv!images

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

AlbumPopularMedia
/api/v2/album/KqDSsv!popularmedia

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

AlbumPricelistExclusions
/api/v2/album/KqDSsv!pricelistexclusions

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

AlbumPrices
/api/v2/album/KqDSsv!prices

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

AlbumShareUris
/api/v2/album/KqDSsv!shareuris

Uri /api/v2/album/KqDSsv!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/2021

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

HighlightImage
/api/v2/highlight/node/bLGQkF

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

Node
/api/v2/node/bLGQkF

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

NodeCoverImage
/api/v2/node/bLGQkF!cover

Uri /api/v2/node/bLGQkF!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/2021!parents

Uri /api/v2/folder/user/US-ASEAN/Business-Missions/2021!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.03794

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/2021!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",
                    "2021"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albums"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2021!albums",
        "Locator": "Album",
        "LocatorType": "Objects",
        "Album": [
            {
                "NiceName": "2021-Indonesia-Virtual-Business-Mission-1",
                "UrlName": "2021-Indonesia-Virtual-Business-Mission-1",
                "Title": "2021 Indonesia Virtual Business Mission",
                "Name": "2021 Indonesia Virtual Business Mission",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "xkc9Dt",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2021-09-03T01:02:17+00:00",
                "ImagesLastUpdated": "2021-09-03T01:02:17+00:00",
                "NodeID": "9gDb7V",
                "ImageCount": 0,
                "UrlPath": "/Business-Missions/2021/2021-Indonesia-Virtual-Business-Mission-1",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/xkc9Dt",
                "WebUri": "https://photos.usasean.org/Business-Missions/2021/2021-Indonesia-Virtual-Business-Mission-1",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/xkc9Dt!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/9gDb7V",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/9gDb7V!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/2021",
                        "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/2021!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/9gDb7V",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/xkc9Dt!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/xkc9Dt!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/xkc9Dt!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/xkc9Dt!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/xkc9Dt!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/xkc9Dt!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/xkc9Dt!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/xkc9Dt!pricelistexclusions",
                        "Locator": "AlbumPricelistExclusions",
                        "LocatorType": "Object",
                        "UriDescription": "Pricelist information for an Album",
                        "EndpointType": "AlbumPricelistExclusions"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "NiceName": "Customs-Mission",
                "UrlName": "Customs-Mission",
                "Title": "Customs Mission",
                "Name": "Customs Mission",
                "AllowDownloads": true,
                "Description": "",
                "EXIF": true,
                "External": true,
                "Filenames": false,
                "Geography": true,
                "Keywords": "",
                "PasswordHint": "",
                "Protected": false,
                "SortDirection": "Ascending",
                "SortMethod": "Date Taken",
                "SecurityType": "None",
                "AlbumKey": "KqDSsv",
                "CanBuy": true,
                "CanFavorite": false,
                "LastUpdated": "2021-06-21T05:05:49+00:00",
                "ImagesLastUpdated": "2021-06-21T05:05:53+00:00",
                "NodeID": "bLGQkF",
                "ImageCount": 11,
                "UrlPath": "/Business-Missions/2021/Customs-Mission",
                "CanShare": true,
                "HasDownloadPassword": false,
                "Packages": false,
                "Uri": "/api/v2/album/KqDSsv",
                "WebUri": "https://photos.usasean.org/Business-Missions/2021/Customs-Mission",
                "UriDescription": "Album by key",
                "Uris": {
                    "AlbumShareUris": {
                        "Uri": "/api/v2/album/KqDSsv!shareuris",
                        "Locator": "AlbumShareUris",
                        "LocatorType": "Object",
                        "UriDescription": "URIs that are useful for sharing",
                        "EndpointType": "AlbumShareUris"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/bLGQkF",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/bLGQkF!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/2021",
                        "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/2021!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/bLGQkF",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "AlbumHighlightImage": {
                        "Uri": "/api/v2/album/KqDSsv!highlightimage",
                        "Locator": "AlbumImage",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for album",
                        "EndpointType": "AlbumHighlightImage"
                    },
                    "AlbumImages": {
                        "Uri": "/api/v2/album/KqDSsv!images",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Images from album",
                        "EndpointType": "AlbumImages"
                    },
                    "AlbumPopularMedia": {
                        "Uri": "/api/v2/album/KqDSsv!popularmedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Popular images from album",
                        "EndpointType": "AlbumPopularMedia"
                    },
                    "AlbumGeoMedia": {
                        "Uri": "/api/v2/album/KqDSsv!geomedia",
                        "Locator": "AlbumImage",
                        "LocatorType": "Objects",
                        "UriDescription": "Geotagged images from album",
                        "EndpointType": "AlbumGeoMedia"
                    },
                    "AlbumComments": {
                        "Uri": "/api/v2/album/KqDSsv!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on album",
                        "EndpointType": "AlbumComments"
                    },
                    "AlbumDownload": {
                        "Uri": "/api/v2/album/KqDSsv!download",
                        "Locator": "Download",
                        "LocatorType": "Objects",
                        "UriDescription": "Download album",
                        "EndpointType": "AlbumDownload"
                    },
                    "AlbumPrices": {
                        "Uri": "/api/v2/album/KqDSsv!prices",
                        "Locator": "CatalogSkuPrice",
                        "LocatorType": "Objects",
                        "UriDescription": "Purchasable Skus",
                        "EndpointType": "AlbumPrices"
                    },
                    "AlbumPricelistExclusions": {
                        "Uri": "/api/v2/album/KqDSsv!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.03794,
                "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