Response [200 Ok]

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

Node [1 of 3] - Greeting Cards
/api/v2/node/6xnhGd

Uri /api/v2/node/6xnhGd
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-11-08T23:47:48+00:00
DateModified 2019-11-08T23:54:53+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Greeting Cards
NodeID 6xnhGd
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Greeting-Cards
UrlPath /Greeting-Cards
WebUri https://www.smugmug.com/gallery/n-6xnhGd

Formatted Values

Name [html]

html Greeting Cards

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/TwgBTM

Uri /api/v2/album/TwgBTM
UriDescription Album by key
EndpointType Album
Locator Album
LocatorType Object
Album [1 of 1]

HighlightImage
/api/v2/highlight/node/6xnhGd

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

NodeComments
/api/v2/node/6xnhGd!comments

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

NodeCoverImage
/api/v2/node/6xnhGd!cover

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

NodePricelist
/api/v2/node/6xnhGd!pricelist

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

Node [2 of 3] - Product Catalog
/api/v2/node/6qkCGN

Uri /api/v2/node/6qkCGN
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2015-03-17T05:03:07+00:00
DateModified 2018-09-20T16:57:42+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Product Catalog
NodeID 6qkCGN
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Product-Catalog
UrlPath /Product-Catalog
WebUri https://assets.smugmug.com/Product-Catalog

Formatted Values

Name [html]

html Product Catalog

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/wxL4Tj

Uri /api/v2/album/wxL4Tj
UriDescription Album by key
EndpointType Album
Locator Album
LocatorType Object
Album [1 of 1]

HighlightImage
/api/v2/highlight/node/6qkCGN

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

NodeComments
/api/v2/node/6qkCGN!comments

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

NodeCoverImage
/api/v2/node/6qkCGN!cover

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

NodePricelist
/api/v2/node/6qkCGN!pricelist

Uri /api/v2/node/6qkCGN!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/6qkCGN!parent

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

ParentNodes
/api/v2/node/6qkCGN!parents

Uri /api/v2/node/6qkCGN!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] - Add-Ons Product Shots
/api/v2/node/pjs9NB

Uri /api/v2/node/pjs9NB
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2018-02-22T23:55:20+00:00
DateModified 2018-04-06T18:08:24+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Add-Ons Product Shots
NodeID pjs9NB
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Add-Ons-Product-Shots
UrlPath /Add-Ons-Product-Shots
WebUri https://assets.smugmug.com/Add-Ons-Product-Shots

Formatted Values

Name [html]

html Add-Ons Product Shots

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/bwgLgT

Uri /api/v2/album/bwgLgT
UriDescription Album by key
EndpointType Album
Locator Album
LocatorType Object
Album [1 of 1]

HighlightImage
/api/v2/highlight/node/pjs9NB

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

NodeComments
/api/v2/node/pjs9NB!comments

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

NodeCoverImage
/api/v2/node/pjs9NB!cover

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

NodePricelist
/api/v2/node/pjs9NB!pricelist

Uri /api/v2/node/pjs9NB!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/pjs9NB!parent

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

ParentNodes
/api/v2/node/pjs9NB!parents

Uri /api/v2/node/pjs9NB!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/HSBRm!children?start=1&count=10
LastPage /api/v2/node/HSBRm!children?start=11&count=10
PrevPage /api/v2/node/HSBRm!children?start=1&count=10
RequestedCount 10
Start 11
Total 13

Timing

Total

cycles 1
objects 0
time 0.05512

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/HSBRm!children?start=11&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": "HSBRm",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/HSBRm!children?start=11&count=10",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "Greeting Cards",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Greeting-Cards",
                "DateAdded": "2019-11-08T23:47:48+00:00",
                "DateModified": "2019-11-08T23:54:53+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Greeting Cards"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "6xnhGd",
                "UrlPath": "/Greeting-Cards",
                "Uri": "/api/v2/node/6xnhGd",
                "WebUri": "https://www.smugmug.com/gallery/n-6xnhGd",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/TwgBTM",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/6xnhGd!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/6xnhGd",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/6xnhGd!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/6xnhGd!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Product Catalog",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Product-Catalog",
                "DateAdded": "2015-03-17T05:03:07+00:00",
                "DateModified": "2018-09-20T16:57:42+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Product Catalog"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "6qkCGN",
                "UrlPath": "/Product-Catalog",
                "Uri": "/api/v2/node/6qkCGN",
                "WebUri": "https://assets.smugmug.com/Product-Catalog",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/wxL4Tj",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/6qkCGN!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/6qkCGN!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/6qkCGN!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/6qkCGN",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/6qkCGN!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/6qkCGN!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Add-Ons Product Shots",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Add-Ons-Product-Shots",
                "DateAdded": "2018-02-22T23:55:20+00:00",
                "DateModified": "2018-04-06T18:08:24+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Add-Ons Product Shots"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "pjs9NB",
                "UrlPath": "/Add-Ons-Product-Shots",
                "Uri": "/api/v2/node/pjs9NB",
                "WebUri": "https://assets.smugmug.com/Add-Ons-Product-Shots",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/bwgLgT",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/pjs9NB!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/pjs9NB!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/pjs9NB!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/pjs9NB",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/pjs9NB!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/pjs9NB!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Child nodes of the given node.",
        "EndpointType": "ChildNodes",
        "Pages": {
            "Total": 13,
            "Start": 11,
            "Count": 3,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/HSBRm!children?start=1&count=10",
            "LastPage": "/api/v2/node/HSBRm!children?start=11&count=10",
            "PrevPage": "/api/v2/node/HSBRm!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.05512,
                "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