Response [200 Ok]

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

FolderList [22 of 60] - Workshop with Vietnam Ministry of Health and Social Security Oct 22
/api/v2/folder/user/US-ASEAN/Events/2018/Workshop

Uri /api/v2/folder/user/US-ASEAN/Events/2018/Workshop
CanHaveFolder true
Name Workshop with Vietnam Ministry of Health and Social Security Oct 22
UrlPath /Events/2018/Workshop

Timing

Total

cycles 1
objects 0
time 0.18592

Config

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

Options

Path

  • /api
  • /v2
  • /folder
  • /user
  • /
  • /
  • !folderlist

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/US-ASEAN/Events!folderlist"
    },
    "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": "US-ASEAN",
                "param_validator": {}
            },
            {
                "type": "multipleparam",
                "param_name": "folder",
                "param_value": [
                    "Events"
                ],
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "folderlist"
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/node/:nodeid!children"
        }
    },
    "Response": {
        "Uri": "/api/v2/folder/user/US-ASEAN/Events!folderlist",
        "Locator": "FolderList",
        "LocatorType": "List",
        "FolderList": [
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019",
                "UrlPath": "/Events/2019",
                "Name": "2019",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018",
                "UrlPath": "/Events/2018",
                "Name": "2018",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2017",
                "UrlPath": "/Events/2017",
                "Name": "2017",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2016",
                "UrlPath": "/Events/2016",
                "Name": "2016",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2015",
                "UrlPath": "/Events/2015",
                "Name": "2015",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2014",
                "UrlPath": "/Events/2014",
                "Name": "2014",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013",
                "UrlPath": "/Events/2013",
                "Name": "2013",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2012",
                "UrlPath": "/Events/2012",
                "Name": "2012",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2011",
                "UrlPath": "/Events/2011",
                "Name": "2011",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2010",
                "UrlPath": "/Events/2010",
                "Name": "2010",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2009",
                "UrlPath": "/Events/2009",
                "Name": "2009",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2020",
                "UrlPath": "/Events/2020",
                "Name": "2020",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021",
                "UrlPath": "/Events/2021",
                "Name": "2021",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022",
                "UrlPath": "/Events/2022",
                "Name": "2022",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023",
                "UrlPath": "/Events/2023",
                "Name": "2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019/Workshop-on-Tackling-Illicit-Tra",
                "UrlPath": "/Events/2019/Workshop-on-Tackling-Illicit-Tra",
                "Name": "Workshop on Tackling Illicit Trade & Counterfeits for ASEAN CECWG",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019/ASEAN-US-Digital-Policy-Consultative-Forum-Manila",
                "UrlPath": "/Events/2019/ASEAN-US-Digital-Policy-Consultative-Forum-Manila",
                "Name": "ASEAN-US Digital Policy Consultative Forum - Manila",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019/1st-Indonesia-Innovation-Series-and-SME-Workshop",
                "UrlPath": "/Events/2019/1st-Indonesia-Innovation-Series-and-SME-Workshop",
                "Name": "1st Indonesia Innovation Series and SME-Workshop",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019/Welcome-Reception-for-US-CG-Marie-Damour-24-Sep-19",
                "UrlPath": "/Events/2019/Welcome-Reception-for-US-CG-Marie-Damour-24-Sep-19",
                "Name": "Welcome Reception for U.S. CG Marie Damour (24 Sep 19)",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2019/Board-of-Directors-Meeting-in-Hanoi-11-12-Dec-2019",
                "UrlPath": "/Events/2019/Board-of-Directors-Meeting-in-Hanoi-11-12-Dec-2019",
                "Name": "Board of Directors Meeting in Hanoi (11-12 Dec 2019)",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/SMB-Workshop-Hai-Phong",
                "UrlPath": "/Events/2018/SMB-Workshop-Hai-Phong",
                "Name": "SMB Workshop Hai Phong - November 21",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/Workshop",
                "UrlPath": "/Events/2018/Workshop",
                "Name": "Workshop with Vietnam Ministry of Health and Social Security Oct 22",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/Conference-30-Years-of-FDI-Mobilization-in-Vietnam",
                "UrlPath": "/Events/2018/Conference-30-Years-of-FDI-Mobilization-in-Vietnam",
                "Name": "Conference 30 Years of FDI Mobilization in Vietnam",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/Cyber-Security-Dinner-Dialogue-with-AMCC-Officials",
                "UrlPath": "/Events/2018/Cyber-Security-Dinner-Dialogue-with-AMCC-Officials",
                "Name": "Cyber Security Dinner Dialogue with AMCC Officials",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/MOU-Signing-With-The-Private-Sector-Development-Committee",
                "UrlPath": "/Events/2018/MOU-Signing-With-The-Private-Sector-Development-Committee",
                "Name": "MOU Signing Ceremony Between USABC And The Private Sector Development Committee",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/Workshop-with-Ministry-of-Health-and-Vietnam-Social-Security",
                "UrlPath": "/Events/2018/Workshop-with-Ministry-of-Health-and-Vietnam-Social-Security",
                "Name": "Workshop with Ministry of Health and Vietnam Social Security",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/Working-Luncheon-with-ASD--Randall-Schriver",
                "UrlPath": "/Events/2018/Working-Luncheon-with-ASD--Randall-Schriver",
                "Name": "Working Luncheon with Asst. Secretary of Defense Randall Schriver",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/2018-US-Ambassadors-Tour",
                "UrlPath": "/Events/2018/2018-US-Ambassadors-Tour",
                "Name": "2018 U.S. Ambassadors' Tour",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2018/SME-Workshop-Surabaya-March-7",
                "UrlPath": "/Events/2018/SME-Workshop-Surabaya-March-7",
                "Name": "SME Workshop Surabaya - March 7",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2017/ASEAN-Centre-for-Energy-USABC-Roundtable-at-SIEW",
                "UrlPath": "/Events/2017/ASEAN-Centre-for-Energy-USABC-Roundtable-at-SIEW",
                "Name": "ASEAN Centre for Energy-USABC Roundtable at SIEW",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2017/Commerce-Secretary-Wilbur-Ross",
                "UrlPath": "/Events/2017/Commerce-Secretary-Wilbur-Ross",
                "Name": "Chairman's Mission to Thailand and Laos with Commerce Secretary Wilbur Ross",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2015/AFMM-Meetings",
                "UrlPath": "/Events/2015/AFMM-Meetings",
                "Name": "AFMM Meetings",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2015/Gala-Dinner-20th-Anniversary-o",
                "UrlPath": "/Events/2015/Gala-Dinner-20th-Anniversary-o",
                "Name": "Gala Dinner - 20th Anniversary of US-Vietnam Relations",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2015/SME-Events",
                "UrlPath": "/Events/2015/SME-Events",
                "Name": "SME Events",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2015/UNGA",
                "UrlPath": "/Events/2015/UNGA",
                "Name": "UNGA",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2014/Amb-David-Shear-Farewell",
                "UrlPath": "/Events/2014/Amb-David-Shear-Farewell",
                "Name": "Ambassador David Shear Farewell Reception",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2014/SME-Events",
                "UrlPath": "/Events/2014/SME-Events",
                "Name": "SME Events",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2014/UNGA",
                "UrlPath": "/Events/2014/UNGA",
                "Name": "UNGA",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2013/US-ABC-BOD-Hanoi",
                "UrlPath": "/Events/2013/US-ABC-BOD-Hanoi",
                "Name": "US-ABC Board of Directors Meeting, Hanoi",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/Bayer-Roundtable-about-Glyphosate",
                "UrlPath": "/Events/2021/Bayer-Roundtable-about-Glyphosate",
                "Name": "Bayer Roundtable about Glyphosate",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry",
                "UrlPath": "/Events/2021/20210716-Workshop-on-Salmonella-Control-in-Poultry",
                "Name": "20210716 - Workshop on Salmonella Control in Poultry",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2021/SME-Webinar-Series-in-COVID-19",
                "UrlPath": "/Events/2021/SME-Webinar-Series-in-COVID-19",
                "Name": "SME Webinar Series in COVID-19",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/2022-Gala-Reception",
                "UrlPath": "/Events/2022/2022-Gala-Reception",
                "Name": "2022 Gala Reception",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/Amb-Mike-Meeting-with-MOH-MOIT-MPS-3-7-Oct-2022",
                "UrlPath": "/Events/2022/Amb-Mike-Meeting-with-MOH-MOIT-MPS-3-7-Oct-2022",
                "Name": "Amb Mike - Meeting with MOH, MOIT, MPS (3-7 Oct 2022)",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/SME-Program-Cambodia-2022",
                "UrlPath": "/Events/2022/SME-Program-Cambodia-2022",
                "Name": "SME Program Cambodia 2022",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/Board-Meeting",
                "UrlPath": "/Events/2022/Board-Meeting",
                "Name": "Board Meeting",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/US-ASEAN-Special-Summit",
                "UrlPath": "/Events/2022/US-ASEAN-Special-Summit",
                "Name": "US-ASEAN Special Summit",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/Travel-Re-opening-Roadshow",
                "UrlPath": "/Events/2022/Travel-Re-opening-Roadshow",
                "Name": "Travel Re-opening Roadshow",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2022/US-ASEAN-Special-Summit/US-ASEAN-Special-Summit-Event-with-Business-Leaders",
                "UrlPath": "/Events/2022/US-ASEAN-Special-Summit/US-ASEAN-Special-Summit-Event-with-Business-Leaders",
                "Name": "US-ASEAN Special Summit Event with Business Leaders",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Singapore-Business-Mission-2023",
                "UrlPath": "/Events/2023/Singapore-Business-Mission-2023",
                "Name": "Singapore Business Mission 2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Singapore-Digital-Economy-Dialogues-2023",
                "UrlPath": "/Events/2023/Singapore-Digital-Economy-Dialogues-2023",
                "Name": "Singapore Digital Economy Dialogues 2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/15th-ACCMSME-Meeting",
                "UrlPath": "/Events/2023/15th-ACCMSME-Meeting",
                "Name": "15th ACCMSME Meeting",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Roundtable-with-Gov-Ridwan",
                "UrlPath": "/Events/2023/Roundtable-with-Gov-Ridwan",
                "Name": "Roundtable with Gov. Ridwan",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Welcome-Luncheon-in-Honor-of-Amb-Nazri",
                "UrlPath": "/Events/2023/Welcome-Luncheon-in-Honor-of-Amb-Nazri",
                "Name": "Welcome Luncheon in Honor of Amb. Nazri",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/SME-Workshop-Singapore-2023",
                "UrlPath": "/Events/2023/SME-Workshop-Singapore-2023",
                "Name": "SME Workshop Singapore 2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Welcome-Luncheon-in-honor-of-AmbTanee-Sangrat",
                "UrlPath": "/Events/2023/Welcome-Luncheon-in-honor-of-AmbTanee-Sangrat",
                "Name": "Welcome Luncheon in honor of Amb.Tanee Sangrat",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Meeting-with-Governor-of-Central-Java-Ganjar-Pranowo",
                "UrlPath": "/Events/2023/Meeting-with-Governor-of-Central-Java-Ganjar-Pranowo",
                "Name": "Indonesia Meeting with Governor of Central Java, Ganjar Pranowo",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Singapore-Business-Mission-2023/Day-3-Thursday-20-July-2023",
                "UrlPath": "/Events/2023/Singapore-Business-Mission-2023/Day-3-Thursday-20-July-2023",
                "Name": "Day 3 - Thursday 20 July 2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Singapore-Business-Mission-2023/Day-2-Wednesday-19-July-2023",
                "UrlPath": "/Events/2023/Singapore-Business-Mission-2023/Day-2-Wednesday-19-July-2023",
                "Name": "Day 2 - Wednesday 19 July 2023",
                "CanHaveFolder": true
            },
            {
                "Uri": "/api/v2/folder/user/US-ASEAN/Events/2023/Singapore-Business-Mission-2023/Day-1-Tuesday-18-July-2023",
                "UrlPath": "/Events/2023/Singapore-Business-Mission-2023/Day-1-Tuesday-18-July-2023",
                "Name": "Day 1 - Tuesday 18 July 2023",
                "CanHaveFolder": true
            }
        ],
        "UriDescription": "Recursive list of all of the user's folders",
        "EndpointType": "FolderList",
        "Timing": {
            "Total": {
                "time": 0.18592,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}