Response [200 Ok]

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!parents
UriDescription The sequence of parent folders, from the given folder to the root
EndpointType ParentFolders
Locator Folder
LocatorType Objects

Folder [1 of 2]
/api/v2/folder/user/gagov

Uri /api/v2/folder/user/gagov
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2014-03-07T23:38:09+00:00
DateModified 2014-03-07T23:38:09+00:00
Description empty string
IsEmpty false
Keywords empty string
Name empty string
NodeID gkx2q
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName empty string
UrlPath empty string
WebUri https://photos.gov.georgia.gov

Uris

AlbumList
/api/v2/folder/user/gagov!albumlist

Uri /api/v2/folder/user/gagov!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List

FolderAlbums
/api/v2/folder/user/gagov!albums

Uri /api/v2/folder/user/gagov!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/gkx2q

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

FolderHighlightImage
/api/v2/folder/user/gagov!highlightimage

Uri /api/v2/folder/user/gagov!highlightimage
UriDescription Highlight image for folder
EndpointType FolderHighlightImage
Locator Image
LocatorType Object

FolderList
/api/v2/folder/user/gagov!folderlist

Uri /api/v2/folder/user/gagov!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List

FolderPages
/api/v2/folder/user/gagov!pages

Uri /api/v2/folder/user/gagov!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/gagov!search

Uri /api/v2/folder/user/gagov!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/gagov!folders

Uri /api/v2/folder/user/gagov!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/gkx2q

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

Node
/api/v2/node/gkx2q

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

Size
/api/v2/folder/user/gagov!size

Uri /api/v2/folder/user/gagov!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object

User
/api/v2/user/gagov

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

Folder [2 of 2] - Governor Brian P Kemp
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp
UriDescription A folder or legacy (sub)category by UrlPath
ResponseLevel Public
DateAdded 2019-01-16T16:06:04+00:00
DateModified 2021-05-25T19:53:06+00:00
Description Georgia Governor Kemp
IsEmpty false
Keywords Kemp; Governor; Governor Kemp; Governor Brian P Kemp
Name Governor Brian P Kemp
NodeID sHHMvb
PasswordHint empty string
SecurityType None
SortDirection Ascending
SortMethod SortIndex
UrlName Governor-Brian-P-Kemp
UrlPath /Governor-Brian-P-Kemp
WebUri https://photos.gov.georgia.gov/Governor-Brian-P-Kemp

Uris

AlbumList
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albumlist

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albumlist
UriDescription List of user's albums
EndpointType AlbumList
Locator AlbumList
LocatorType List

FolderAlbums
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albums

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albums
UriDescription Albums inside of the folder
EndpointType FolderAlbums
Locator Album
LocatorType Objects

FolderByID
/api/v2/folder/id/sHHMvb

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

FolderHighlightImage
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!highlightimage

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!highlightimage
UriDescription Highlight image for folder
EndpointType FolderHighlightImage
Locator Image
LocatorType Object

FolderList
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folderlist

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folderlist
UriDescription Recursive list of all of the user's folders
EndpointType FolderList
Locator FolderList
LocatorType List

FolderPages
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!pages

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!pages
UriDescription Pages inside of the folder
EndpointType FolderPages
Locator Page
LocatorType Objects

FolderSearch
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!search

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!search
UriDescription Search for folders
EndpointType FolderSearch
Locator FolderByID
LocatorType Objects

Folders
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folders

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folders
UriDescription Folders inside of the folder
EndpointType Folders
Locator Folder
LocatorType Objects

HighlightImage
/api/v2/highlight/node/sHHMvb

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

Node
/api/v2/node/sHHMvb

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

ParentFolder
/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!parent

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!parent
UriDescription Parent folder
EndpointType ParentFolder
Locator Folder
LocatorType Object

ParentFolders
/api/v2/folder/user/gagov!parents

Uri /api/v2/folder/user/gagov!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/gagov/Governor-Brian-P-Kemp!size

Uri /api/v2/folder/user/gagov/Governor-Brian-P-Kemp!size
UriDescription Size of folder
EndpointType Size
Locator Size
LocatorType Object

User
/api/v2/user/gagov

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

Timing

Total

cycles 1
objects 0
time 0.03129

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !parents

Notes

  • _multiargs does not work at this endpoint

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!parents"
    },
    "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)"
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "FolderID",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "",
                    "Type": "Varchar",
                    "MIN_CHARS": 5,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "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": "gagov"
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Governor-Brian-P-Kemp"
                ]
            },
            {
                "type": "action",
                "text": "parents"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!parents"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!parents",
        "Locator": "Folder",
        "LocatorType": "Objects",
        "Folder": [
            {
                "Name": "",
                "UrlName": "",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "",
                "Keywords": "",
                "PasswordHint": "",
                "DateAdded": "2014-03-07T23:38:09+00:00",
                "DateModified": "2014-03-07T23:38:09+00:00",
                "UrlPath": "",
                "NodeID": "gkx2q",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/gagov",
                "WebUri": "https://photos.gov.georgia.gov",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/gkx2q",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/gkx2q",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/gagov",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/gkx2q",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/gagov!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/gagov!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/gagov!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/gagov!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/gagov!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/gagov!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/gagov!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/gagov!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            },
            {
                "Name": "Governor Brian P Kemp",
                "UrlName": "Governor-Brian-P-Kemp",
                "SecurityType": "None",
                "SortMethod": "SortIndex",
                "SortDirection": "Ascending",
                "Description": "Georgia Governor Kemp",
                "Keywords": "Kemp; Governor; Governor Kemp; Governor Brian P Kemp",
                "PasswordHint": "",
                "DateAdded": "2019-01-16T16:06:04+00:00",
                "DateModified": "2021-05-25T19:53:06+00:00",
                "UrlPath": "/Governor-Brian-P-Kemp",
                "NodeID": "sHHMvb",
                "IsEmpty": false,
                "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp",
                "WebUri": "https://photos.gov.georgia.gov/Governor-Brian-P-Kemp",
                "UriDescription": "A folder or legacy (sub)category by UrlPath",
                "Uris": {
                    "FolderByID": {
                        "Uri": "/api/v2/folder/id/sHHMvb",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Get folder by its ID",
                        "EndpointType": "FolderByID"
                    },
                    "Node": {
                        "Uri": "/api/v2/node/sHHMvb",
                        "Locator": "Node",
                        "LocatorType": "Object",
                        "UriDescription": "Node with the given id.",
                        "EndpointType": "Node"
                    },
                    "User": {
                        "Uri": "/api/v2/user/gagov",
                        "Locator": "User",
                        "LocatorType": "Object",
                        "UriDescription": "User By Nickname",
                        "EndpointType": "User"
                    },
                    "ParentFolders": {
                        "Uri": "/api/v2/folder/user/gagov!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/gagov/Governor-Brian-P-Kemp!parent",
                        "Locator": "Folder",
                        "LocatorType": "Object",
                        "UriDescription": "Parent folder",
                        "EndpointType": "ParentFolder"
                    },
                    "HighlightImage": {
                        "Uri": "/api/v2/highlight/node/sHHMvb",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for a folder, album, or page",
                        "EndpointType": "HighlightImage"
                    },
                    "FolderHighlightImage": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!highlightimage",
                        "Locator": "Image",
                        "LocatorType": "Object",
                        "UriDescription": "Highlight image for folder",
                        "EndpointType": "FolderHighlightImage"
                    },
                    "Folders": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folders",
                        "Locator": "Folder",
                        "LocatorType": "Objects",
                        "UriDescription": "Folders inside of the folder",
                        "EndpointType": "Folders"
                    },
                    "FolderList": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!folderlist",
                        "Locator": "FolderList",
                        "LocatorType": "List",
                        "UriDescription": "Recursive list of all of the user's folders",
                        "EndpointType": "FolderList"
                    },
                    "FolderAlbums": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albums",
                        "Locator": "Album",
                        "LocatorType": "Objects",
                        "UriDescription": "Albums inside of the folder",
                        "EndpointType": "FolderAlbums"
                    },
                    "AlbumList": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!albumlist",
                        "Locator": "AlbumList",
                        "LocatorType": "List",
                        "UriDescription": "List of user's albums",
                        "EndpointType": "AlbumList"
                    },
                    "FolderSearch": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!search",
                        "Locator": "FolderByID",
                        "LocatorType": "Objects",
                        "UriDescription": "Search for folders",
                        "EndpointType": "FolderSearch"
                    },
                    "FolderPages": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!pages",
                        "Locator": "Page",
                        "LocatorType": "Objects",
                        "UriDescription": "Pages inside of the folder",
                        "EndpointType": "FolderPages"
                    },
                    "Size": {
                        "Uri": "/api/v2/folder/user/gagov/Governor-Brian-P-Kemp!size",
                        "Locator": "Size",
                        "LocatorType": "Object",
                        "UriDescription": "Size of folder",
                        "EndpointType": "Size"
                    }
                },
                "ResponseLevel": "Public"
            }
        ],
        "UriDescription": "The sequence of parent folders, from the given folder to the root",
        "EndpointType": "ParentFolders",
        "Timing": {
            "Total": {
                "time": 0.03129,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Notes
    2. Methods
    3. Available Media Types
    4. Parameters
  5. JSON