Response [200 Ok]

Uri /api/v2/node/pHF4VS
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

Node [1 of 1] - Albatros Arctic Circle - Kangerlussuaq
/api/v2/node/pHF4VS

Uri /api/v2/node/pHF4VS
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2022-04-29T10:45:51+00:00
DateModified 2022-04-29T10:45:51+00:00
Description Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use. Please tag the operator in social media with @albatrosarcticcircle
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Name Albatros Arctic Circle - Kangerlussuaq
NodeID pHF4VS
PasswordHint empty string
SecurityType None
ShowCoverImage true
SortDirection Descending
SortMethod DateModified
Type Album
UrlName Albatros-Arctic-Circle
UrlPath /Operators/Albatros-Arctic-Circle
WebUri https://destinationarcticcircle.smugmug.com/Operators/Albatros-Arctic-Circle

Formatted Values

Name [html]

html Albatros Arctic Circle - Kangerlussuaq

Description [html, text]

html Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use.<br /> Please tag the operator in social media with @albatrosarcticcircle
text Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use. Please tag the operator in social media with @albatrosarcticcircle

Uris

Album
/api/v2/album/c4Rk4b

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

HighlightImage
/api/v2/highlight/node/pHF4VS

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

NodeComments
/api/v2/node/pHF4VS!comments

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

NodeCoverImage
/api/v2/node/pHF4VS!cover

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

ParentNode
/api/v2/node/pHF4VS!parent

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

ParentNodes
/api/v2/node/pHF4VS!parents

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

User
/api/v2/user/destinationarcticcircle

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

Timing

Total

cycles 1
objects 0
time 0.06267

Request

Uri /api/v2/node/pHF4VS
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /node
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Output Fields

BelongsToThirdPartyAccountGroup boolean Whether this node belongs to a Third Party account group.
CoverImageUri uri
DateAdded datetimeiso8601
DateModified datetimeiso8601
Description text Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization.
EffectivePrivacy select
  • Public
  • Unlisted
  • Private
Effective privacy level of this node. This takes into account the effect of privacy settings from this node's ancestors.
EffectiveSecurityType select
  • None
  • Password
  • GrantAccess
Effective security type of this node. This takes into account the effect of security settings from this node's ancestors.
FormattedValues hash Alternative versions of certain fields formatted for use in different contexts.
HasChildren boolean Whether this node contains any child nodes.
HideOwner boolean Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes.
HighlightImageUri uri
IsRoot boolean Whether this node is the owner's root node.
Keywords array Array of keywords describing the content of this node. Some node types use this for search engine optimization.
Name text Human-readable name for this node.
NodeID text This node's ID
Password text
PasswordHint text
Privacy select
  • Public
  • Unlisted
  • Private
Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy.
SecurityType select
  • None
  • Password
  • GrantAccess
Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType.
ShowCoverImage boolean Whether or not to display the cover image when possible.
SmugSearchable select
  • No
  • Local
  • LocalUser
  • Yes
  • Inherit from User
Acceptable values differ for root nodes and child nodes. Root nodes: No, Local, LocalUser, Yes Child nodes: No, Inherit from User
SortDirection select
  • Ascending
  • Descending
SortIndex integer
SortMethod select
  • SortIndex
  • Name
  • DateAdded
  • DateModified
Type select
  • Album
  • Page
  • Folder
  • System Album
  • System Page
UrlName text This is usually a URL-friendly version of the human-readable name. Must start with a capital letter.
UrlPath text
WorldSearchable select
  • No
  • HomeOnly
  • Yes
  • Inherit from User
Acceptable values differ for root nodes and child nodes. Root nodes: No, HomeOnly, Yes Child nodes: No, Inherit from User

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/node/pHF4VS"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "CoverImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Image"
                ]
            },
            {
                "Name": "Description",
                "Description": "Human-readable description for this node. May contain basic HTML. Some node types display this to the user; some merely use it for search engine optimization.",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": 65535
            },
            {
                "Name": "HideOwner",
                "Description": "Whether to hide the identity of this node's owner from visitors. Only applicable to Album nodes.",
                "Type": "Boolean"
            },
            {
                "Name": "HighlightImageUri",
                "Type": "Uri",
                "MAX_LENGTH": "INFINITY",
                "Locator": [
                    "Image"
                ]
            },
            {
                "Name": "Name",
                "Description": "Human-readable name for this node.",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 254
            },
            {
                "Name": "Keywords",
                "Description": "Array of keywords describing the content of this node. Some node types use this for search engine optimization.",
                "Type": "Array",
                "ITEM_TYPE": "Varchar",
                "MIN_COUNT": 0,
                "MAX_COUNT": "INFINITY"
            },
            {
                "Name": "Password",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 50
            },
            {
                "Name": "PasswordHint",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "Privacy",
                "Description": "Privacy level for this node. NOTE: This may be overridden by a more restrictive privacy setting inherited from one of this node's ancestors. See EffectivePrivacy.",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SecurityType",
                "Description": "Security type for this node. NOTE: This may be overridden by a more restrictive security setting inherited from one of this node's ancestors. See EffectiveSecurityType.",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "ShowCoverImage",
                "Description": "Whether or not to display the cover image when possible.",
                "Type": "Boolean"
            },
            {
                "Name": "SmugSearchable",
                "Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, Local, LocalUser, Yes\nChild nodes: No, Inherit from User",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "Local",
                    "LocalUser",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortDirection",
                "Type": "Select",
                "OPTIONS": [
                    "Ascending",
                    "Descending"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "SortMethod",
                "Type": "Select",
                "OPTIONS": [
                    "SortIndex",
                    "Name",
                    "DateAdded",
                    "DateModified"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "Type",
                "Type": "Select",
                "OPTIONS": [
                    "Album",
                    "Page",
                    "Folder",
                    "System Album",
                    "System Page"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "UrlName",
                "Description": "This is usually a URL-friendly version of the human-readable name. Must start with a capital letter.",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": 60
            },
            {
                "Name": "WorldSearchable",
                "Description": "Acceptable values differ for root nodes and child nodes.\n\nRoot nodes: No, HomeOnly, Yes\nChild nodes: No, Inherit from User",
                "Type": "Select",
                "OPTIONS": [
                    "No",
                    "HomeOnly",
                    "Yes",
                    "Inherit from User"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "BelongsToThirdPartyAccountGroup",
                "Description": "Whether this node belongs to a Third Party account group.",
                "Type": "Boolean"
            },
            {
                "Name": "DateAdded",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "DateModified",
                "Type": "DateTimeISO8601"
            },
            {
                "Name": "EffectivePrivacy",
                "Description": "Effective privacy level of this node. This takes into account the effect of privacy settings from this node's ancestors.",
                "Type": "Select",
                "OPTIONS": [
                    "Public",
                    "Unlisted",
                    "Private"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "EffectiveSecurityType",
                "Description": "Effective security type of this node. This takes into account the effect of security settings from this node's ancestors.",
                "Type": "Select",
                "OPTIONS": [
                    "None",
                    "Password",
                    "GrantAccess"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "FormattedValues",
                "Description": "Alternative versions of certain fields formatted for use in different contexts.",
                "Type": "Hash"
            },
            {
                "Name": "HasChildren",
                "Description": "Whether this node contains any child nodes.",
                "Type": "Boolean"
            },
            {
                "Name": "IsRoot",
                "Description": "Whether this node is the owner's root node.",
                "Type": "Boolean"
            },
            {
                "Name": "NodeID",
                "Description": "This node's ID",
                "Type": "Varchar",
                "MIN_CHARS": 1,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "SortIndex",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "UrlPath",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            }
        ],
        "ResponseLevels": [
            "Full",
            "Public",
            "Password",
            "GrantAccess"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "node"
            },
            {
                "type": "singleparam",
                "param_name": "nodeid",
                "param_value": "pHF4VS",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/pHF4VS",
        "Locator": "Node",
        "LocatorType": "Object",
        "Node": {
            "Description": "Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use.\nPlease tag the operator in social media with @albatrosarcticcircle",
            "Name": "Albatros Arctic Circle - Kangerlussuaq",
            "Keywords": [],
            "PasswordHint": "",
            "SecurityType": "None",
            "ShowCoverImage": true,
            "SortDirection": "Descending",
            "SortMethod": "DateModified",
            "Type": "Album",
            "UrlName": "Albatros-Arctic-Circle",
            "DateAdded": "2022-04-29T10:45:51+00:00",
            "DateModified": "2022-04-29T10:45:51+00:00",
            "EffectiveSecurityType": "None",
            "FormattedValues": {
                "Name": {
                    "html": "Albatros Arctic Circle - Kangerlussuaq"
                },
                "Description": {
                    "html": "Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use.<br />\nPlease tag the operator in social media with @albatrosarcticcircle",
                    "text": "Please acknowledge this tour operator and use the credit line associated with each image when using on online or for any other media use.\nPlease tag the operator in social media with @albatrosarcticcircle"
                }
            },
            "HasChildren": false,
            "IsRoot": false,
            "NodeID": "pHF4VS",
            "UrlPath": "/Operators/Albatros-Arctic-Circle",
            "Uri": "/api/v2/node/pHF4VS",
            "WebUri": "https://destinationarcticcircle.smugmug.com/Operators/Albatros-Arctic-Circle",
            "UriDescription": "Node with the given id.",
            "Uris": {
                "Album": {
                    "Uri": "/api/v2/album/c4Rk4b",
                    "Locator": "Album",
                    "LocatorType": "Object",
                    "UriDescription": "Album by key",
                    "EndpointType": "Album"
                },
                "ParentNode": {
                    "Uri": "/api/v2/node/pHF4VS!parent",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Parent node of the given node.",
                    "EndpointType": "ParentNode"
                },
                "ParentNodes": {
                    "Uri": "/api/v2/node/pHF4VS!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/destinationarcticcircle",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "NodeCoverImage": {
                    "Uri": "/api/v2/node/pHF4VS!cover",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Cover image for a folder, album, or page",
                    "EndpointType": "NodeCoverImage"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/pHF4VS",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "NodeComments": {
                    "Uri": "/api/v2/node/pHF4VS!comments",
                    "Locator": "Comment",
                    "LocatorType": "Objects",
                    "UriDescription": "Comments on a Node",
                    "EndpointType": "NodeComments"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Node with the given id.",
        "EndpointType": "Node",
        "Timing": {
            "Total": {
                "time": 0.06267,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}