Response [200 Ok]

Uri /api/v2/folder/user/assets/Page-Templates!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List

AlbumList [1 of 6] - Black & White
/api/v2/album/b4cnW7

Uri /api/v2/album/b4cnW7
Name Black & White
UrlPath /Page-Templates/Black-White

AlbumList [2 of 6] - Street
/api/v2/album/mSzB7M

Uri /api/v2/album/mSzB7M
Name Street
UrlPath /Page-Templates/Street

AlbumList [3 of 6] - Macro
/api/v2/album/CQmg9g

Uri /api/v2/album/CQmg9g
Name Macro
UrlPath /Page-Templates/Macro

AlbumList [4 of 6] - Landscapes
/api/v2/album/hrdQGh

Uri /api/v2/album/hrdQGh
Name Landscapes
UrlPath /Page-Templates/Landscapes

AlbumList [5 of 6] - Family
/api/v2/album/qn3Cj5

Uri /api/v2/album/qn3Cj5
Name Family
UrlPath /Page-Templates/Family

AlbumList [6 of 6] - Weddings
/api/v2/album/t7SPxn

Uri /api/v2/album/t7SPxn
Name Weddings
UrlPath /Page-Templates/Weddings

Timing

Total

cycles 1
objects 0
time 0.02616

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !albumlist

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/assets/Page-Templates!albumlist"
    },
    "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": "assets",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Page-Templates"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "albumlist"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/assets/Page-Templates!albumlist",
        "Locator": "AlbumList",
        "LocatorType": "List",
        "AlbumList": [
            {
                "Uri": "/api/v2/album/b4cnW7",
                "UrlPath": "/Page-Templates/Black-White",
                "Name": "Black & White"
            },
            {
                "Uri": "/api/v2/album/mSzB7M",
                "UrlPath": "/Page-Templates/Street",
                "Name": "Street"
            },
            {
                "Uri": "/api/v2/album/CQmg9g",
                "UrlPath": "/Page-Templates/Macro",
                "Name": "Macro"
            },
            {
                "Uri": "/api/v2/album/hrdQGh",
                "UrlPath": "/Page-Templates/Landscapes",
                "Name": "Landscapes"
            },
            {
                "Uri": "/api/v2/album/qn3Cj5",
                "UrlPath": "/Page-Templates/Family",
                "Name": "Family"
            },
            {
                "Uri": "/api/v2/album/t7SPxn",
                "UrlPath": "/Page-Templates/Weddings",
                "Name": "Weddings"
            }
        ],
        "UriDescription": "List of user's albums",
        "EndpointType": "AlbumList",
        "Timing": {
            "Total": {
                "time": 0.02616,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}