POST api/Document/AddFolder

Request Information

URI Parameters

None.

Body Parameters

Folder
NameDescriptionTypeAdditional information
apiClientID

string

None.

FolderID

string

None.

FolderType

string

None.

FolderCode

string

None.

FolderName

string

None.

Public

boolean

None.

AdministratorID

string

None.

FolderDueDate

date

None.

Entity

FolderEntity

None.

Classification

FolderClassification

None.

FolderExpirationDate

date

None.

Description

string

None.

Request Formats

application/xml, text/xml

Sample:
<Folder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <apiClientID>sample string 1</apiClientID>
  <FolderID>sample string 2</FolderID>
  <FolderType>sample string 3</FolderType>
  <FolderCode>sample string 4</FolderCode>
  <FolderName>sample string 5</FolderName>
  <Public>true</Public>
  <AdministratorID>sample string 7</AdministratorID>
  <FolderDueDate>2024-11-23T04:03:59.9465415+01:00</FolderDueDate>
  <Entity>
    <FolderEntityType>sample string 1</FolderEntityType>
    <FolderEntityCode>sample string 2</FolderEntityCode>
  </Entity>
  <Classification>
    <ClassificationTypeCode>sample string 1</ClassificationTypeCode>
    <ClassificationCode>sample string 2</ClassificationCode>
  </Classification>
  <FolderExpirationDate>2024-11-23T04:03:59.9465415+01:00</FolderExpirationDate>
  <Description>sample string 8</Description>
</Folder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateResult
NameDescriptionTypeAdditional information
Keys

Collection of EntityKeyField

None.

ResultCode

ExternalResultCode

None.

Errors

Collection of Error

None.

Response Formats

application/xml, text/xml

Sample:
<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Keys>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
    <Key>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </Key>
  </Keys>
  <ResultCode>None</ResultCode>
  <Errors>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
    <Error>
      <Level>Warning</Level>
      <Message>sample string 1</Message>
    </Error>
  </Errors>
</CreateResult>