Response [200 Ok]

Uri /api/v2/node/NZdTB9?_responseLevel=GrantAccess
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

Node [1 of 1] - Art Apart Fair 9th edition, Pan Pacific Orchard, Singapore
/api/v2/node/NZdTB9

Uri /api/v2/node/NZdTB9
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2017-01-08T04:36:30+00:00
DateModified 2021-07-19T04:24:35+00:00
Description 10 Claymore Road, 7 January 2017
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [4]
0 art apart fair
1 singapore art week
2 pan pacific orchard
3 rosalind lim
Name Art Apart Fair 9th edition, Pan Pacific Orchard, Singapore
NodeID NZdTB9
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortIndex 1483850190
SortMethod DateModified
Type Album
UrlName Art-Apart-Fair
UrlPath /Art-Apart-Fair
WebUri https://www.linyangchen.com/Art-Apart-Fair

Formatted Values

Name [html]

html Art Apart Fair 9th edition, Pan Pacific Orchard, Singapore

Description [html, text]

html 10 Claymore Road, 7 January 2017
text 10 Claymore Road, 7 January 2017

Uris

Album
/api/v2/album/jGK6kM

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

HighlightImage
/api/v2/highlight/node/NZdTB9

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

NodeComments
/api/v2/node/NZdTB9!comments

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

NodeCoverImage
/api/v2/node/NZdTB9!cover

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

ParentNode
/api/v2/node/NZdTB9!parent

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

ParentNodes
/api/v2/node/NZdTB9!parents

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

User
/api/v2/user/yangchen

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

Timing

Total

cycles 1
objects 0
time 0.03661

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

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/NZdTB9?_responseLevel=GrantAccess"
    },
    "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": "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": "NZdTB9",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/NZdTB9?_responseLevel=GrantAccess",
        "Locator": "Node",
        "LocatorType": "Object",
        "Node": {
            "Description": "10 Claymore Road, 7 January 2017",
            "Name": "Art Apart Fair 9th edition, Pan Pacific Orchard, Singapore",
            "Keywords": [
                "art apart fair",
                "singapore art week",
                "pan pacific orchard",
                "rosalind lim"
            ],
            "PasswordHint": "",
            "SecurityType": "None",
            "ShowCoverImage": false,
            "SortDirection": "Descending",
            "SortMethod": "DateModified",
            "Type": "Album",
            "UrlName": "Art-Apart-Fair",
            "DateAdded": "2017-01-08T04:36:30+00:00",
            "DateModified": "2021-07-19T04:24:35+00:00",
            "EffectiveSecurityType": "None",
            "FormattedValues": {
                "Name": {
                    "html": "Art Apart Fair 9th edition, Pan Pacific Orchard, Singapore"
                },
                "Description": {
                    "html": "10 Claymore Road, 7 January 2017",
                    "text": "10 Claymore Road, 7 January 2017"
                }
            },
            "HasChildren": false,
            "IsRoot": false,
            "NodeID": "NZdTB9",
            "SortIndex": 1483850190,
            "UrlPath": "/Art-Apart-Fair",
            "Uri": "/api/v2/node/NZdTB9",
            "WebUri": "https://www.linyangchen.com/Art-Apart-Fair",
            "UriDescription": "Node with the given id.",
            "Uris": {
                "Album": {
                    "Uri": "/api/v2/album/jGK6kM",
                    "Locator": "Album",
                    "LocatorType": "Object",
                    "UriDescription": "Album by key",
                    "EndpointType": "Album"
                },
                "ParentNode": {
                    "Uri": "/api/v2/node/NZdTB9!parent",
                    "Locator": "Node",
                    "LocatorType": "Object",
                    "UriDescription": "Parent node of the given node.",
                    "EndpointType": "ParentNode"
                },
                "ParentNodes": {
                    "Uri": "/api/v2/node/NZdTB9!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/yangchen",
                    "Locator": "User",
                    "LocatorType": "Object",
                    "UriDescription": "User By Nickname",
                    "EndpointType": "User"
                },
                "NodeCoverImage": {
                    "Uri": "/api/v2/node/NZdTB9!cover",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Cover image for a folder, album, or page",
                    "EndpointType": "NodeCoverImage"
                },
                "HighlightImage": {
                    "Uri": "/api/v2/highlight/node/NZdTB9",
                    "Locator": "Image",
                    "LocatorType": "Object",
                    "UriDescription": "Highlight image for a folder, album, or page",
                    "EndpointType": "HighlightImage"
                },
                "NodeComments": {
                    "Uri": "/api/v2/node/NZdTB9!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.03661,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Available Response Levels
    2. Methods
    3. Available Media Types
    4. Output Fields
  5. JSON