GET v1/Folder/List

Request Information

URI Parameters

Name	Type	Additional information
EventGuid	globally unique identifier	None.
TrainingGuid	globally unique identifier	None.
ParentGuid	globally unique identifier	None.
SearchTags	Collection of string	None.
Skip	integer	None.
Take	integer	None.
SearchString	string	None.
SortDirection	SortDirection	None.
SortName	ListSortName	None.

Body Parameters

None.

Response Information

Resource Description

FolderListViewModel

Name	Description	Type	Additional information
Items		Collection of FolderListItemViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "Guid": "ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f",
      "Name": "sample string 2",
      "IsSystem": true,
      "SystemLocked": true,
      "ParentGuid": "841114cc-2eaa-4468-b9a3-9fc8d5ed8542",
      "HasChildren": true,
      "FolderItemType": 0,
      "SystemFolderTypeName": "sample string 6"
    },
    {
      "Guid": "ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f",
      "Name": "sample string 2",
      "IsSystem": true,
      "SystemLocked": true,
      "ParentGuid": "841114cc-2eaa-4468-b9a3-9fc8d5ed8542",
      "HasChildren": true,
      "FolderItemType": 0,
      "SystemFolderTypeName": "sample string 6"
    }
  ]
}

application/octet-stream

Sample:

{"Items":[{"Guid":"ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f","Name":"sample string 2","IsSystem":true,"SystemLocked":true,"ParentGuid":"841114cc-2eaa-4468-b9a3-9fc8d5ed8542","HasChildren":true,"FolderItemType":0,"SystemFolderTypeName":"sample string 6"},{"Guid":"ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f","Name":"sample string 2","IsSystem":true,"SystemLocked":true,"ParentGuid":"841114cc-2eaa-4468-b9a3-9fc8d5ed8542","HasChildren":true,"FolderItemType":0,"SystemFolderTypeName":"sample string 6"}]}

application/xml, text/xml

Sample:

<FolderListViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Interpulse.EventSystem.ViewModels.Services.List">
  <Items>
    <FolderListItemViewModel>
      <FolderItemType>Unassigned</FolderItemType>
      <Guid>ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f</Guid>
      <HasChildren>true</HasChildren>
      <IsSystem>true</IsSystem>
      <Name>sample string 2</Name>
      <ParentGuid>841114cc-2eaa-4468-b9a3-9fc8d5ed8542</ParentGuid>
      <SystemFolderTypeName>sample string 6</SystemFolderTypeName>
      <SystemLocked>true</SystemLocked>
    </FolderListItemViewModel>
    <FolderListItemViewModel>
      <FolderItemType>Unassigned</FolderItemType>
      <Guid>ae8a12e8-43bb-4e7a-9a22-226ab9da7b6f</Guid>
      <HasChildren>true</HasChildren>
      <IsSystem>true</IsSystem>
      <Name>sample string 2</Name>
      <ParentGuid>841114cc-2eaa-4468-b9a3-9fc8d5ed8542</ParentGuid>
      <SystemFolderTypeName>sample string 6</SystemFolderTypeName>
      <SystemLocked>true</SystemLocked>
    </FolderListItemViewModel>
  </Items>
</FolderListViewModel>