Response [200 Ok]

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

Node [1 of 2] - Sean Valley
/api/v2/node/73R5Nh

Uri /api/v2/node/73R5Nh
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2021-07-25T06:16:23+00:00
DateModified 2024-03-03T20:40:17+00:00
Description Photo credit: Sean Valley. Use as you wish but please credit photographer.
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Sean Valley
NodeID 73R5Nh
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Sean-Valley
UrlPath /ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Sean-Valley
WebUri https://www.steinbok.net/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Sean-Valley

Formatted Values

Name [html]

html Sean Valley

Description [html, text]

html Photo credit: Sean Valley.<br /> Use as you wish but please credit photographer.
text Photo credit: Sean Valley. Use as you wish but please credit photographer.

Uris

Album
/api/v2/album/d738H3

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

HighlightImage
/api/v2/highlight/node/73R5Nh

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

NodeComments
/api/v2/node/73R5Nh!comments

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

NodeCoverImage
/api/v2/node/73R5Nh!cover

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

ParentNode
/api/v2/node/73R5Nh!parent

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

ParentNodes
/api/v2/node/73R5Nh!parents

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

User
/api/v2/user/jeffsteinbok

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

Node [2 of 2] - Jeff Steinbok
/api/v2/node/K8H9ZW

Uri /api/v2/node/K8H9ZW
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2021-07-23T05:20:52+00:00
DateModified 2024-03-03T20:40:17+00:00
Description empty string
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Jeff Steinbok
NodeID K8H9ZW
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Jeff-Steinbok
UrlPath /ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Jeff-Steinbok
WebUri https://www.steinbok.net/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Jeff-Steinbok

Formatted Values

Name [html]

html Jeff Steinbok

Description [html, text]

html empty string
text empty string

Uris

Album
/api/v2/album/vwh8mM

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

HighlightImage
/api/v2/highlight/node/K8H9ZW

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

NodeComments
/api/v2/node/K8H9ZW!comments

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

NodeCoverImage
/api/v2/node/K8H9ZW!cover

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

ParentNode
/api/v2/node/K8H9ZW!parent

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

ParentNodes
/api/v2/node/K8H9ZW!parents

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

User
/api/v2/user/jeffsteinbok

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

Pages

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

Timing

Total

cycles 1
objects 0
time 0.0714

Request

Uri /api/v2/node/htgCXG!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/htgCXG!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": "htgCXG",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/htgCXG!children",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "Photo credit:  Sean Valley.\nUse as you wish but please credit photographer.",
                "Name": "Sean Valley",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Sean-Valley",
                "DateAdded": "2021-07-25T06:16:23+00:00",
                "DateModified": "2024-03-03T20:40:17+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Sean Valley"
                    },
                    "Description": {
                        "html": "Photo credit:  Sean Valley.<br />\nUse as you wish but please credit photographer.",
                        "text": "Photo credit:  Sean Valley.\nUse as you wish but please credit photographer."
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "73R5Nh",
                "UrlPath": "/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Sean-Valley",
                "Uri": "/api/v2/node/73R5Nh",
                "WebUri": "https://www.steinbok.net/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Sean-Valley",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/d738H3",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/73R5Nh!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/73R5Nh!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/jeffsteinbok",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/73R5Nh!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/73R5Nh",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/73R5Nh!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Description": "",
                "Name": "Jeff Steinbok",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": true,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Album",
                "UrlName": "Jeff-Steinbok",
                "DateAdded": "2021-07-23T05:20:52+00:00",
                "DateModified": "2024-03-03T20:40:17+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "Jeff Steinbok"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": false,
                "IsRoot": false,
                "NodeID": "K8H9ZW",
                "UrlPath": "/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Jeff-Steinbok",
                "Uri": "/api/v2/node/K8H9ZW",
                "WebUri": "https://www.steinbok.net/ELL/ELL-2021-Majors-AllStars/State/2021-07-24-vs-Northeast-Seattle-D8/Jeff-Steinbok",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "Album": {
                        "Uri": "/api/v2/album/vwh8mM",
                        "Locator": "Album",
                        "LocatorType": "Object",
                        "UriDescription": "Album by key",
                        "EndpointType": "Album"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/K8H9ZW!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/K8H9ZW!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/jeffsteinbok",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/K8H9ZW!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/K8H9ZW",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/K8H9ZW!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": 2,
            "Start": 1,
            "Count": 2,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/htgCXG!children?start=1&count=10",
            "LastPage": "/api/v2/node/htgCXG!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.0714,
                "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