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

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission"
    },
    "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",
                    "2022",
                    "US-ABC-2022-Indonesia-Business-Mission"
                ],
                "param_validator": {}
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission",
        "Locator": "Folder",
        "LocatorType": "Object",
        "Folder": {
            "Name": "2022 Indonesia Business Mission (23 - 26 August 2022)",
            "UrlName": "US-ABC-2022-Indonesia-Business-Mission",
            "SecurityType": "Password",
            "PasswordHint": "Please contact US-ABC should you have any issues in accessing the link",
            "UrlPath": "/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission",
            "NodeID": "ttPCfK",
            "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission",
            "WebUri": "https://photos.usasean.org/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission",
            "UriDescription": "A folder or legacy (sub)category by UrlPath",
            "Uris": {
                "FolderByID": {
                    "Uri": "/api/v2/folder/id/ttPCfK",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Get folder by its ID",
                    "EndpointType": "FolderByID"
                },
                "Node": {
                    "Uri": "/api/v2/node/ttPCfK",
                    "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/2022!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/2022/US-ABC-2022-Indonesia-Business-Mission!parent",
                    "Locator": "Folder",
                    "LocatorType": "Object",
                    "UriDescription": "Parent folder",
                    "EndpointType": "ParentFolder"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/ttPCfK",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "UnlockFolder": {
                    "Uri": "/api/v2/folder/user/US-ASEAN/Business-Missions/2022/US-ABC-2022-Indonesia-Business-Mission!unlock",
                    "UriDescription": "Unlock password-protected folder",
                    "EndpointType": "UnlockFolder"
                }
            },
            "ResponseLevel": "Password"
        },
        "UriDescription": "A folder or legacy (sub)category by UrlPath",
        "EndpointType": "Folder",
        "Timing": {
            "Total": {
                "time": 0.02352,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}