Response [200 Ok]

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

Timing

Total

cycles 1
objects 0
time 0.17609

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !folderlist

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/destinationarcticcircle!folderlist"
    },
    "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": "destinationarcticcircle",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "folderlist"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/destinationarcticcircle!folderlist",
        "Locator": "FolderList",
        "LocatorType": "List",
        "FolderList": [
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1",
                "UrlPath": "/Kangerlussuaq-1",
                "Name": "Kangerlussuaq",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Maniitsoq",
                "UrlPath": "/Maniitsoq",
                "Name": "Maniitsoq",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Sisimiut",
                "UrlPath": "/Sisimiut",
                "Name": "Sisimiut",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Atammik",
                "UrlPath": "/Atammik",
                "Name": "Atammik",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Itilleq",
                "UrlPath": "/Itilleq",
                "Name": "Itilleq",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangaamiut",
                "UrlPath": "/Kangaamiut",
                "Name": "Kangaamiut",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Napasoq",
                "UrlPath": "/Napasoq",
                "Name": "Napasoq",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Sarfannguit",
                "UrlPath": "/Sarfannguit",
                "Name": "Sarfannguit",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Things-to-do",
                "UrlPath": "/Things-to-do",
                "Name": "Things to do",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Plants",
                "UrlPath": "/Plants",
                "Name": "Plants / flora",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Wildlife",
                "UrlPath": "/Wildlife",
                "Name": "Wildlife",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Logos",
                "UrlPath": "/Logos",
                "Name": "Logos",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Key-Attractions",
                "UrlPath": "/Key-Attractions",
                "Name": "Key Attractions",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Pages",
                "UrlPath": "/Pages",
                "Name": "Pages",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Operators",
                "UrlPath": "/Operators",
                "Name": "Operators",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Events",
                "UrlPath": "/Events",
                "Name": "Events",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Culture",
                "UrlPath": "/Culture",
                "Name": "Culture",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Industry-photos-from-Flickr",
                "UrlPath": "/Industry-photos-from-Flickr",
                "Name": "Industry+",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1/Kangerlussuaq-things-to-do",
                "UrlPath": "/Kangerlussuaq-1/Kangerlussuaq-things-to-do",
                "Name": "Activities",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Kangerlussuaq-1/Attractions",
                "UrlPath": "/Kangerlussuaq-1/Attractions",
                "Name": "Attractions",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Maniitsoq/Activities",
                "UrlPath": "/Maniitsoq/Activities",
                "Name": "Activities",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Maniitsoq/Attractions",
                "UrlPath": "/Maniitsoq/Attractions",
                "Name": "Attractions",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Maniitsoq/Events",
                "UrlPath": "/Maniitsoq/Events",
                "Name": "Events",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Sisimiut/Activities",
                "UrlPath": "/Sisimiut/Activities",
                "Name": "Activities",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Sisimiut/Attractions",
                "UrlPath": "/Sisimiut/Attractions",
                "Name": "Attractions",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Events/Sisimiut-Festival",
                "UrlPath": "/Events/Sisimiut-Festival",
                "Name": "Sisimiut Festival",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Events/Arctic-Circle-Race-folder",
                "UrlPath": "/Events/Arctic-Circle-Race-folder",
                "Name": "Arctic Circle Race",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/destinationarcticcircle/Events/Arctic-Sounds-Music-Festival-1",
                "UrlPath": "/Events/Arctic-Sounds-Music-Festival-1",
                "Name": "Arctic Sounds Music Festival",
                "CanHaveFolder": true
            }
        ],
        "UriDescription": "Recursive list of all of the user's folders",
        "EndpointType": "FolderList",
        "Timing": {
            "Total": {
                "time": 0.17609,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}