GET PlanCare2Api/RootData/Document/FileLists

Returns a list of known file lists.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of known file lists.

Collection of FileList
Name Description Type Additional information
Guid

Identifier for the file list.

globally unique identifier

-

Name

Name of the file list.

string

-

Description

Description of the file list.

string

-

IsWhitelistOnly

Only extensions on this list are allowed, other unregistered extensions are blocked.

boolean

-

FileExtensions

File extensions registered to this file list.

Collection of FileListFileExtension

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Guid": "e59276c0-5bb6-4767-969f-a831063bda82",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsWhitelistOnly": true,
    "FileExtensions": [
      {
        "$id": "2",
        "FileExtension": {
          "$id": "3",
          "Guid": "95190be4-eecf-4f3a-a45e-5ea6831080e1",
          "Extension": "sample string 2",
          "MaximumSize": 1
        },
        "MaximumSize": 1
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfFileList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
  <FileList>
    <Description>sample string 3</Description>
    <FileExtensions>
      <FileListFileExtension>
        <FileExtension>
          <Extension>sample string 2</Extension>
          <Guid>95190be4-eecf-4f3a-a45e-5ea6831080e1</Guid>
          <MaximumSize>1</MaximumSize>
        </FileExtension>
        <MaximumSize>1</MaximumSize>
      </FileListFileExtension>
      <FileListFileExtension>
        <FileExtension>
          <Extension>sample string 2</Extension>
          <Guid>95190be4-eecf-4f3a-a45e-5ea6831080e1</Guid>
          <MaximumSize>1</MaximumSize>
        </FileExtension>
        <MaximumSize>1</MaximumSize>
      </FileListFileExtension>
    </FileExtensions>
    <Guid>e59276c0-5bb6-4767-969f-a831063bda82</Guid>
    <IsWhitelistOnly>true</IsWhitelistOnly>
    <Name>sample string 2</Name>
  </FileList>
  <FileList>
    <Description>sample string 3</Description>
    <FileExtensions>
      <FileListFileExtension>
        <FileExtension>
          <Extension>sample string 2</Extension>
          <Guid>95190be4-eecf-4f3a-a45e-5ea6831080e1</Guid>
          <MaximumSize>1</MaximumSize>
        </FileExtension>
        <MaximumSize>1</MaximumSize>
      </FileListFileExtension>
      <FileListFileExtension>
        <FileExtension>
          <Extension>sample string 2</Extension>
          <Guid>95190be4-eecf-4f3a-a45e-5ea6831080e1</Guid>
          <MaximumSize>1</MaximumSize>
        </FileExtension>
        <MaximumSize>1</MaximumSize>
      </FileListFileExtension>
    </FileExtensions>
    <Guid>e59276c0-5bb6-4767-969f-a831063bda82</Guid>
    <IsWhitelistOnly>true</IsWhitelistOnly>
    <Name>sample string 2</Name>
  </FileList>
</ArrayOfFileList>