{
    "expand_method": "ref",
    "shorturis": false
}

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "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"
        ],
        "Output": [
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 254
            },
            {
                "Name": "UrlName",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 32
            },
            {
                "Name": "SecurityType",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortMethod",
                "Type": "Select",
                "OPTIONS": [
                    "SortIndex",
                    "Name",
                    "DateAdded",
                    "DateModified"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortDirection",
                "Type": "Select",
                "OPTIONS": [
                    "Ascending",
                    "Descending"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "Description",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": 65535
            },
            {
                "Name": "Keywords",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Password",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "PasswordHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Privacy",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SmugSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Local",
                    "LocalUser",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "WorldSearchable",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "HomeOnly",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "HighlightImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Image"
                ]
            },
            {
                "Name": "DateAdded",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "DateModified",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "UrlPath",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "NodeID",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "IsEmpty",
                "Description": "Whether this folder contains any albums, folders, or pages.",
                "Type": "Boolean"
            }
        ],
        "Notes": [
            "FolderHighlightImage is deprecated, use HighlightImage instead"
        ],
        "ResponseLevels": [
            "Full",
            "Public",
            "Password",
            "GrantAccess"
        ],
        "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",
                    "2018",
                    "2018ASECMission"
                ],
                "param_validator": {}
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission",
        "Locator": "Folder",
        "LocatorType": "Object",
        "Folder": {
            "Name": "2018 ASEAN Secretariat Business Mission",
            "UrlName": "2018ASECMission",
            "SecurityType": "None",
            "SortMethod": "DateModified",
            "SortDirection": "Descending",
            "Description": "The US-ASEAN Business Council held its annual Association of Southeast Asian Nations (ASEAN) Secretariat Business Mission today, with 12 leading U.S. companies engaging top officials from the ASEAN Secretariat in Jakarta to build relationships with the newly-installed leadership and further develop longstanding commercial ties with the region. The delegation was received by the recently-appointed ASEAN Secretary-General H.E. Lim Jock Hoi and his team from economic, socio-cultural, and political-security departments. The Mission was co-led by Alexander Feldman, President & CEO of the US-ASEAN Business Council; Ambassador Michael W. Michalak, Senior Vice President & Regional Managing Director of the US-ASEAN Business Council; and Chair of the Council\u2019s ASEAN Committee, Archawat Chareonsilp, ASEAN Public Affairs and Communications Director of the Coca-Cola Company.",
            "Keywords": "ASEAN; US ASEAN; USABC; Business Mission; Jakarta; South East Asia",
            "PasswordHint": "",
            "DateAdded": "2018-03-21T11:38:00+00:00",
            "DateModified": "2018-03-21T12:18:19+00:00",
            "UrlPath": "/Business-Missions/2018/2018ASECMission",
            "NodeID": "jPb8wb",
            "IsEmpty": false,
            "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission",
            "WebUri": "https://photos.usasean.org/Business-Missions/2018/2018ASECMission",
            "UriDescription": "A folder or legacy (sub)category by UrlPath",
            "Uris": {
                "FolderByID": {
                    "Uri": "/api/v2/folder/id/jPb8wb",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Get folder by its ID",
                    "EndpointType": "FolderByID"
                },
                "Node": {
                    "Uri": "/api/v2/node/jPb8wb",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Node with the given id.",
                    "EndpointType": "Node"
                },
                "User": {
                    "Uri": "/api/v2/user/US-ASEAN",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "ParentFolders": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018!parents",
                    "Locator": "Folder",
                    "LocatorType": "Objects",
                    "UriDescription": "The sequence of parent folders, from the given folder to the root",
                    "EndpointType": "ParentFolders"
                },
                "ParentFolder": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!parent",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Parent folder",
                    "EndpointType": "ParentFolder"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/jPb8wb",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "FolderHighlightImage": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!highlightimage",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for folder",
                    "EndpointType": "FolderHighlightImage"
                },
                "Folders": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!folders",
                    "Locator": "Folder",
                    "LocatorType": "Objects",
                    "UriDescription": "Folders inside of the folder",
                    "EndpointType": "Folders"
                },
                "FolderList": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!folderlist",
                    "Locator": "FolderList",
                    "LocatorType": "List",
                    "UriDescription": "Recursive list of all of the user's folders",
                    "EndpointType": "FolderList"
                },
                "FolderAlbums": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!albums",
                    "Locator": "Album",
                    "LocatorType": "Objects",
                    "UriDescription": "Albums inside of the folder",
                    "EndpointType": "FolderAlbums"
                },
                "AlbumList": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!albumlist",
                    "Locator": "AlbumList",
                    "LocatorType": "List",
                    "UriDescription": "List of user's albums",
                    "EndpointType": "AlbumList"
                },
                "FolderSearch": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!search",
                    "Locator": "FolderByID",
                    "LocatorType": "Objects",
                    "UriDescription": "Search for folders",
                    "EndpointType": "FolderSearch"
                },
                "FolderPages": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!pages",
                    "Locator": "Page",
                    "LocatorType": "Objects",
                    "UriDescription": "Pages inside of the folder",
                    "EndpointType": "FolderPages"
                },
                "Size": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2018/2018ASECMission!size",
                    "Locator": "Size",
                    "LocatorType": "Object",
                    "UriDescription": "Size of folder",
                    "EndpointType": "Size"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "A folder or legacy (sub)category by UrlPath",
        "EndpointType": "Folder",
        "Timing": {
            "Total": {
                "time": 0.03209,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}