POST api/Document/ListFolders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Page	integer	None.
PageSize	integer	None.
apiClientID	string	None.
FolderStatus	string	None.
FolderType	string	None.
FilterParameters	FilterParameters	None.
OrderParameters	OrderParameters	None.

Request Formats

application/xml, text/xml

Sample:

<FolderSearchQuery xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Page>1</Page>
  <PageSize>2</PageSize>
  <apiClientID>sample string 3</apiClientID>
  <FolderStatus>sample string 4</FolderStatus>
  <FolderType>sample string 5</FolderType>
  <FilterParameters>
    <FilterParameter>
      <ColumnName>sample string 1</ColumnName>
      <Operand>sample string 2</Operand>
      <Value>sample string 3</Value>
    </FilterParameter>
    <FilterParameter>
      <ColumnName>sample string 1</ColumnName>
      <Operand>sample string 2</Operand>
      <Value>sample string 3</Value>
    </FilterParameter>
  </FilterParameters>
  <OrderParameters>
    <OrderParameter>
      <ColumnName>sample string 1</ColumnName>
      <Operand>sample string 2</Operand>
    </OrderParameter>
    <OrderParameter>
      <ColumnName>sample string 1</ColumnName>
      <Operand>sample string 2</Operand>
    </OrderParameter>
  </OrderParameters>
</FolderSearchQuery>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of FolderDetail

Name	Type	Additional information
FolderID	string	None.
FolderType	string	None.
FolderTypeName	string	None.
FolderCode	string	None.
FolderName	string	None.
OrganisationID	integer	None.
Public	boolean	None.
AdministratorID	string	None.
FolderStatus	string	None.
FolderDueDate	date	None.
FolderEntityType	string	None.
FolderEntityCode	string	None.
FolderEntityName	string	None.
ClassificationTypeCode	string	None.
ClassificationCode	string	None.
ClassificationName	string	None.
FolderExpirationDate	date	None.

Response Formats

application/xml, text/xml

Sample:

<ArrayOfFolderDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FolderDetail>
    <FolderID>sample string 1</FolderID>
    <FolderType>sample string 2</FolderType>
    <FolderTypeName>sample string 3</FolderTypeName>
    <FolderCode>sample string 4</FolderCode>
    <FolderName>sample string 5</FolderName>
    <OrganisationID>6</OrganisationID>
    <Public>true</Public>
    <AdministratorID>sample string 8</AdministratorID>
    <FolderStatus>sample string 9</FolderStatus>
    <FolderDueDate>2024-11-23T04:04:11.3041108+01:00</FolderDueDate>
    <FolderEntityType>sample string 10</FolderEntityType>
    <FolderEntityCode>sample string 11</FolderEntityCode>
    <FolderEntityName>sample string 12</FolderEntityName>
    <ClassificationTypeCode>sample string 13</ClassificationTypeCode>
    <ClassificationCode>sample string 14</ClassificationCode>
    <ClassificationName>sample string 15</ClassificationName>
    <FolderExpirationDate>2024-11-23T04:04:11.3041108+01:00</FolderExpirationDate>
  </FolderDetail>
  <FolderDetail>
    <FolderID>sample string 1</FolderID>
    <FolderType>sample string 2</FolderType>
    <FolderTypeName>sample string 3</FolderTypeName>
    <FolderCode>sample string 4</FolderCode>
    <FolderName>sample string 5</FolderName>
    <OrganisationID>6</OrganisationID>
    <Public>true</Public>
    <AdministratorID>sample string 8</AdministratorID>
    <FolderStatus>sample string 9</FolderStatus>
    <FolderDueDate>2024-11-23T04:04:11.3041108+01:00</FolderDueDate>
    <FolderEntityType>sample string 10</FolderEntityType>
    <FolderEntityCode>sample string 11</FolderEntityCode>
    <FolderEntityName>sample string 12</FolderEntityName>
    <ClassificationTypeCode>sample string 13</ClassificationTypeCode>
    <ClassificationCode>sample string 14</ClassificationCode>
    <ClassificationName>sample string 15</ClassificationName>
    <FolderExpirationDate>2024-11-23T04:04:11.3041108+01:00</FolderExpirationDate>
  </FolderDetail>
</ArrayOfFolderDetail>