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

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!search"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Text",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Search all text fields",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SortMethod",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "_score",
                    "Type": "Select",
                    "OPTIONS": [
                        "Rank",
                        "LastUpdated"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortDirection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Descending",
                    "Type": "Select",
                    "OPTIONS": [
                        "Ascending",
                        "Descending"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "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": "assets",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Product-Shot-Catalog",
                    "WHCC"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "search"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node!search"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!search",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "Albums",
                "UrlName": "Albums",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2020-10-20T22:37:38+00:00",
                "DateModified": "2020-10-23T16:10:11+00:00",
                "UrlPath": "/Product-Shot-Catalog/WHCC/Albums",
                "NodeID": "d79kxF",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/WHCC/Albums",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/d79kxF",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/d79kxF",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!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/assets/Product-Shot-Catalog/WHCC/Albums!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/d79kxF",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Albums!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Wall Art",
                "UrlName": "Wall-Art",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2019-05-21T17:42:02+00:00",
                "DateModified": "2021-05-20T16:52:52+00:00",
                "UrlPath": "/Product-Shot-Catalog/WHCC/Wall-Art",
                "NodeID": "HtXqqg",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/WHCC/Wall-Art",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/HtXqqg",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/HtXqqg",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!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/assets/Product-Shot-Catalog/WHCC/Wall-Art!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/HtXqqg",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Wall-Art!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Greeting Cards",
                "UrlName": "Cards",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2019-11-26T15:03:40+00:00",
                "DateModified": "2019-11-26T15:03:40+00:00",
                "UrlPath": "/Product-Shot-Catalog/WHCC/Cards",
                "NodeID": "V5kHST",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/WHCC/Cards",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/V5kHST",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/V5kHST",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!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/assets/Product-Shot-Catalog/WHCC/Cards!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/V5kHST",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Cards!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Desk Art",
                "UrlName": "Desk-Art",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2019-05-21T16:23:54+00:00",
                "DateModified": "2021-05-20T16:54:08+00:00",
                "UrlPath": "/Product-Shot-Catalog/WHCC/Desk-Art",
                "NodeID": "sTFHJ3",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/WHCC/Desk-Art",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/sTFHJ3",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/sTFHJ3",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!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/assets/Product-Shot-Catalog/WHCC/Desk-Art!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/sTFHJ3",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC/Desk-Art!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Search for folders",
        "EndpointType": "FolderSearch",
        "Pages": {
            "Total": 4,
            "Start": 1,
            "Count": 4,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!search?start=1&count=10",
            "LastPage": "/api/v2/folder/user/assets/Product-Shot-Catalog/WHCC!search?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.11916,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}