Response [200 Ok]

Uri /api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=11&count=10
UriDescription Search for folders
EndpointType FolderSearch
Locator Folder
LocatorType Objects

Folder [1 of 2] - Wing Conference
/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference

Uri /api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2020-09-16T03:40:29+00:00
DateModified 2022-06-26T20:31:30+00:00
Description empty string
IsEmpty false
Keywords empty string
Name Wing Conference
NodeID KvdTCh
PasswordHint empty string
SecurityType None
SortDirection Descending
SortMethod DateModified
UrlName Wing-Conference
UrlPath /Rocky-Mountain-Region/Idaho-Wing/Wing-Conference
WebUri https://photos.cap.gov/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference

Uris

FolderByID
/api/v2/folder/id/KvdTCh

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

HighlightImage
/api/v2/highlight/node/KvdTCh

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

Node
/api/v2/node/KvdTCh

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

ParentFolders
/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents

Uri /api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/CivilAirPatrol

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

Folder [2 of 2] - IDWG Cadet Competition
/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition

Uri /api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2025-03-07T22:46:57+00:00
DateModified 2025-03-07T22:46:57+00:00
Description empty string
IsEmpty false
Keywords empty string
Name IDWG Cadet Competition
NodeID LccPpV
PasswordHint empty string
SecurityType None
SortDirection Descending
SortMethod DateModified
UrlName IDWG-Cadet-Competition
UrlPath /Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition
WebUri https://photos.cap.gov/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition

Uris

FolderByID
/api/v2/folder/id/LccPpV

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

HighlightImage
/api/v2/highlight/node/LccPpV

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

Node
/api/v2/node/LccPpV

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

ParentFolders
/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents

Uri /api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

User
/api/v2/user/CivilAirPatrol

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

Timing

Total

cycles 1
objects 0
time 0.12403

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !search

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Search all text fields

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=11&count=10"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "Text",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Search all text fields",
                    "Type": "Varchar",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                },
                {
                    "Name": "SortMethod",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "_score",
                    "Type": "Select",
                    "OPTIONS": [
                        "Rank",
                        "LastUpdated"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "SortDirection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Descending",
                    "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": "folder"
            },
            {
                "type": "path",
                "text": "user"
            },
            {
                "type": "singleparam",
                "param_name": "nickname",
                "param_value": "CivilAirPatrol",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Rocky-Mountain-Region",
                    "Idaho-Wing"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "search"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node!search"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=11&count=10",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "Wing Conference",
                "UrlName": "Wing-Conference",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2020-09-16T03:40:29+00:00",
                "DateModified": "2022-06-26T20:31:30+00:00",
                "UrlPath": "/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference",
                "NodeID": "KvdTCh",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference",
                "WebUri": "https://photos.cap.gov/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/KvdTCh",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/KvdTCh",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/CivilAirPatrol",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "The sequence of parent folders, from the given folder to the root",
                        "EndpointType": "ParentFolders"
                    },
                    "ParentFolder": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/KvdTCh",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/Wing-Conference!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "IDWG Cadet Competition",
                "UrlName": "IDWG-Cadet-Competition",
                "SecurityType": "None",
                "SortMethod": "DateModified",
                "SortDirection": "Descending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2025-03-07T22:46:57+00:00",
                "DateModified": "2025-03-07T22:46:57+00:00",
                "UrlPath": "/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition",
                "NodeID": "LccPpV",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition",
                "WebUri": "https://photos.cap.gov/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/LccPpV",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/LccPpV",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/CivilAirPatrol",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!parents",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "The sequence of parent folders, from the given folder to the root",
                        "EndpointType": "ParentFolders"
                    },
                    "ParentFolder": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/LccPpV",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing/IDWG-Cadet-Competition!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "Search for folders",
        "EndpointType": "FolderSearch",
        "Pages": {
            "Total": 12,
            "Start": 11,
            "Count": 2,
            "RequestedCount": 10,
            "FirstPage": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=1&count=10",
            "LastPage": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=11&count=10",
            "PrevPage": "/api/v2/folder/user/CivilAirPatrol/Rocky-Mountain-Region/Idaho-Wing!search?start=1&count=10"
        },
        "Timing": {
            "Total": {
                "time": 0.12403,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}