Response [200 Ok]

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

Node [1 of 3] - Sample Photos
/api/v2/node/c2kQcT

Uri /api/v2/node/c2kQcT
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2020-03-31T18:38:47+00:00
DateModified 2020-04-21T05:57:17+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Sample Photos
NodeID c2kQcT
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Sample-Photos
UrlPath /Sample-Photos-for-Trials/Sample-Photos
WebUri https://assets.smugmug.com/Sample-Photos-for-Trials/Sample-Photos

Formatted Values

Name [html]

html Sample Photos

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/nmJsSd

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

HighlightImage
/api/v2/highlight/node/c2kQcT

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

NodeComments
/api/v2/node/c2kQcT!comments

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

NodeCoverImage
/api/v2/node/c2kQcT!cover

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

NodePricelist
/api/v2/node/c2kQcT!pricelist

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

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

ParentNodes
/api/v2/node/c2kQcT!parents

Uri /api/v2/node/c2kQcT!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] - Sample Photos for Trials
/api/v2/node/8pmhKJ

Uri /api/v2/node/8pmhKJ
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2020-03-31T18:37:42+00:00
DateModified 2020-04-21T05:57:17+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot false
Keywords
Array [0]
Name Sample Photos for Trials
NodeID 8pmhKJ
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName Sample-Photos-for-Trials
UrlPath /Sample-Photos-for-Trials
WebUri https://assets.smugmug.com/Sample-Photos-for-Trials

Formatted Values

Name [html]

html Sample Photos for Trials

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/8pmhKJ!children

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

FolderByID
/api/v2/folder/id/8pmhKJ

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

HighlightImage
/api/v2/highlight/node/8pmhKJ

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

NodeComments
/api/v2/node/8pmhKJ!comments

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

NodeCoverImage
/api/v2/node/8pmhKJ!cover

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

NodePricelist
/api/v2/node/8pmhKJ!pricelist

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

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

ParentNodes
/api/v2/node/8pmhKJ!parents

Uri /api/v2/node/8pmhKJ!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]
/api/v2/node/HSBRm

Uri /api/v2/node/HSBRm
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2014-02-25T10:51:25+00:00
DateModified 2014-02-25T10:51:25+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot true
Keywords
Array [0]
Name empty string
NodeID HSBRm
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName empty string
UrlPath /
WebUri https://assets.smugmug.com

Formatted Values

Name [html]

html empty string

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/HSBRm!children

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

FolderByID
/api/v2/folder/id/HSBRm

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

HighlightImage
/api/v2/highlight/node/HSBRm

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

NodeComments
/api/v2/node/HSBRm!comments

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

NodeCoverImage
/api/v2/node/HSBRm!cover

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

NodePricelist
/api/v2/node/HSBRm!pricelist

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

ParentNodes
/api/v2/node/HSBRm!parents

Uri /api/v2/node/HSBRm!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/c2kQcT!parents?start=1&count=7
LastPage /api/v2/node/c2kQcT!parents?start=1&count=7
RequestedCount 7
Start 1
Total 3

Timing

Total

cycles 1
objects 0
time 0.05655

Request

Uri /api/v2/node/c2kQcT!parents
Method GET
Version v2

Config

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

Options

Path

  • /api
  • /v2
  • /node
  • /
  • !parents

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/node/c2kQcT!parents"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "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": "c2kQcT",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "parents"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/c2kQcT!parents",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "Sample Photos",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Sample-Photos",
                "DateAdded": "2020-03-31T18:38:47+00:00",
                "DateModified": "2020-04-21T05:57:17+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Sample Photos"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "c2kQcT",
                "UrlPath": "/Sample-Photos-for-Trials/Sample-Photos",
                "Uri": "/api/v2/node/c2kQcT",
                "WebUri": "https://assets.smugmug.com/Sample-Photos-for-Trials/Sample-Photos",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/nmJsSd",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/c2kQcT!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/c2kQcT!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/c2kQcT!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/c2kQcT",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/c2kQcT!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/c2kQcT!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Sample Photos for Trials",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "Sample-Photos-for-Trials",
                "DateAdded": "2020-03-31T18:37:42+00:00",
                "DateModified": "2020-04-21T05:57:17+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Sample Photos for Trials"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": false,
                "NodeID": "8pmhKJ",
                "UrlPath": "/Sample-Photos-for-Trials",
                "Uri": "/api/v2/node/8pmhKJ",
                "WebUri": "https://assets.smugmug.com/Sample-Photos-for-Trials",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/8pmhKJ",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/8pmhKJ!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/8pmhKJ!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/8pmhKJ!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/8pmhKJ",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/8pmhKJ!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/8pmhKJ!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/8pmhKJ!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "",
                "DateAdded": "2014-02-25T10:51:25+00:00",
                "DateModified": "2014-02-25T10:51:25+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": ""
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": true,
                "NodeID": "HSBRm",
                "UrlPath": "/",
                "Uri": "/api/v2/node/HSBRm",
                "WebUri": "https://assets.smugmug.com",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/HSBRm",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/HSBRm!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/HSBRm!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/HSBRm",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/HSBRm!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/HSBRm!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/HSBRm!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Hierarchy of nodes from the given node (inclusive) to the root node.",
        "EndpointType": "ParentNodes",
        "Pages": {
            "Total": 3,
            "Start": 1,
            "Count": 3,
            "RequestedCount": 7,
            "FirstPage": "/api/v2/node/c2kQcT!parents?start=1&count=7",
            "LastPage": "/api/v2/node/c2kQcT!parents?start=1&count=7"
        },
        "Timing": {
            "Total": {
                "time": 0.05655,
                "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
  5. JSON