Response [200 Ok]

Uri /api/v2/node/fN6hbT?_shorturis=
UriDescription Node with the given id.
EndpointType Node
Locator Node
LocatorType Object

Node [1 of 1] - Cadet Advisory Council Meeting
/api/v2/node/fN6hbT

Uri /api/v2/node/fN6hbT
UriDescription Node with the given id.
ResponseLevel Public
DateAdded 2018-02-25T03:21:00+00:00
DateModified 2021-07-19T03:06:36+00:00
Description Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)
EffectiveSecurityType None
HasChildren false
IsRoot false
Keywords
Array [0]
Name Cadet Advisory Council Meeting
NodeID fN6hbT
PasswordHint empty string
SecurityType None
ShowCoverImage false
SortDirection Descending
SortIndex 2
SortMethod DateModified
Type Album
UrlName CAC
UrlPath /Pacific-Region/California-Wing/Conferences/2014/CAC
WebUri https://photos.cap.gov/Pacific-Region/California-Wing/Conferences/2014/CAC

Formatted Values

Name [html]

html Cadet Advisory Council Meeting

Description [html, text]

html Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)
text Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)

Uris

Album /api/v2/album/4nStTT
HighlightImage /api/v2/highlight/node/fN6hbT
NodeComments /api/v2/node/fN6hbT!comments
NodeCoverImage /api/v2/node/fN6hbT!cover
ParentNode /api/v2/node/fN6hbT!parent
ParentNodes /api/v2/node/fN6hbT!parents
User /api/v2/user/CivilAirPatrol

Timing

Total

cycles 1
objects 0
time 0.0341

Request

Uri /api/v2/node/fN6hbT?_shorturis=
Method GET
Version v2

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

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/fN6hbT?_shorturis="
    },
    "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": "fN6hbT",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/node/fN6hbT?_shorturis=",
        "Locator": "Node",
        "LocatorType": "Object",
        "Node": {
            "Description": "Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)",
            "Name": "Cadet Advisory Council Meeting",
            "Keywords": [],
            "PasswordHint": "",
            "SecurityType": "None",
            "ShowCoverImage": false,
            "SortDirection": "Descending",
            "SortMethod": "DateModified",
            "Type": "Album",
            "UrlName": "CAC",
            "DateAdded": "2018-02-25T03:21:00+00:00",
            "DateModified": "2021-07-19T03:06:36+00:00",
            "EffectiveSecurityType": "None",
            "FormattedValues": {
                "Name": {
                    "html": "Cadet Advisory Council Meeting"
                },
                "Description": {
                    "html": "Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)",
                    "text": "Members of the wing Cadet Advisory Council conduct a public session during California Wing Conference on Saturday, October 11, 2014 in Sacramento, California. (Civil Air Patrol photos by Maj. Crystal Housman)"
                }
            },
            "HasChildren": false,
            "IsRoot": false,
            "NodeID": "fN6hbT",
            "SortIndex": 2,
            "UrlPath": "/Pacific-Region/California-Wing/Conferences/2014/CAC",
            "Uri": "/api/v2/node/fN6hbT",
            "WebUri": "https://photos.cap.gov/Pacific-Region/California-Wing/Conferences/2014/CAC",
            "UriDescription": "Node with the given id.",
            "Uris": {
                "Album": "/api/v2/album/4nStTT",
                "ParentNode": "/api/v2/node/fN6hbT!parent",
                "ParentNodes": "/api/v2/node/fN6hbT!parents",
                "User": "/api/v2/user/CivilAirPatrol",
                "NodeCoverImage": "/api/v2/node/fN6hbT!cover",
                "HighlightImage": "/api/v2/highlight/node/fN6hbT",
                "NodeComments": "/api/v2/node/fN6hbT!comments"
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Node with the given id.",
        "EndpointType": "Node",
        "Timing": {
            "Total": {
                "time": 0.0341,
                "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