DigiOffice Gateway Web Services

GetDocuments

The following routes are available for this service:
GET POST	/api/documents

**GetDocuments** Parameters:
Name	Parameter	Data Type	Required
ViewID	body	Guid?	No
PageSize	body	int	No
PageNumber	body	int	No
SearchCriteria	body	string	No
ExplorerID	body	Guid?	No
Path	body	string	No
ExternalNumber	body	string	No
ModifiedSince	body	DateTime?	No
AllVersions	body	bool	No
OrderBy	body	string	No
Archived	body	bool?	No
FilterName	body	string	No
ProgCode	body	string	No
RegistrationProfileFieldID	body	Guid	No
DependableFields	body	List<RegistrationProfileFieldValue>	No

**RegistrationProfileFieldValue** Parameters:
Name	Parameter	Data Type	Required
DocumentFieldID	form	Guid	No
Value	form	string	No
ShadowValue	form	string	No
IsModifiedByUser	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AllVersions>false</AllVersions>
  <Archived>false</Archived>
  <DependableFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </DependableFields>
  <ExplorerID>00000000-0000-0000-0000-000000000000</ExplorerID>
  <ExternalNumber>String</ExternalNumber>
  <FilterName>String</FilterName>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <OrderBy>String</OrderBy>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <Path>String</Path>
  <ProgCode>String</ProgCode>
  <RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
  <SearchCriteria>String</SearchCriteria>
  <ViewID>00000000-0000-0000-0000-000000000000</ViewID>
</GetDocuments>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Document>
    <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions>
    <CommentsCount>0</CommentsCount>
    <Date>0001-01-01T00:00:00</Date>
    <DirectUrl>String</DirectUrl>
    <DocumentcategoryText>String</DocumentcategoryText>
    <Extension>String</Extension>
    <ExternalNumber>String</ExternalNumber>
    <ExternalVersion>String</ExternalVersion>
    <ExtraField>String</ExtraField>
    <FileDate>0001-01-01T00:00:00</FileDate>
    <FileSize>0</FileSize>
    <FileUrl>String</FileUrl>
    <FullTitle>String</FullTitle>
    <HasPreview>false</HasPreview>
    <Hash>String</Hash>
    <HashType>String</HashType>
    <ID>00000000-0000-0000-0000-000000000000</ID>
    <InternalCompanyID>0</InternalCompanyID>
    <InternalInvoiceNumber>String</InternalInvoiceNumber>
    <InternalNumber>String</InternalNumber>
    <IsCorporateIdentity>false</IsCorporateIdentity>
    <IsFavorite>false</IsFavorite>
    <IsFrozen>false</IsFrozen>
    <IsPrimaryVersion>false</IsPrimaryVersion>
    <Number>String</Number>
    <PersonID>0</PersonID>
    <ProjectID>0</ProjectID>
    <ProjectTitle>String</ProjectTitle>
    <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
    <RelationID>0</RelationID>
    <RelationTitle>String</RelationTitle>
    <RootDocumentID>00000000-0000-0000-0000-000000000000</RootDocumentID>
    <StandardDocumentUrl>String</StandardDocumentUrl>
    <Title>String</Title>
    <UserTitle>String</UserTitle>
    <Version>String</Version>
  </Document>
</ArrayOfDocument>