POST api/Document/ListDocuments

Request Information

URI Parameters

None.

Body Parameters

DocumentDetailSearchQuery
NameDescriptionTypeAdditional information
Page

integer

None.

PageSize

integer

None.

apiClientID

string

None.

FilterParameters

FilterParameters

None.

OrderParameters

OrderParameters

None.

Request Formats

application/xml, text/xml

Sample:
<DocumentDetailSearchQuery 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>
  <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>
</DocumentDetailSearchQuery>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DocumentDetail
NameDescriptionTypeAdditional information
IDDocument

string

None.

EntityType

string

None.

DocumentTypeCode

string

None.

DocumentTypeName

string

None.

EntityCodeListNumber

string

None.

OrganisationID

string

None.

EntityCode

string

None.

DocumentName

string

None.

DocumentDescription

string

None.

Subject

string

None.

Author

string

None.

Leader

string

None.

Company

string

None.

Type

string

None.

KeyWords

string

None.

DocumentCreationDate

string

None.

Aplication

string

None.

Comment

string

None.

User

string

None.

PosterID

string

None.

DocumentAddTime

string

None.

ChangerID

string

None.

DocumentChangeTime

string

None.

Version

string

None.

DocumentStatus

string

None.

DocumentStatusDescription

string

None.

ComputerName

string

None.

Size

string

None.

zlib

string

None.

Envelope

string

None.

NumberOfSignatures

string

None.

ExpirationDate

string

None.

Signature

string

None.

SignatureReason

string

None.

ArchiveCode

string

None.

ArchiveName

string

None.

ArchiveStatus

string

None.

Permission

string

None.

EntityName

string

None.

ArchivationTime

date

None.

NumberOfAttachments

integer

None.

Coded

boolean

None.

BusinessYear

integer

None.

Response Formats

application/xml, text/xml

Sample:
<ArrayOfDocumentDetail xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocumentDetail>
    <IDDocument>sample string 1</IDDocument>
    <EntityType>sample string 2</EntityType>
    <DocumentTypeCode>sample string 3</DocumentTypeCode>
    <DocumentTypeName>sample string 4</DocumentTypeName>
    <EntityCodeListNumber>sample string 5</EntityCodeListNumber>
    <OrganisationID>sample string 6</OrganisationID>
    <EntityCode>sample string 7</EntityCode>
    <DocumentName>sample string 8</DocumentName>
    <DocumentDescription>sample string 9</DocumentDescription>
    <Subject>sample string 10</Subject>
    <Author>sample string 11</Author>
    <Leader>sample string 12</Leader>
    <Company>sample string 13</Company>
    <Type>sample string 14</Type>
    <KeyWords>sample string 15</KeyWords>
    <DocumentCreationDate>sample string 16</DocumentCreationDate>
    <Aplication>sample string 17</Aplication>
    <Comment>sample string 18</Comment>
    <User>sample string 19</User>
    <PosterID>sample string 20</PosterID>
    <DocumentAddTime>sample string 21</DocumentAddTime>
    <ChangerID>sample string 22</ChangerID>
    <DocumentChangeTime>sample string 23</DocumentChangeTime>
    <Version>sample string 24</Version>
    <DocumentStatus>sample string 25</DocumentStatus>
    <DocumentStatusDescription>sample string 26</DocumentStatusDescription>
    <ComputerName>sample string 27</ComputerName>
    <Size>sample string 28</Size>
    <zlib>sample string 29</zlib>
    <Envelope>sample string 30</Envelope>
    <NumberOfSignatures>sample string 31</NumberOfSignatures>
    <ExpirationDate>sample string 32</ExpirationDate>
    <Signature>sample string 33</Signature>
    <SignatureReason>sample string 34</SignatureReason>
    <ArchiveCode>sample string 35</ArchiveCode>
    <ArchiveName>sample string 36</ArchiveName>
    <ArchiveStatus>sample string 37</ArchiveStatus>
    <Permission>sample string 38</Permission>
    <EntityName>sample string 39</EntityName>
    <ArchivationTime>2024-03-28T08:50:57.5272725+01:00</ArchivationTime>
    <NumberOfAttachments>40</NumberOfAttachments>
    <Coded>true</Coded>
    <BusinessYear>42</BusinessYear>
  </DocumentDetail>
  <DocumentDetail>
    <IDDocument>sample string 1</IDDocument>
    <EntityType>sample string 2</EntityType>
    <DocumentTypeCode>sample string 3</DocumentTypeCode>
    <DocumentTypeName>sample string 4</DocumentTypeName>
    <EntityCodeListNumber>sample string 5</EntityCodeListNumber>
    <OrganisationID>sample string 6</OrganisationID>
    <EntityCode>sample string 7</EntityCode>
    <DocumentName>sample string 8</DocumentName>
    <DocumentDescription>sample string 9</DocumentDescription>
    <Subject>sample string 10</Subject>
    <Author>sample string 11</Author>
    <Leader>sample string 12</Leader>
    <Company>sample string 13</Company>
    <Type>sample string 14</Type>
    <KeyWords>sample string 15</KeyWords>
    <DocumentCreationDate>sample string 16</DocumentCreationDate>
    <Aplication>sample string 17</Aplication>
    <Comment>sample string 18</Comment>
    <User>sample string 19</User>
    <PosterID>sample string 20</PosterID>
    <DocumentAddTime>sample string 21</DocumentAddTime>
    <ChangerID>sample string 22</ChangerID>
    <DocumentChangeTime>sample string 23</DocumentChangeTime>
    <Version>sample string 24</Version>
    <DocumentStatus>sample string 25</DocumentStatus>
    <DocumentStatusDescription>sample string 26</DocumentStatusDescription>
    <ComputerName>sample string 27</ComputerName>
    <Size>sample string 28</Size>
    <zlib>sample string 29</zlib>
    <Envelope>sample string 30</Envelope>
    <NumberOfSignatures>sample string 31</NumberOfSignatures>
    <ExpirationDate>sample string 32</ExpirationDate>
    <Signature>sample string 33</Signature>
    <SignatureReason>sample string 34</SignatureReason>
    <ArchiveCode>sample string 35</ArchiveCode>
    <ArchiveName>sample string 36</ArchiveName>
    <ArchiveStatus>sample string 37</ArchiveStatus>
    <Permission>sample string 38</Permission>
    <EntityName>sample string 39</EntityName>
    <ArchivationTime>2024-03-28T08:50:57.5272725+01:00</ArchivationTime>
    <NumberOfAttachments>40</NumberOfAttachments>
    <Coded>true</Coded>
    <BusinessYear>42</BusinessYear>
  </DocumentDetail>
</ArrayOfDocumentDetail>