Response [200 Ok]

Uri /api/v2/node/HGS2f7!children?start=1&count=10
UriDescription Child nodes of the given node.
EndpointType ChildNodes
Locator Node
LocatorType Objects

Node [1 of 3] - Keepsakes
/api/v2/node/Bwz5Mj

Uri /api/v2/node/Bwz5Mj
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-05-21T16:22:53+00:00
DateModified 2021-04-30T16:17:35+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot false
Keywords
Array [0]
Name Keepsakes
NodeID Bwz5Mj
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName Keepsakes
UrlPath /Product-Shot-Catalog/Loxley/Keepsakes
WebUri https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Keepsakes

Formatted Values

Name [html]

html Keepsakes

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/Bwz5Mj!children

Uri /api/v2/node/Bwz5Mj!children
UriDescription Child nodes of the given node.
EndpointType ChildNodes
Locator Node
LocatorType Objects

FolderByID
/api/v2/folder/id/Bwz5Mj

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

HighlightImage
/api/v2/highlight/node/Bwz5Mj

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

NodeComments
/api/v2/node/Bwz5Mj!comments

Uri /api/v2/node/Bwz5Mj!comments
UriDescription Comments on a Node
EndpointType NodeComments
Locator Comment
LocatorType Objects

NodeCoverImage
/api/v2/node/Bwz5Mj!cover

Uri /api/v2/node/Bwz5Mj!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

NodePricelist
/api/v2/node/Bwz5Mj!pricelist

Uri /api/v2/node/Bwz5Mj!pricelist
UriDescription Get, update, or remove the pricelist mapped to this node.
EndpointType NodePricelist
Locator NodePricelist
LocatorType Object
NodePricelist [1 of 1]

ParentNode
/api/v2/node/Bwz5Mj!parent

Uri /api/v2/node/Bwz5Mj!parent
UriDescription Parent node of the given node.
EndpointType ParentNode
Locator Node
LocatorType Object
Node [1 of 1]

ParentNodes
/api/v2/node/Bwz5Mj!parents

Uri /api/v2/node/Bwz5Mj!parents
UriDescription Hierarchy of nodes from the given node (inclusive) to the root node.
EndpointType ParentNodes
Locator Node
LocatorType Objects

User
/api/v2/user/assets

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

Node [2 of 3] - Wall Art
/api/v2/node/FKcW8g

Uri /api/v2/node/FKcW8g
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-05-21T16:23:12+00:00
DateModified 2021-04-29T23:31:03+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot false
Keywords
Array [0]
Name Wall Art
NodeID FKcW8g
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName Wall-Art
UrlPath /Product-Shot-Catalog/Loxley/Wall-Art
WebUri https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Wall-Art

Formatted Values

Name [html]

html Wall Art

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/FKcW8g!children

Uri /api/v2/node/FKcW8g!children
UriDescription Child nodes of the given node.
EndpointType ChildNodes
Locator Node
LocatorType Objects

FolderByID
/api/v2/folder/id/FKcW8g

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

HighlightImage
/api/v2/highlight/node/FKcW8g

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

NodeComments
/api/v2/node/FKcW8g!comments

Uri /api/v2/node/FKcW8g!comments
UriDescription Comments on a Node
EndpointType NodeComments
Locator Comment
LocatorType Objects

NodeCoverImage
/api/v2/node/FKcW8g!cover

Uri /api/v2/node/FKcW8g!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

NodePricelist
/api/v2/node/FKcW8g!pricelist

Uri /api/v2/node/FKcW8g!pricelist
UriDescription Get, update, or remove the pricelist mapped to this node.
EndpointType NodePricelist
Locator NodePricelist
LocatorType Object
NodePricelist [1 of 1]

ParentNode
/api/v2/node/FKcW8g!parent

Uri /api/v2/node/FKcW8g!parent
UriDescription Parent node of the given node.
EndpointType ParentNode
Locator Node
LocatorType Object
Node [1 of 1]

ParentNodes
/api/v2/node/FKcW8g!parents

Uri /api/v2/node/FKcW8g!parents
UriDescription Hierarchy of nodes from the given node (inclusive) to the root node.
EndpointType ParentNodes
Locator Node
LocatorType Objects

User
/api/v2/user/assets

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

Node [3 of 3] - Desk Art
/api/v2/node/nCqXR7

Uri /api/v2/node/nCqXR7
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-05-21T16:22:38+00:00
DateModified 2019-05-21T16:22:38+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot false
Keywords
Array [0]
Name Desk Art
NodeID nCqXR7
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName Desk-Art
UrlPath /Product-Shot-Catalog/Loxley/Desk-Art
WebUri https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Desk-Art

Formatted Values

Name [html]

html Desk Art

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/nCqXR7!children

Uri /api/v2/node/nCqXR7!children
UriDescription Child nodes of the given node.
EndpointType ChildNodes
Locator Node
LocatorType Objects

FolderByID
/api/v2/folder/id/nCqXR7

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

HighlightImage
/api/v2/highlight/node/nCqXR7

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

NodeComments
/api/v2/node/nCqXR7!comments

Uri /api/v2/node/nCqXR7!comments
UriDescription Comments on a Node
EndpointType NodeComments
Locator Comment
LocatorType Objects

NodeCoverImage
/api/v2/node/nCqXR7!cover

Uri /api/v2/node/nCqXR7!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object
Image [1 of 1]

NodePricelist
/api/v2/node/nCqXR7!pricelist

Uri /api/v2/node/nCqXR7!pricelist
UriDescription Get, update, or remove the pricelist mapped to this node.
EndpointType NodePricelist
Locator NodePricelist
LocatorType Object
NodePricelist [1 of 1]

ParentNode
/api/v2/node/nCqXR7!parent

Uri /api/v2/node/nCqXR7!parent
UriDescription Parent node of the given node.
EndpointType ParentNode
Locator Node
LocatorType Object
Node [1 of 1]

ParentNodes
/api/v2/node/nCqXR7!parents

Uri /api/v2/node/nCqXR7!parents
UriDescription Hierarchy of nodes from the given node (inclusive) to the root node.
EndpointType ParentNodes
Locator Node
LocatorType Objects

User
/api/v2/user/assets

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

Pages

Count 3
FirstPage /api/v2/node/HGS2f7!children?start=1&count=10
LastPage /api/v2/node/HGS2f7!children?start=1&count=10
RequestedCount 10
Start 1
Total 3

Timing

Total

cycles 1
objects 0
time 0.05025

Config

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

Options

Path

  • /api
  • /v2
  • /node
  • /
  • !children

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Modify

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/node/HGS2f7!children?start=1&count=10"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Type",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "All",
                    "Type": "Select",
                    "OPTIONS": [
                        "All",
                        "Folder Album Page",
                        "Folder",
                        "Album",
                        "Page",
                        "System Album"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortMethod",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Organizer",
                    "Type": "Select",
                    "OPTIONS": [
                        "DateAdded",
                        "DateModified",
                        "Name",
                        "Organizer"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortDirection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Ascending",
                    "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": "node"
            },
            {
                "type": "singleparam",
                "param_name": "nodeid",
                "param_value": "HGS2f7",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/HGS2f7!children?start=1&count=10",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "Keepsakes",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "Keepsakes",
                "DateAdded": "2019-05-21T16:22:53+00:00",
                "DateModified": "2021-04-30T16:17:35+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Keepsakes"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": false,
                "NodeID": "Bwz5Mj",
                "UrlPath": "/Product-Shot-Catalog/Loxley/Keepsakes",
                "Uri": "/api/v2/node/Bwz5Mj",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Keepsakes",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/Bwz5Mj",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/Bwz5Mj!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/Bwz5Mj!parents",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Hierarchy of nodes from the given node (inclusive) to the root node.",
                        "EndpointType": "ParentNodes"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/Bwz5Mj!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/Bwz5Mj",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/Bwz5Mj!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/Bwz5Mj!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/Bwz5Mj!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Wall Art",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "Wall-Art",
                "DateAdded": "2019-05-21T16:23:12+00:00",
                "DateModified": "2021-04-29T23:31:03+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Wall Art"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": false,
                "NodeID": "FKcW8g",
                "UrlPath": "/Product-Shot-Catalog/Loxley/Wall-Art",
                "Uri": "/api/v2/node/FKcW8g",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Wall-Art",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/FKcW8g",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/FKcW8g!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/FKcW8g!parents",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Hierarchy of nodes from the given node (inclusive) to the root node.",
                        "EndpointType": "ParentNodes"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/FKcW8g!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/FKcW8g",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/FKcW8g!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/FKcW8g!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/FKcW8g!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Desk Art",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "Desk-Art",
                "DateAdded": "2019-05-21T16:22:38+00:00",
                "DateModified": "2019-05-21T16:22:38+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Desk Art"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": false,
                "NodeID": "nCqXR7",
                "UrlPath": "/Product-Shot-Catalog/Loxley/Desk-Art",
                "Uri": "/api/v2/node/nCqXR7",
                "WebUri": "https://assets.smugmug.com/Product-Shot-Catalog/Loxley/Desk-Art",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/nCqXR7",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/nCqXR7!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/nCqXR7!parents",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Hierarchy of nodes from the given node (inclusive) to the root node.",
                        "EndpointType": "ParentNodes"
                    },
                    "User": {
                        "Uri": "/api/v2/user/assets",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/nCqXR7!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/nCqXR7",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/nCqXR7!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/nCqXR7!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/nCqXR7!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Child nodes of the given node.",
        "EndpointType": "ChildNodes",
        "Pages": {
            "Total": 3,
            "Start": 1,
            "Count": 3,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/HGS2f7!children?start=1&count=10",
            "LastPage": "/api/v2/node/HGS2f7!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.05025,
                "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