| GET POST | /api/documents/{DocumentID} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | path | Guid | No | |
| IncludeCustomProperties | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | Guid | No | |
| RootDocumentID | form | Guid | No | |
| RegistrationprofileID | form | Guid | No | |
| Title | form | string | No | |
| FullTitle | form | string | No | |
| Number | form | string | No | |
| Version | form | string | No | |
| ExternalNumber | form | string | No | |
| ExternalVersion | form | string | No | |
| InternalNumber | form | string | No | |
| InternalInvoiceNumber | form | string | No | |
| PersonID | form | int | No | |
| RelationID | form | int | No | |
| RelationTitle | form | string | No | |
| ProjectID | form | int | No | |
| ProjectTitle | form | string | No | |
| Extension | form | string | No | |
| Date | form | DateTime? | No | |
| CommentsCount | form | int | No | |
| HasComments | form | bool | No | |
| HasPreview | form | bool | No | |
| ExtraField | form | string | No | |
| IsFavorite | form | bool | No | |
| DocumentcategoryText | form | string | No | |
| FileSize | form | long? | No | |
| FileDate | form | DateTime? | No | |
| Hash | form | string | No | |
| HashType | form | string | No | |
| FileUrl | form | string | No | |
| StandardDocumentUrl | form | string | No | |
| IsCorporateIdentity | form | bool | No | |
| UserTitle | form | string | No | |
| IsFrozen | form | bool | No | |
| InternalCompanyID | form | int | No | |
| DirectUrl | form | string | No | |
| AllowDigitalSigningOnlyOnPrimaryVersions | form | bool | No | |
| IsPrimaryVersion | form | bool | No | |
| FileExtension | form | string | No | |
| CustomProperties | form | Dictionary<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
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":{}}}