Response [200 Ok]

Uri /api/v2/folder/user/US-ASEAN/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.03374

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !size

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

How deep down the tree do you want to count?

Output Fields

AlbumCount integer
DynamicMediaCount integer
DynamicMediaSize integer
FolderCount integer
MediaCount integer
MediaSize integer
PageCount integer

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry!size"
    },
    "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": "FolderID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Type": "Varchar",
                    "MIN_CHARS": 5,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "depth",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "MAX",
                    "Description": "How deep down the tree do you want to count?",
                    "Type": "Select",
                    "OPTIONS": [
                        "1",
                        "MAX"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "FolderCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "AlbumCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "PageCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "MediaCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "MediaSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "DynamicMediaCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "DynamicMediaSize",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            }
        ],
        "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",
                    "2021",
                    "20210716-Workshop-on-Salmonella-Control-in-Poultry"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "size"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry!size",
        "Locator": "Size",
        "LocatorType": "Object",
        "Size": {
            "FolderCount": 0,
            "AlbumCount": 1,
            "PageCount": 0,
            "MediaCount": 38,
            "DynamicMediaCount": 38,
            "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry!size",
            "UriDescription": "Size of folder"
        },
        "UriDescription": "Size of folder",
        "EndpointType": "Size",
        "Timing": {
            "Total": {
                "time": 0.03374,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}