Response [200 Ok]

Uri /api/v2/folder/user/US-ASEAN/Events/2013!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

Folder [1 of 1] - US-ABC Board of Directors Meeting, Hanoi
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2013-12-09T17:15:08+00:00
DateModified 2013-11-04T08:36:27+00:00
Description empty string
IsEmpty false
Keywords empty string
Name US-ABC Board of Directors Meeting, Hanoi
NodeID HnkWh
PasswordHint empty string
SecurityType None
SortDirection Descending
SortMethod DateModified
UrlName US-ABC-BOD-Hanoi
UrlPath /Events/2013/US-ABC-BOD-Hanoi
WebUri https://photos.usasean.org/Events/2013/US-ABC-BOD-Hanoi

Uris

FolderAlbums
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!albums

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/HnkWh

Uri /api/v2/folder/id/HnkWh
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object

FolderList
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!folderlist

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List

FolderPages
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!pages

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!search

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!folders

Uri /api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/HnkWh

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

Node
/api/v2/node/HnkWh

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

ParentFolders
/api/v2/folder/user/US-ASEAN/Events/2013!parents

Uri /api/v2/folder/user/US-ASEAN/Events/2013!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.02226

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !folders

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/Events/2013!folders"
    },
    "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": [
                    "Events",
                    "2013"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "folders"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013!folders",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "US-ABC Board of Directors Meeting, Hanoi",
                "UrlName": "US-ABC-BOD-Hanoi",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2013-12-09T17:15:08+00:00",
                "DateModified": "2013-11-04T08:36:27+00:00",
                "UrlPath": "/Events/2013/US-ABC-BOD-Hanoi",
                "NodeID": "HnkWh",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi",
                "WebUri": "https://photos.usasean.org/Events/2013/US-ABC-BOD-Hanoi",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/HnkWh",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/HnkWh",
                        "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/Events/2013!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/Events/2013/US-ABC-BOD-Hanoi!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/HnkWh",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!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/Events/2013/US-ABC-BOD-Hanoi!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Folders inside of the folder",
        "EndpointType": "Folders",
        "Timing": {
            "Total": {
                "time": 0.02226,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}