Response [200 Ok]

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

Node [1 of 1] - 2021 Florida Summer Encampment
/api/v2/node/4wQSTW

Uri /api/v2/node/4wQSTW
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2021-07-01T02:17:54+00:00
DateModified 2021-07-02T00:19:59+00:00
Description empty string
EffectiveSecurityType None
HasChildren true
IsRoot false
Keywords
Name 2021 Florida Summer Encampment
NodeID 4wQSTW
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortMethod DateModified
Type Folder
UrlName 2021-Summer
UrlPath /SoutheastRegion/Florida-Wing/Encampment/2021-Summer
WebUri https://photos.cap.gov/SoutheastRegion/Florida-Wing/Encampment/2021-Summer

Formatted Values

Name [html]

html 2021 Florida Summer Encampment

Description [html, text]

html empty string
text empty string

Uris

ChildNodes
/api/v2/node/4wQSTW!children

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

FolderByID
/api/v2/folder/id/4wQSTW

Uri /api/v2/folder/id/4wQSTW
UriDescription Get folder by its ID
EndpointType FolderByID
Locator Folder
LocatorType Object

HighlightImage
/api/v2/highlight/node/4wQSTW

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

NodeComments
/api/v2/node/4wQSTW!comments

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

NodeCoverImage
/api/v2/node/4wQSTW!cover

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

ParentNode
/api/v2/node/4wQSTW!parent

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

ParentNodes
/api/v2/node/4wQSTW!parents

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

User
/api/v2/user/CivilAirPatrol

Uri /api/v2/user/CivilAirPatrol
UriDescription User By Nickname
EndpointType User
Locator User
LocatorType Object

Pages

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

Timing

Total

cycles 1
objects 0
time 0.03511

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/PLN7Pd!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": "PLN7Pd",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "children"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/PLN7Pd!children?start=1&count=10",
        "Locator": "Node",
        "LocatorType": "Objects",
        "Node": [
            {
                "Description": "",
                "Name": "2021 Florida Summer Encampment",
                "Keywords": [],
                "PasswordHint": "",
                "SecurityType": "None",
                "ShowCoverImage": false,
                "SortDirection": "Descending",
                "SortMethod": "DateModified",
                "Type": "Folder",
                "UrlName": "2021-Summer",
                "DateAdded": "2021-07-01T02:17:54+00:00",
                "DateModified": "2021-07-02T00:19:59+00:00",
                "EffectiveSecurityType": "None",
                "FormattedValues": {
                    "Name": {
                        "html": "2021 Florida Summer Encampment"
                    },
                    "Description": {
                        "html": "",
                        "text": ""
                    }
                },
                "HasChildren": true,
                "IsRoot": false,
                "NodeID": "4wQSTW",
                "UrlPath": "/SoutheastRegion/Florida-Wing/Encampment/2021-Summer",
                "Uri": "/api/v2/node/4wQSTW",
                "WebUri": "https://photos.cap.gov/SoutheastRegion/Florida-Wing/Encampment/2021-Summer",
                "UriDescription": "Node with the given id.",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/4wQSTW",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "ParentNode": {
                        "Uri": "/api/v2/node/4wQSTW!parent",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Parent node of the given node.",
                        "EndpointType": "ParentNode"
                    },
                    "ParentNodes": {
                        "Uri": "/api/v2/node/4wQSTW!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/CivilAirPatrol",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "NodeCoverImage": {
                        "Uri": "/api/v2/node/4wQSTW!cover",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Cover image for a folder, album, or page",
                        "EndpointType": "NodeCoverImage"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/4wQSTW",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "NodeComments": {
                        "Uri": "/api/v2/node/4wQSTW!comments",
                        "Locator": "Comment",
                        "LocatorType": "Objects",
                        "UriDescription": "Comments on a Node",
                        "EndpointType": "NodeComments"
                    },
                    "ChildNodes": {
                        "Uri": "/api/v2/node/4wQSTW!children",
                        "Locator": "Node",
                        "LocatorType": "Objects",
                        "UriDescription": "Child nodes of the given node.",
                        "EndpointType": "ChildNodes"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Child nodes of the given node.",
        "EndpointType": "ChildNodes",
        "Pages": {
            "Total": 1,
            "Start": 1,
            "Count": 1,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/node/PLN7Pd!children?start=1&count=10",
            "LastPage": "/api/v2/node/PLN7Pd!children?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.03511,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}