Response [200 Ok]

Uri /api/v2/node/xmSj8R?_shorturis=&_responseLevel=Public
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

Node [1 of 1] - Coconut definitive postage stamps of Malaya
/api/v2/node/xmSj8R

Uri /api/v2/node/xmSj8R
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2015-03-02T12:02:07+00:00
DateModified 2015-03-02T12:02:07+00:00
Description The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing.
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [23]
0 malaya stamps
1 small heads issue
2 engraving
3 马来亚
4 邮票
5 郵便切手
6 commonwealth
7 postage stamp
8 sultan
9 definitive stamp
10 philately
11 coconut tree
12 line art
13 graphic design
14 straits settlements
15 postal history
16 malaysia
17 british military administration
18 stamp collecting
19 southeast asia
20 japanese occupation
21 key plate
22 key type
Name Coconut definitive postage stamps of Malaya
NodeID xmSj8R
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortIndex 1425297727
Type Page
UrlName Malaya-postage-stamps
UrlPath /Malaya-postage-stamps
WebUri https://www.linyangchen.com/Malaya-postage-stamps

Formatted Values

Name [html]

html Coconut definitive postage stamps of Malaya

Description [html, text]

html The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing.
text The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing.

Timing

Total

cycles 1
objects 0
time 0.02727

Config

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

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/xmSj8R?_shorturis=&_verbosity=3&_accept=text%2Fhtml&_responseLevel=Public"
    },
    "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": "xmSj8R",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/xmSj8R?_shorturis=&_responseLevel=Public",
        "Locator": "Node",
        "LocatorType": "Object",
        "Node": {
            "Description": "The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing.",
            "Name": "Coconut definitive postage stamps of Malaya",
            "Keywords": [
                "malaya stamps",
                "small heads issue",
                "engraving",
                "\u9a6c\u6765\u4e9a",
                "\u90ae\u7968",
                "\u90f5\u4fbf\u5207\u624b",
                "commonwealth",
                "postage stamp",
                "sultan",
                "definitive stamp",
                "philately",
                "coconut tree",
                "line art",
                "graphic design",
                "straits settlements",
                "postal history",
                "malaysia",
                "british military administration",
                "stamp collecting",
                "southeast asia",
                "japanese occupation",
                "key plate",
                "key type"
            ],
            "PasswordHint": "",
            "SecurityType": "None",
            "ShowCoverImage": false,
            "Type": "Page",
            "UrlName": "Malaya-postage-stamps",
            "DateAdded": "2015-03-02T12:02:07+00:00",
            "DateModified": "2015-03-02T12:02:07+00:00",
            "EffectiveSecurityType": "None",
            "FormattedValues": {
                "Name": {
                    "html": "Coconut definitive postage stamps of Malaya"
                },
                "Description": {
                    "html": "The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing.",
                    "text": "The story of the iconic coconut-palm definitive postage stamps of Malaya: history, culture, graphic design, typography, printing."
                }
            },
            "HasChildren": false,
            "IsRoot": false,
            "NodeID": "xmSj8R",
            "SortIndex": 1425297727,
            "UrlPath": "/Malaya-postage-stamps",
            "Uri": "/api/v2/node/xmSj8R",
            "WebUri": "https://www.linyangchen.com/Malaya-postage-stamps",
            "UriDescription": "Node with the given id.",
            "Uris": {
                "Page": "/api/v2/page/xmSj8R",
                "ParentNode": "/api/v2/node/xmSj8R!parent",
                "ParentNodes": "/api/v2/node/xmSj8R!parents",
                "User": "/api/v2/user/yangchen",
                "NodeCoverImage": "/api/v2/node/xmSj8R!cover",
                "HighlightImage": "/api/v2/highlight/node/xmSj8R",
                "NodeComments": "/api/v2/node/xmSj8R!comments"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Node with the given id.",
        "EndpointType": "Node",
        "Timing": {
            "Total": {
                "time": 0.02727,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}