Response [200 Ok]

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

Node [1 of 2] - Graphics
/api/v2/node/cQMghL

Uri /api/v2/node/cQMghL
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2008-08-25T09:41:30+00:00
DateModified 2009-04-14T06:46:49+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Graphics
NodeID cQMghL
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortIndex 33
SortMethod DateModified
Type Album
UrlName Graphics
UrlPath /Other/Graphics
WebUri https://album.seafairpirates.org/Other/Graphics

Formatted Values

Name [html]

html Graphics

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/FrGVcn

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

HighlightImage
/api/v2/highlight/node/cQMghL

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

NodeComments
/api/v2/node/cQMghL!comments

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

NodeCoverImage
/api/v2/node/cQMghL!cover

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

NodePricelist
/api/v2/node/cQMghL!pricelist

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

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

ParentNodes
/api/v2/node/cQMghL!parents

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

User
/api/v2/user/piratepics

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

Node [2 of 2] - My SmugMug Site Files (Do Not Delete)
/api/v2/node/6WxDK6

Uri /api/v2/node/6WxDK6
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2009-06-20T23:22:23+00:00
DateModified 2009-06-20T23:22:23+00:00
Description DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files. Don't worry, your admirers will never see it, unless you show it to them.
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name My SmugMug Site Files (Do Not Delete)
NodeID 6WxDK6
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortIndex 34
SortMethod DateModified
Type Album
UrlName My-SmugMug-Site-Files-Do-Not
UrlPath /Other/My-SmugMug-Site-Files-Do-Not
WebUri https://album.seafairpirates.org/Other/My-SmugMug-Site-Files-Do-Not

Formatted Values

Name [html]

html My SmugMug Site Files (Do Not Delete)

Description [html, text]

html DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files. Don't worry, your admirers will never see it, unless you show it to them.
text DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files. Don't worry, your admirers will never see it, unless you show it to them.

Uris

Album
/api/v2/album/sBcTLP

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

HighlightImage
/api/v2/highlight/node/6WxDK6

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

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

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

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

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

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

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

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

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

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

User
/api/v2/user/piratepics

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

Pages

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

Timing

Total

cycles 1
objects 0
time 0.05329

Request

Uri /api/v2/node/JQLbC4!children
Method GET
Version v2

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/JQLbC4!children"
    },
    "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": "JQLbC4",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/JQLbC4!children",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "Graphics",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Graphics",
                "DateAdded": "2008-08-25T09:41:30+00:00",
                "DateModified": "2009-04-14T06:46:49+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Graphics"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "cQMghL",
                "SortIndex": 33,
                "UrlPath": "/Other/Graphics",
                "Uri": "/api/v2/node/cQMghL",
                "WebUri": "https://album.seafairpirates.org/Other/Graphics",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/FrGVcn",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/cQMghL!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/cQMghL!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/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/cQMghL!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/cQMghL",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/cQMghL!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/cQMghL!pricelist",
                        "Locator": "NodePricelist",
                        "LocatorType": "Object",
                        "UriDescription": "Get, update, or remove the pricelist mapped to this node.",
                        "EndpointType": "NodePricelist"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files.  Don't worry, your admirers will never see it, unless you show it to them.",
                "Name": "My SmugMug Site Files (Do Not Delete)",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "My-SmugMug-Site-Files-Do-Not",
                "DateAdded": "2009-06-20T23:22:23+00:00",
                "DateModified": "2009-06-20T23:22:23+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "My SmugMug Site Files (Do Not Delete)"
                    },
                    "Description": {
                        "html": "DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files.  Don't worry, your admirers will never see it, unless you show it to them.",
                        "text": "DO NOT DELETE. This gallery was created for you by SmugMug. Please do not delete it, it contains important site files.  Don't worry, your admirers will never see it, unless you show it to them."
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "6WxDK6",
                "SortIndex": 34,
                "UrlPath": "/Other/My-SmugMug-Site-Files-Do-Not",
                "Uri": "/api/v2/node/6WxDK6",
                "WebUri": "https://album.seafairpirates.org/Other/My-SmugMug-Site-Files-Do-Not",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/sBcTLP",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/6WxDK6!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/6WxDK6!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/piratepics",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/6WxDK6!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/6WxDK6",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/6WxDK6!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "NodePricelist": {
                        "Uri": "/api/v2/node/6WxDK6!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": 2,
            "Start": 1,
            "Count": 2,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/JQLbC4!children?start=1&count=10",
            "LastPage": "/api/v2/node/JQLbC4!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.05329,
                "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