Response [200 Ok]

Uri /api/v2/node/3Zd6f3!parents?start=1&count=7
UriDescription Hierarchy of nodes from the given node (inclusive) to the root node.
EndpointType ParentNodes
Locator Node
LocatorType Objects

Node [1 of 2] - 20190929 New Scout Campout
/api/v2/node/3Zd6f3

Uri /api/v2/node/3Zd6f3
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-10-06T21:32:16+00:00
DateModified 2019-10-06T21:32:16+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name 20190929 New Scout Campout
NodeID 3Zd6f3
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortIndex 322
SortMethod DateModified
Type Album
UrlName 20190929-New-Scout-Campout
UrlPath /20190929-New-Scout-Campout
WebUri https://troop281.smugmug.com/20190929-New-Scout-Campout

Formatted Values

Name [html]

html 20190929 New Scout Campout

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/8W7nPV

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

HighlightImage
/api/v2/highlight/node/3Zd6f3

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

NodeComments
/api/v2/node/3Zd6f3!comments

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

NodeCoverImage
/api/v2/node/3Zd6f3!cover

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

ParentNode
/api/v2/node/3Zd6f3!parent

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

ParentNodes
/api/v2/node/3Zd6f3!parents

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

User
/api/v2/user/troop281

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

Node [2 of 2]
/api/v2/node/XhHJSS

Uri /api/v2/node/XhHJSS
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2019-04-04T23:40:14+00:00
DateModified 2019-04-04T23:40:14+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot true
Keywords
Array [0]
Name empty string
NodeID XhHJSS
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod SortIndex
Type Folder
UrlName empty string
UrlPath /
WebUri https://troop281.smugmug.com

Formatted Values

Name [html]

html empty string

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/XhHJSS!children

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

FolderByID
/api/v2/folder/id/XhHJSS

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

HighlightImage
/api/v2/highlight/node/XhHJSS

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

NodeComments
/api/v2/node/XhHJSS!comments

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

NodeCoverImage
/api/v2/node/XhHJSS!cover

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

ParentNodes
/api/v2/node/XhHJSS!parents

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

User
/api/v2/user/troop281

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

Pages

Count 2
FirstPage /api/v2/node/3Zd6f3!parents?start=1&count=7
LastPage /api/v2/node/3Zd6f3!parents?start=1&count=7
RequestedCount 7
Start 1
Total 2

Timing

Total

cycles 1
objects 0
time 0.0768

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/3Zd6f3!parents?start=1&count=7"
    },
    "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": "3Zd6f3",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "parents"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/3Zd6f3!parents?start=1&count=7",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "20190929 New Scout Campout",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "20190929-New-Scout-Campout",
                "DateAdded": "2019-10-06T21:32:16+00:00",
                "DateModified": "2019-10-06T21:32:16+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "20190929 New Scout Campout"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "3Zd6f3",
                "SortIndex": 322,
                "UrlPath": "/20190929-New-Scout-Campout",
                "Uri": "/api/v2/node/3Zd6f3",
                "WebUri": "https://troop281.smugmug.com/20190929-New-Scout-Campout",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/8W7nPV",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/3Zd6f3!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/3Zd6f3!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/troop281",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/3Zd6f3!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/3Zd6f3",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/3Zd6f3!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "SortIndex",
                "Type": "Folder",
                "UrlName": "",
                "DateAdded": "2019-04-04T23:40:14+00:00",
                "DateModified": "2019-04-04T23:40:14+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": ""
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": true,
                "NodeID": "XhHJSS",
                "UrlPath": "/",
                "Uri": "/api/v2/node/XhHJSS",
                "WebUri": "https://troop281.smugmug.com",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/XhHJSS",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/XhHJSS!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/troop281",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/XhHJSS!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/XhHJSS",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/XhHJSS!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/XhHJSS!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": 2,
            "Start": 1,
            "Count": 2,
            "RequestedCount": 7,
            "FirstPage": "/api/v2/node/3Zd6f3!parents?start=1&count=7",
            "LastPage": "/api/v2/node/3Zd6f3!parents?start=1&count=7"
        },
        "Timing": {
            "Total": {
                "time": 0.0768,
                "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