DigiOffice Gateway Web Services

<back to all web services

GetDocumentDetails

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/{DocumentID}
GetDocumentDetails Parameters:
NameParameterData TypeRequiredDescription
DocumentIDpathGuidNo
IncludeCustomPropertiesbodyboolNo
Document Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
RootDocumentIDformGuidNo
RegistrationprofileIDformGuidNo
TitleformstringNo
FullTitleformstringNo
NumberformstringNo
VersionformstringNo
ExternalNumberformstringNo
ExternalVersionformstringNo
InternalNumberformstringNo
InternalInvoiceNumberformstringNo
PersonIDformintNo
RelationIDformintNo
RelationTitleformstringNo
ProjectIDformintNo
ProjectTitleformstringNo
ExtensionformstringNo
DateformDateTime?No
CommentsCountformintNo
HasCommentsformboolNo
HasPreviewformboolNo
ExtraFieldformstringNo
IsFavoriteformboolNo
DocumentcategoryTextformstringNo
FileSizeformlong?No
FileDateformDateTime?No
HashformstringNo
HashTypeformstringNo
FileUrlformstringNo
StandardDocumentUrlformstringNo
IsCorporateIdentityformboolNo
UserTitleformstringNo
IsFrozenformboolNo
InternalCompanyIDformintNo
DirectUrlformstringNo
AllowDigitalSigningOnlyOnPrimaryVersionsformboolNo
IsPrimaryVersionformboolNo
FileExtensionformstringNo
CustomPropertiesformDictionary<string, Object>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/documents/{DocumentID} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","IncludeCustomProperties":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","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-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","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":{}}}