Response [200 Ok]

Uri /api/v2/folder/user/naapausa/BBS!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

Folder [1 of 2]
/api/v2/folder/user/naapausa

Uri /api/v2/folder/user/naapausa
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2014-03-16T07:02:40+00:00
DateModified 2014-03-16T07:02:40+00:00
Description empty string
IsEmpty false
Keywords empty string
Name empty string
NodeID nm2z6
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName empty string
UrlPath empty string
WebUri https://www.naapausa.com

Uris

AlbumList
/api/v2/folder/user/naapausa!albumlist

Uri /api/v2/folder/user/naapausa!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List
AlbumList [1 of 1]

FolderAlbums
/api/v2/folder/user/naapausa!albums

Uri /api/v2/folder/user/naapausa!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/nm2z6

Uri /api/v2/folder/id/nm2z6
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object
Folder [1 of 1]

FolderHighlightImage
/api/v2/folder/user/naapausa!highlightimage

Uri /api/v2/folder/user/naapausa!highlightimage
UriDescription Highlight image for folder
EndpointType FolderHighlightImage
Locator Image
LocatorType Object
Image [1 of 1]

FolderList
/api/v2/folder/user/naapausa!folderlist

Uri /api/v2/folder/user/naapausa!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List
FolderList [1 of 1]

FolderPages
/api/v2/folder/user/naapausa!pages

Uri /api/v2/folder/user/naapausa!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/naapausa!search

Uri /api/v2/folder/user/naapausa!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/naapausa!folders

Uri /api/v2/folder/user/naapausa!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/nm2z6

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

Node
/api/v2/node/nm2z6

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

Size
/api/v2/folder/user/naapausa!size

Uri /api/v2/folder/user/naapausa!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object
Size [1 of 1]

User
/api/v2/user/naapausa

Uri /api/v2/user/naapausa
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object
User [1 of 1]

Folder [2 of 2] - BBS-攝影論壇
/api/v2/folder/user/naapausa/BBS

Uri /api/v2/folder/user/naapausa/BBS
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2017-11-04T04:06:45+00:00
DateModified 2017-11-04T04:06:45+00:00
Description BBS-攝影論壇
IsEmpty false
Keywords empty string
Name BBS-攝影論壇
NodeID ddC9wK
PasswordHint empty string
SecurityType None
SortDirection Descending
SortMethod DateModified
UrlName BBS
UrlPath /BBS
WebUri https://www.naapausa.com/BBS

Uris

AlbumList
/api/v2/folder/user/naapausa/BBS!albumlist

Uri /api/v2/folder/user/naapausa/BBS!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List
AlbumList [1 of 1]

FolderAlbums
/api/v2/folder/user/naapausa/BBS!albums

Uri /api/v2/folder/user/naapausa/BBS!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/ddC9wK

Uri /api/v2/folder/id/ddC9wK
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object
Folder [1 of 1]

FolderHighlightImage
/api/v2/folder/user/naapausa/BBS!highlightimage

Uri /api/v2/folder/user/naapausa/BBS!highlightimage
UriDescription Highlight image for folder
EndpointType FolderHighlightImage
Locator Image
LocatorType Object
Image [1 of 1]

FolderList
/api/v2/folder/user/naapausa/BBS!folderlist

Uri /api/v2/folder/user/naapausa/BBS!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List
FolderList [1 of 1]

FolderPages
/api/v2/folder/user/naapausa/BBS!pages

Uri /api/v2/folder/user/naapausa/BBS!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/naapausa/BBS!search

Uri /api/v2/folder/user/naapausa/BBS!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/naapausa/BBS!folders

Uri /api/v2/folder/user/naapausa/BBS!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/ddC9wK

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

Node
/api/v2/node/ddC9wK

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

ParentFolder
/api/v2/folder/user/naapausa/BBS!parent

Uri /api/v2/folder/user/naapausa/BBS!parent
UriDescription Parent folder
EndpointType ParentFolder
Locator Folder
LocatorType Object
Folder [1 of 1]

ParentFolders
/api/v2/folder/user/naapausa!parents

Uri /api/v2/folder/user/naapausa!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

Size
/api/v2/folder/user/naapausa/BBS!size

Uri /api/v2/folder/user/naapausa/BBS!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object
Size [1 of 1]

User
/api/v2/user/naapausa

Uri /api/v2/user/naapausa
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object
User [1 of 1]

Timing

Total

cycles 1
objects 0
time 0.03115

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !parents

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/naapausa/BBS!parents"
    },
    "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)"
        },
        "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": "naapausa",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "BBS"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "parents"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!parents"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/naapausa/BBS!parents",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "",
                "UrlName": "",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2014-03-16T07:02:40+00:00",
                "DateModified": "2014-03-16T07:02:40+00:00",
                "UrlPath": "",
                "NodeID": "nm2z6",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/naapausa",
                "WebUri": "https://www.naapausa.com",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/nm2z6",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/nm2z6",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/naapausa",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/nm2z6",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/naapausa!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/naapausa!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/naapausa!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/naapausa!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/naapausa!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/naapausa!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/naapausa!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/naapausa!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "BBS-\u651d\u5f71\u8ad6\u58c7",
                "UrlName": "BBS",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "BBS-\u651d\u5f71\u8ad6\u58c7",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2017-11-04T04:06:45+00:00",
                "DateModified": "2017-11-04T04:06:45+00:00",
                "UrlPath": "/BBS",
                "NodeID": "ddC9wK",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/naapausa/BBS",
                "WebUri": "https://www.naapausa.com/BBS",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/ddC9wK",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/ddC9wK",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/naapausa",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/naapausa!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/naapausa/BBS!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/ddC9wK",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/naapausa/BBS!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "The sequence of parent folders, from the given folder to the root",
        "EndpointType": "ParentFolders",
        "Timing": {
            "Total": {
                "time": 0.03115,
                "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