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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Document: 
		{
			Title: String,
			FullTitle: String,
			Number: String,
			Version: String,
			ExternalNumber: String,
			ExternalVersion: String,
			InternalNumber: String,
			InternalInvoiceNumber: String,
			PersonID: 0,
			RelationID: 0,
			RelationTitle: String,
			ProjectID: 0,
			ProjectTitle: String,
			Extension: String,
			Date: 0001-01-01,
			CommentsCount: 0,
			HasComments: False,
			HasPreview: False,
			ExtraField: String,
			IsFavorite: False,
			DocumentcategoryText: String,
			FileSize: 0,
			FileDate: 0001-01-01,
			Hash: String,
			HashType: String,
			FileUrl: String,
			StandardDocumentUrl: String,
			IsCorporateIdentity: False,
			UserTitle: String,
			IsFrozen: False,
			InternalCompanyID: 0,
			DirectUrl: String,
			AllowDigitalSigningOnlyOnPrimaryVersions: False,
			IsPrimaryVersion: False,
			FileExtension: String,
			CustomProperties: 
			{
				String: {}
			}
		},
		Date: 0001-01-01,
		ModifiedDate: 0001-01-01
	}
]