Response [200 Ok]

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

Node [1 of 1] - Breakfast meeting with BSSN
/api/v2/node/ztCR6s

Uri /api/v2/node/ztCR6s
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2022-08-27T05:14:46+00:00
DateModified 2022-08-27T05:15:53+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Name Breakfast meeting with BSSN
NodeID ztCR6s
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Breakfast-meeting-with-BSSN
UrlPath /All-files/Breakfast-meeting-with-BSSN
WebUri https://photos.usasean.org/All-files/Breakfast-meeting-with-BSSN

Formatted Values

Name [html]

html Breakfast meeting with BSSN

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/cF3WR3

Uri /api/v2/album/cF3WR3
UriDescription Album by key
EndpointType Album
Locator Album
LocatorType Object

HighlightImage
/api/v2/highlight/node/ztCR6s

Uri /api/v2/highlight/node/ztCR6s
UriDescription Highlight image for a folder, album, or page
EndpointType HighlightImage
Locator Image
LocatorType Object

NodeComments
/api/v2/node/ztCR6s!comments

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

NodeCoverImage
/api/v2/node/ztCR6s!cover

Uri /api/v2/node/ztCR6s!cover
UriDescription Cover image for a folder, album, or page
EndpointType NodeCoverImage
Locator Image
LocatorType Object

ParentNode
/api/v2/node/ztCR6s!parent

Uri /api/v2/node/ztCR6s!parent
UriDescription Parent node of the given node.
EndpointType ParentNode
Locator Node
LocatorType Object

ParentNodes
/api/v2/node/ztCR6s!parents

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

User
/api/v2/user/US-ASEAN

Uri /api/v2/user/US-ASEAN
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object

Pages

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

Timing

Total

cycles 1
objects 0
time 0.05968

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/GRgdzf!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": "GRgdzf",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/GRgdzf!children?start=1&count=10",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "Breakfast meeting with BSSN",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Breakfast-meeting-with-BSSN",
                "DateAdded": "2022-08-27T05:14:46+00:00",
                "DateModified": "2022-08-27T05:15:53+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Breakfast meeting with BSSN"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "ztCR6s",
                "UrlPath": "/All-files/Breakfast-meeting-with-BSSN",
                "Uri": "/api/v2/node/ztCR6s",
                "WebUri": "https://photos.usasean.org/All-files/Breakfast-meeting-with-BSSN",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/cF3WR3",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/ztCR6s!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/ztCR6s!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/US-ASEAN",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/ztCR6s!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/ztCR6s",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/ztCR6s!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Child nodes of the given node.",
        "EndpointType": "ChildNodes",
        "Pages": {
            "Total": 1,
            "Start": 1,
            "Count": 1,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/GRgdzf!children?start=1&count=10",
            "LastPage": "/api/v2/node/GRgdzf!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.05968,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}