1. v3
  2. Media
  3. GET - 3/media/folders

Definition

GET - 3/media/folders

Retrieve the complete tree of media folders.

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of MediaFolder
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-21T16:58:17.7339287Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "$id": "1",
      "MediaFolderId": 1,
      "ParentMediaFolderId": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "FolderCount": 5,
      "ItemCount": 6,
      "Children": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    {
      "$ref": "1"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <MediaFolder z:Id="i2">
      <Children>
        <MediaFolder z:Ref="i2" />
        <MediaFolder z:Ref="i2" />
      </Children>
      <Description>sample string 4</Description>
      <FolderCount>5</FolderCount>
      <ItemCount>6</ItemCount>
      <MediaFolderId>1</MediaFolderId>
      <Name>sample string 3</Name>
      <ParentMediaFolderId>2</ParentMediaFolderId>
    </MediaFolder>
    <MediaFolder z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-21T16:58:17.7339287+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>