Deprecated
| Alternative | /api/v2/node!search |
|---|
Response [200 Ok]
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10 |
|---|---|
| UriDescription | Search for folders |
| EndpointType | FolderSearch |
| Locator | Folder |
| LocatorType | Objects |
Folder [1 of 1]
- The Grand Canyon NP, split into 5 areas
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon |
|---|---|
| UriDescription | A folder or legacy (sub)category by UrlPath |
| ResponseLevel | Public |
| DateAdded | 2016-07-12T21:31:41+00:00 |
| DateModified | 2017-12-14T05:19:37+00:00 |
| Description | Still moving, captioning and working on photos 7/12/2016. includes walking the entire Hermits Rest rim trail, hike down the South Kaibab trail to Ooh Aah Point and Cedar Flats, Nice sunsets at Desert View and 2 Elk feeding at 6:00 AM Plus the North Rim |
| IsEmpty | false |
| Keywords | empty string |
| Name | The Grand Canyon NP, split into 5 areas |
| NodeID | dNc8JZ |
| PasswordHint | empty string |
| SecurityType | None |
| SortDirection | Descending |
| SortMethod | DateModified |
| UrlName | Grand-Canyon |
| UrlPath | /Outside-of-Washington/Grand-Canyon |
| WebUri | https://www.georgeackley.com/Outside-of-Washington/Grand-Canyon |
Uris
AlbumList
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albumlist
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albumlist |
|---|---|
| UriDescription | List of user's albums |
| EndpointType | AlbumList |
| Locator | AlbumList |
| LocatorType | List |
FolderAlbums
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albums
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albums |
|---|---|
| UriDescription | Albums inside of the folder |
| EndpointType | FolderAlbums |
| Locator | Album |
| LocatorType | Objects |
FolderByID
/api/v2/folder/id/dNc8JZ
| Uri | /api/v2/folder/id/dNc8JZ |
|---|---|
| UriDescription | Get folder by its ID |
| EndpointType | FolderByID |
| Locator | Folder |
| LocatorType | Object |
FolderHighlightImage
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!highlightimage
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!highlightimage |
|---|---|
| UriDescription | Highlight image for folder |
| EndpointType | FolderHighlightImage |
| Locator | Image |
| LocatorType | Object |
FolderList
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folderlist
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folderlist |
|---|---|
| UriDescription | Recursive list of all of the user's folders |
| EndpointType | FolderList |
| Locator | FolderList |
| LocatorType | List |
FolderPages
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!pages
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!pages |
|---|---|
| UriDescription | Pages inside of the folder |
| EndpointType | FolderPages |
| Locator | Page |
| LocatorType | Objects |
FolderSearch
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!search
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!search |
|---|---|
| UriDescription | Search for folders |
| EndpointType | FolderSearch |
| Locator | FolderByID |
| LocatorType | Objects |
Folders
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folders
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folders |
|---|---|
| UriDescription | Folders inside of the folder |
| EndpointType | Folders |
| Locator | Folder |
| LocatorType | Objects |
HighlightImage
/api/v2/highlight/node/dNc8JZ
| Uri | /api/v2/highlight/node/dNc8JZ |
|---|---|
| UriDescription | Highlight image for a folder, album, or page |
| EndpointType | HighlightImage |
| Locator | Image |
| LocatorType | Object |
Node
/api/v2/node/dNc8JZ
| Uri | /api/v2/node/dNc8JZ |
|---|---|
| UriDescription | Node with the given id. |
| EndpointType | Node |
| Locator | Node |
| LocatorType | Object |
ParentFolder
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!parent
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!parent |
|---|---|
| UriDescription | Parent folder |
| EndpointType | ParentFolder |
| Locator | Folder |
| LocatorType | Object |
ParentFolders
/api/v2/folder/user/George-Ackley/Outside-of-Washington!parents
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington!parents |
|---|---|
| UriDescription | The sequence of parent folders, from the given folder to the root |
| EndpointType | ParentFolders |
| Locator | Folder |
| LocatorType | Objects |
Size
/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!size
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!size |
|---|---|
| UriDescription | Size of folder |
| EndpointType | Size |
| Locator | Size |
| LocatorType | Object |
User
/api/v2/user/George-Ackley
| Uri | /api/v2/user/George-Ackley |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
Pages
| Count | 1 |
|---|---|
| FirstPage | /api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10 |
| LastPage | /api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10 |
| RequestedCount | 10 |
| Start | 1 |
| Total | 1 |
Request
| Uri | /api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10 |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- _multiargs does not work at this endpoint
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&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": "George-Ackley",
"param_validator": {}
},
{
"type": "multipleparam",
"param_name": "folder",
"param_value": [
"Outside-of-Washington"
],
"param_validator": {}
},
{
"type": "action",
"text": "search"
}
],
"Deprecated": {
"Alternative": "/api/v2/node!search"
}
},
"Response": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10",
"Locator": "Folder",
"LocatorType": "Objects",
"Folder": [
{
"Name": "The Grand Canyon NP, split into 5 areas",
"UrlName": "Grand-Canyon",
"SecurityType": "None",
"SortMethod": "DateModified",
"SortDirection": "Descending",
"Description": "Still moving, captioning and working on photos 7/12/2016. includes walking the entire Hermits Rest rim trail, hike down the South Kaibab trail to Ooh Aah Point and Cedar Flats, Nice sunsets at Desert View and 2 Elk feeding at 6:00 AM Plus the North Rim",
"Keywords": "",
"PasswordHint": "",
"DateAdded": "2016-07-12T21:31:41+00:00",
"DateModified": "2017-12-14T05:19:37+00:00",
"UrlPath": "/Outside-of-Washington/Grand-Canyon",
"NodeID": "dNc8JZ",
"IsEmpty": false,
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon",
"WebUri": "https://www.georgeackley.com/Outside-of-Washington/Grand-Canyon",
"UriDescription": "A folder or legacy (sub)category by UrlPath",
"Uris": {
"FolderByID": {
"Uri": "/api/v2/folder/id/dNc8JZ",
"Locator": "Folder",
"LocatorType": "Object",
"UriDescription": "Get folder by its ID",
"EndpointType": "FolderByID"
},
"Node": {
"Uri": "/api/v2/node/dNc8JZ",
"Locator": "Node",
"LocatorType": "Object",
"UriDescription": "Node with the given id.",
"EndpointType": "Node"
},
"User": {
"Uri": "/api/v2/user/George-Ackley",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"ParentFolders": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington!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/George-Ackley/Outside-of-Washington/Grand-Canyon!parent",
"Locator": "Folder",
"LocatorType": "Object",
"UriDescription": "Parent folder",
"EndpointType": "ParentFolder"
},
"HighlightImage": {
"Uri": "/api/v2/highlight/node/dNc8JZ",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Highlight image for a folder, album, or page",
"EndpointType": "HighlightImage"
},
"FolderHighlightImage": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!highlightimage",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Highlight image for folder",
"EndpointType": "FolderHighlightImage"
},
"Folders": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folders",
"Locator": "Folder",
"LocatorType": "Objects",
"UriDescription": "Folders inside of the folder",
"EndpointType": "Folders"
},
"FolderList": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!folderlist",
"Locator": "FolderList",
"LocatorType": "List",
"UriDescription": "Recursive list of all of the user's folders",
"EndpointType": "FolderList"
},
"FolderAlbums": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albums",
"Locator": "Album",
"LocatorType": "Objects",
"UriDescription": "Albums inside of the folder",
"EndpointType": "FolderAlbums"
},
"AlbumList": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!albumlist",
"Locator": "AlbumList",
"LocatorType": "List",
"UriDescription": "List of user's albums",
"EndpointType": "AlbumList"
},
"FolderSearch": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!search",
"Locator": "FolderByID",
"LocatorType": "Objects",
"UriDescription": "Search for folders",
"EndpointType": "FolderSearch"
},
"FolderPages": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!pages",
"Locator": "Page",
"LocatorType": "Objects",
"UriDescription": "Pages inside of the folder",
"EndpointType": "FolderPages"
},
"Size": {
"Uri": "/api/v2/folder/user/George-Ackley/Outside-of-Washington/Grand-Canyon!size",
"Locator": "Size",
"LocatorType": "Object",
"UriDescription": "Size of folder",
"EndpointType": "Size"
}
},
"ResponseLevel": "Public"
}
],
"UriDescription": "Search for folders",
"EndpointType": "FolderSearch",
"Pages": {
"Total": 1,
"Start": 1,
"Count": 1,
"RequestedCount": 10,
"FirstPage": "/api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10",
"LastPage": "/api/v2/folder/user/George-Ackley/Outside-of-Washington!search?start=1&count=10"
},
"Timing": {
"Total": {
"time": 0.12153,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}