DigiOffice Gateway Web Services

GetFavoriteDocuments

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

**GetFavoriteDocuments** Parameters:
Name	Parameter	Data Type	Required
PageNumber	query	int	No
PageSize	query	int	No
FileExtensions	query	List<string>	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.

GET /api/me/documents/favorites HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml

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

<ArrayOfFavoriteDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <FavoriteDocument>
    <Date>0001-01-01T00:00:00</Date>
    <Document>
      <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions>
      <CommentsCount>0</CommentsCount>
      <CustomProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </CustomProperties>
      <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>
      <FileExtension>String</FileExtension>
      <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>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  </FavoriteDocument>
</ArrayOfFavoriteDocument>