Response [200 Ok]

Uri /api/v2/folder/user/piratepics!search?start=1&count=10
UriDescription Search for folders
EndpointType FolderSearch
Locator Folder
LocatorType Objects

Folder [1 of 5] - 2008-09
/api/v2/folder/user/piratepics/2008-09

Uri /api/v2/folder/user/piratepics/2008-09
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2015-08-01T13:49:15+00:00
DateModified 2009-07-07T18:33:52+00:00
Description empty string
IsEmpty false
Keywords empty string
Name 2008-09
NodeID hmXNsN
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName 2008-09
UrlPath /2008-09
WebUri https://album.seafairpirates.org/2008-09

Uris

AlbumList
/api/v2/folder/user/piratepics/2008-09!albumlist

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

FolderAlbums
/api/v2/folder/user/piratepics/2008-09!albums

Uri /api/v2/folder/user/piratepics/2008-09!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/hmXNsN

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

FolderHighlightImage
/api/v2/folder/user/piratepics/2008-09!highlightimage

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

FolderList
/api/v2/folder/user/piratepics/2008-09!folderlist

Uri /api/v2/folder/user/piratepics/2008-09!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/piratepics/2008-09!pages

Uri /api/v2/folder/user/piratepics/2008-09!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/piratepics/2008-09!search

Uri /api/v2/folder/user/piratepics/2008-09!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/piratepics/2008-09!folders

Uri /api/v2/folder/user/piratepics/2008-09!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/hmXNsN

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

Node
/api/v2/node/hmXNsN

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

ParentFolder
/api/v2/folder/user/piratepics/2008-09!parent

Uri /api/v2/folder/user/piratepics/2008-09!parent
UriDescription Parent folder
EndpointType ParentFolder
Locator Folder
LocatorType Object
Folder [1 of 1]

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

Uri /api/v2/folder/user/piratepics!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/piratepics/2008-09!size

Uri /api/v2/folder/user/piratepics/2008-09!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object
Size [1 of 1]

User
/api/v2/user/piratepics

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

Folder [2 of 5] - Other
/api/v2/folder/user/piratepics/Other

Uri /api/v2/folder/user/piratepics/Other
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2015-08-01T13:49:15+00:00
DateModified 2009-06-20T23:22:23+00:00
Description empty string
IsEmpty false
Keywords empty string
Name Other
NodeID JQLbC4
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName Other
UrlPath /Other
WebUri https://album.seafairpirates.org/Other

Uris

AlbumList
/api/v2/folder/user/piratepics/Other!albumlist

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

FolderAlbums
/api/v2/folder/user/piratepics/Other!albums

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

FolderByID
/api/v2/folder/id/JQLbC4

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

FolderHighlightImage
/api/v2/folder/user/piratepics/Other!highlightimage

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

FolderList
/api/v2/folder/user/piratepics/Other!folderlist

Uri /api/v2/folder/user/piratepics/Other!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/piratepics/Other!pages

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

FolderSearch
/api/v2/folder/user/piratepics/Other!search

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

Folders
/api/v2/folder/user/piratepics/Other!folders

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

HighlightImage
/api/v2/highlight/node/JQLbC4

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

Node
/api/v2/node/JQLbC4

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

ParentFolder
/api/v2/folder/user/piratepics/Other!parent

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

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

Uri /api/v2/folder/user/piratepics!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/piratepics/Other!size

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

User
/api/v2/user/piratepics

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

Folder [3 of 5] - 2007-08
/api/v2/folder/user/piratepics/2007-08

Uri /api/v2/folder/user/piratepics/2007-08
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2015-08-01T13:49:15+00:00
DateModified 2008-12-02T08:50:47+00:00
Description empty string
IsEmpty false
Keywords empty string
Name 2007-08
NodeID hk36tW
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName 2007-08
UrlPath /2007-08
WebUri https://album.seafairpirates.org/2007-08

Uris

AlbumList
/api/v2/folder/user/piratepics/2007-08!albumlist

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

FolderAlbums
/api/v2/folder/user/piratepics/2007-08!albums

Uri /api/v2/folder/user/piratepics/2007-08!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/hk36tW

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

FolderHighlightImage
/api/v2/folder/user/piratepics/2007-08!highlightimage

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

FolderList
/api/v2/folder/user/piratepics/2007-08!folderlist

Uri /api/v2/folder/user/piratepics/2007-08!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/piratepics/2007-08!pages

Uri /api/v2/folder/user/piratepics/2007-08!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/piratepics/2007-08!search

Uri /api/v2/folder/user/piratepics/2007-08!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/piratepics/2007-08!folders

Uri /api/v2/folder/user/piratepics/2007-08!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/hk36tW

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

Node
/api/v2/node/hk36tW

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

ParentFolder
/api/v2/folder/user/piratepics/2007-08!parent

Uri /api/v2/folder/user/piratepics/2007-08!parent
UriDescription Parent folder
EndpointType ParentFolder
Locator Folder
LocatorType Object
Folder [1 of 1]

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

Uri /api/v2/folder/user/piratepics!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/piratepics/2007-08!size

Uri /api/v2/folder/user/piratepics/2007-08!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object
Size [1 of 1]

User
/api/v2/user/piratepics

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

Folder [4 of 5] - 2009-10
/api/v2/folder/user/piratepics/2009-10

Uri /api/v2/folder/user/piratepics/2009-10
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2015-08-01T13:49:15+00:00
DateModified 2009-07-07T08:01:36+00:00
Description empty string
IsEmpty false
Keywords empty string
Name 2009-10
NodeID zSNKPq
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName 2009-10
UrlPath /2009-10
WebUri https://album.seafairpirates.org/2009-10

Uris

AlbumList
/api/v2/folder/user/piratepics/2009-10!albumlist

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

FolderAlbums
/api/v2/folder/user/piratepics/2009-10!albums

Uri /api/v2/folder/user/piratepics/2009-10!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/zSNKPq

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

FolderHighlightImage
/api/v2/folder/user/piratepics/2009-10!highlightimage

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

FolderList
/api/v2/folder/user/piratepics/2009-10!folderlist

Uri /api/v2/folder/user/piratepics/2009-10!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/piratepics/2009-10!pages

Uri /api/v2/folder/user/piratepics/2009-10!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/piratepics/2009-10!search

Uri /api/v2/folder/user/piratepics/2009-10!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/piratepics/2009-10!folders

Uri /api/v2/folder/user/piratepics/2009-10!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/zSNKPq

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

Node
/api/v2/node/zSNKPq

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

ParentFolder
/api/v2/folder/user/piratepics/2009-10!parent

Uri /api/v2/folder/user/piratepics/2009-10!parent
UriDescription Parent folder
EndpointType ParentFolder
Locator Folder
LocatorType Object
Folder [1 of 1]

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

Uri /api/v2/folder/user/piratepics!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/piratepics/2009-10!size

Uri /api/v2/folder/user/piratepics/2009-10!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object
Size [1 of 1]

User
/api/v2/user/piratepics

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

Folder [5 of 5] - Videos
/api/v2/folder/user/piratepics/Videos

Uri /api/v2/folder/user/piratepics/Videos
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2015-08-01T13:49:15+00:00
DateModified 2009-04-09T13:49:38+00:00
Description empty string
IsEmpty false
Keywords empty string
Name Videos
NodeID 6sjzJx
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName Videos
UrlPath /Videos
WebUri https://album.seafairpirates.org/Videos

Uris

AlbumList
/api/v2/folder/user/piratepics/Videos!albumlist

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

FolderAlbums
/api/v2/folder/user/piratepics/Videos!albums

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

FolderByID
/api/v2/folder/id/6sjzJx

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

FolderHighlightImage
/api/v2/folder/user/piratepics/Videos!highlightimage

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

FolderList
/api/v2/folder/user/piratepics/Videos!folderlist

Uri /api/v2/folder/user/piratepics/Videos!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/piratepics/Videos!pages

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

FolderSearch
/api/v2/folder/user/piratepics/Videos!search

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

Folders
/api/v2/folder/user/piratepics/Videos!folders

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

HighlightImage
/api/v2/highlight/node/6sjzJx

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

Node
/api/v2/node/6sjzJx

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

ParentFolder
/api/v2/folder/user/piratepics/Videos!parent

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

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

Uri /api/v2/folder/user/piratepics!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/piratepics/Videos!size

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

User
/api/v2/user/piratepics

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

Pages

Count 5
FirstPage /api/v2/folder/user/piratepics!search?start=1&count=10
LastPage /api/v2/folder/user/piratepics!search?start=1&count=10
RequestedCount 10
Start 1
Total 5

Timing

Total

cycles 1
objects 0
time 0.1005

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !search

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Search all text fields

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/piratepics!search?start=1&count=10"
    },
    "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": "piratepics",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "search"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node!search"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/piratepics!search?start=1&count=10",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "2008-09",
                "UrlName": "2008-09",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2015-08-01T13:49:15+00:00",
                "DateModified": "2009-07-07T18:33:52+00:00",
                "UrlPath": "/2008-09",
                "NodeID": "hmXNsN",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/piratepics/2008-09",
                "WebUri": "https://album.seafairpirates.org/2008-09",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/hmXNsN",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/hmXNsN",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/piratepics!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/piratepics/2008-09!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/hmXNsN",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/piratepics/2008-09!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Other",
                "UrlName": "Other",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2015-08-01T13:49:15+00:00",
                "DateModified": "2009-06-20T23:22:23+00:00",
                "UrlPath": "/Other",
                "NodeID": "JQLbC4",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/piratepics/Other",
                "WebUri": "https://album.seafairpirates.org/Other",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/JQLbC4",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/JQLbC4",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/piratepics!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/piratepics/Other!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/JQLbC4",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/piratepics/Other!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "2007-08",
                "UrlName": "2007-08",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2015-08-01T13:49:15+00:00",
                "DateModified": "2008-12-02T08:50:47+00:00",
                "UrlPath": "/2007-08",
                "NodeID": "hk36tW",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/piratepics/2007-08",
                "WebUri": "https://album.seafairpirates.org/2007-08",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/hk36tW",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/hk36tW",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/piratepics!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/piratepics/2007-08!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/hk36tW",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/piratepics/2007-08!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "2009-10",
                "UrlName": "2009-10",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2015-08-01T13:49:15+00:00",
                "DateModified": "2009-07-07T08:01:36+00:00",
                "UrlPath": "/2009-10",
                "NodeID": "zSNKPq",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/piratepics/2009-10",
                "WebUri": "https://album.seafairpirates.org/2009-10",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/zSNKPq",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/zSNKPq",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/piratepics!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/piratepics/2009-10!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/zSNKPq",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/piratepics/2009-10!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Videos",
                "UrlName": "Videos",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2015-08-01T13:49:15+00:00",
                "DateModified": "2009-04-09T13:49:38+00:00",
                "UrlPath": "/Videos",
                "NodeID": "6sjzJx",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/piratepics/Videos",
                "WebUri": "https://album.seafairpirates.org/Videos",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/6sjzJx",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/6sjzJx",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/piratepics!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/piratepics/Videos!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/6sjzJx",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/piratepics/Videos!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Search for folders",
        "EndpointType": "FolderSearch",
        "Pages": {
            "Total": 5,
            "Start": 1,
            "Count": 5,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/folder/user/piratepics!search?start=1&count=10",
            "LastPage": "/api/v2/folder/user/piratepics!search?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.1005,
                "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