GET {clientId}/DataExport/Folders/{folderName}

Retrieve segmentGroupFolders for a segmentGroup ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

string

Required

folderName

Retrieve folder for specific segmentGroup ID. A 400 is returned if this value is empty.

string

Required

Body Parameters

None.

Response Information

Response Codes

  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)

Resource Description

SegmentGroupFolderResult
NameDescriptionTypeAdditional information
SegmentGroupFolders

Collection of SegmentGroupFolder

None.

Response Formats

application/json, text/json

Sample:
{
  "SegmentGroupFolders": [
    {
      "FolderLink": 1,
      "ClientLink": 2,
      "FolderName": "sample string 3",
      "Description": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<SegmentGroupFolderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <SegmentGroupFolders xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:SegmentGroupFolder>
      <d2p1:ClientLink>2</d2p1:ClientLink>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Folder>1</d2p1:Folder>
      <d2p1:FolderName>sample string 3</d2p1:FolderName>
    </d2p1:SegmentGroupFolder>
  </SegmentGroupFolders>
</SegmentGroupFolderResult>